Skip to main content
GET
/
v1
/
matching
/
runs
/
{runId}
Get match run
curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/matching/runs/{runId} \
  --header 'Authorization: Bearer <token>'
{
  "completedAt": "<string>",
  "contextId": "<string>",
  "createdAt": "<string>",
  "failureReason": "<string>",
  "id": "<string>",
  "mode": "DRY_RUN",
  "startedAt": "<string>",
  "stats": {},
  "status": "PROCESSING",
  "updatedAt": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication (format: "Bearer {token}")

Headers

​
X-Request-Id
string

A unique identifier for tracing the request across services.

Path Parameters

​
runId
string
required

Run ID

Query Parameters

​
contextId
string
required

Context ID

Response

Indicates that the request was successful and the response contains the expected data.

​
completedAt
string
​
contextId
string
​
createdAt
string
​
failureReason
string
​
id
string
​
mode
enum<string>

Execution mode for a matching run

Available options:
DRY_RUN,
COMMIT
​
startedAt
string
​
stats
object
​
status
enum<string>

Lifecycle status of a matching run

Available options:
PROCESSING,
COMPLETED,
FAILED
​
updatedAt
string