Sign in

v1

latestOpenAPI 3.0.02026-07-2480355389.7 KB
Workflows

Get workflow

Returns workflow by specified ID.

get/api/v2/teams/{team_slug}/workflows/{id}

Path parameters

team_slugstring required

Team's sluggified name

idstring uuid required
Example:e23ff3f3-8f77-4e78-9e81-fdb25abfb781

Query parameters

include_thumbnailsboolean

Set to 'false' if you need the response to exclude thumbnail URLs for faster response times.

Set to 'false' if you need the response to exclude thumbnail URLs for faster response times.

Response

WorkflowsV2.Workflow.Workflow

idstring uuid nullable required

A unique identifier for a workflow

inserted_atstring required
namestring required
team_idinteger required
thumbnailsstring[] required

List of thumbnails urls

updated_atstring required
work_batch_requestedboolean nullable

Whether there is a pending request for more work for the current user and this workflow. This field is experimental and may be removed without notice.

Example response

{
  "dataset": {
    "id": 123
  },
  "id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
  "stages": [
    {
      "assignable_users": [
        {
          "stage_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
        }
      ],
      "config": {
        "allowed_property_ids": [
          "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
        ],
        "annotation_group_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
      },
      "edges": [
        {
          "id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
          "source_stage_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
          "target_stage_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
        }
      ],
      "id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
    }
  ]
}