GET/projects/api/v3/workflows/{workflowId}/stages.json

Get all stages.

Retrieve all stages for a workflow.

Path Params

  • Name
    workflowId
    Type
    integer
    required
    Description

Query Params

  • Name
    updatedAfter
    Type
    string
    Description

    filter by updated after date

  • Name
    orderMode
    Type
    string
    Description

    order mode

    Default
    asc
  • Name
    orderBy
    Type
    string
    Description

    order by

    Default
    id
  • Name
    cursor
    Type
    string
    Description

    cursor used for pagination. When using this pagination mode the page and pageSize will be ignored, using limit to control the number of items. If any other filter is modified during the cursor iteration the response will fallback to the first page.

  • Name
    workflowId
    Type
    integer
    Description

    filter by workflow ids

  • Name
    pageSize
    Type
    integer
    Description

    number of items in a page

    Default
    50
  • Name
    page
    Type
    integer
    Description

    page number

    Default
    1
  • Name
    limit
    Type
    integer
    Description

    number of items to show when providing the cursor.

  • Name
    showDeleted
    Type
    boolean
    Description

    include deleted stages in the result

  • Name
    include
    Type
    array[string]
    Description

    include

    Format
    Comma separated values
    Allowed values
    • workflows
  • Name
    ids
    Type
    array[integer]
    Description

    filter by stage ids

    Format
    Comma separated values
  • Name
    fields[workflows]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • statusId
  • Name
    fields[stages]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • stage

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    StagesResponse contains information about a group of stages.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

StagesResponse
{
  "included": {
    "users": {
      "additionalProp": {
        "avatarUrl": "string",
        "canAddProjects": true,
        "company": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "companyId": 0,
        "companyRoleId": 0,
        "deleted": true,
        "email": "string",
        "firstName": "string",
        "id": 0,
        "isAdmin": true,
        "isClientUser": true,
        "isServiceAccount": true,
        "lastName": "string",
        "lengthOfDay": 0,
        "meta": {},
        "teams": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "timezone": "string",
        "title": "string",
        "type": "string",
        "userCost": 0,
        "userRate": 0,
        "workingHour": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "workingHoursId": 0
      }
    },
    "workflows": {
      "additionalProp": {
        "createdAt": "string",
        "createdBy": 0,
        "defaultWorkflow": true,
        "id": 0,
        "lockdown": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "name": "string",
        "projectIds": [
          0
        ],
        "projectSpecific": true,
        "stages": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "status": "string",
        "updatedAt": "string",
        "updatedBy": 0
      }
    }
  },
  "meta": {
    "averageSpend": 0,
    "limit": 0,
    "nextCursor": "string",
    "page": {
      "count": 0,
      "hasMore": true,
      "pageOffset": 0,
      "pageSize": 0
    },
    "prevCursor": "string",
    "totalCapacity": 0
  },
  "stages": [
    {
      "color": "string",
      "createdAt": "string",
      "createdBy": 0,
      "deletedAt": "string",
      "deletedBy": 0,
      "displayOrder": 0,
      "id": 0,
      "name": "string",
      "showCompletedTasks": true,
      "taskIds": [
        0
      ],
      "updatedAt": "string",
      "updatedBy": 0,
      "workflow": {
        "id": 0,
        "meta": {},
        "type": "string"
      }
    }
  ]
}