Skip to main content
GET
/
runs
/
{run_uid}
Get run by UUID
curl --request GET \
  --url https://api.edges.run/v1/runs/{run_uid} \
  --header 'X-API-Key: <api-key>'
{
  "id": 123,
  "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "action_id": 123,
  "action_name": "<string>",
  "retry_count": 0,
  "user_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "execution_mode": "LIVE",
  "last_error": {
    "label": "<string>",
    "message": "<string>",
    "params": {}
  },
  "parameters": {},
  "callback": {
    "url": "<string>"
  },
  "status": "CREATED",
  "postponed_until": "2023-11-07T05:31:56Z",
  "started_at": "<string>",
  "finished_at": "<string>",
  "synced_at": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}
uid is used for all the endpoints and Run manipulation.The id is an internal identifier returned to smooth and improve speed and accuracy if you have questions about your runs you will want to submit to the team.

Authorizations

X-API-Key
string
header
required

Path Parameters

run_uid
string<uuid>
required

Run UUID

Response

Returns the run

id
integer

Run ID

uid
string<uuid>

Run UUID

action_id
integer

Action ID

action_name
string

Action name

retry_count
integer
default:0

Retry count

user_uid
string<uuid>

Member/User UUID

workspace_uid
string<uuid>

Workspace UUID

execution_mode
enum<string> | null

Execution mode

Available options:
LIVE,
ASYNC
last_error
object | null

Last error message

parameters
object
callback
object | null

Callback (only for async runs)

status
enum<string> | null

Run status

Available options:
CREATED,
INVALID,
QUEUED,
SCHEDULED,
BLOCKED,
STOPPED,
RUNNING,
FAILED,
PARTIAL_SUCCEEDED,
SUCCEEDED
postponed_until
string<date-time> | null

If the run is postponed, this field indicates when it will be retried.

started_at
string | null

Started at

finished_at
string | null

Finished at

synced_at
string | null

Synced at

created_at
string

Created at

updated_at
string | null

Updated at

I