v3

latestSwagger 2.02026-08-067506752.0 MB

process

Retrieve a number of previously run processes

get/v1/org/{orgId}/process

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

isAppProcessboolean

Boolean if an app process

appIdstring

App ID to filter by

parentProcessIdstring

Parent process ID to search for children

typestring

Type to filter by. Accepted values: ['auto', 'manual']

createAtFromstring

Create at instant from, inclusive

createAtUntilstring

Create at instant until, exclusive

statusesstring

Statuses to filter by, comma-separated. Accepted values: ['DONE', 'ERROR', 'PENDING', 'RUNNING', 'DONE_WITH_ERRORS']

isParentProcessboolean

Boolean if a parent process

processTypesstring

Process types to filter by, comma-separated.

searchValuestring

Search term for general filtering

fromstring

from id

limitinteger

limit

syncDirectionsstring

direction

syncCausesstring

V2 Causes to filter by, comma-separated. Accepted values: ['MANUAL', 'AUTO', 'EVENT_BASED]

runUserIdstring

The user id under which the process is run

Response

successful operation

nextstring

Example response

{
  "data": [
    {
      "id": "588f7ee98f138b19220041a7",
      "orgId": "588f7ee98f138b19220041a7",
      "runUserId": "588f7ee98f138b19220041a7",
      "parentProcessId": "588f7ee98f138b19220041a7",
      "createId": "588f7ee98f138b19220041a7",
      "createBehalfId": "588f7ee98f138b19220041a7",
      "createAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "createAt": "2017-01-24T13:57:52Z",
      "updateId": "588f7ee98f138b19220041a7",
      "updateBehalfId": "588f7ee98f138b19220041a7",
      "updateAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "updateAt": "2017-01-24T13:57:52Z",
      "startAt": "2017-01-24T13:57:52Z",
      "endAt": "2017-01-24T13:57:52Z",
      "logDataList": [
        {
          "at": "2017-01-24T13:57:52Z"
        }
      ],
      "appId": "588f7ee98f138b19220041a7",
      "uuid": "84db3c6e-0877-4436-8af1-768c06b29586"
    }
  ],
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}