GET/projects/api/v3/workflows.json

Get all workflows.

Query Params

  • Name
    updatedAfter
    Type
    string
    Description

    filter by updated after date

  • Name
    status
    Type
    string
    Description

    filter by workflow status

  • Name
    searchTerm
    Type
    string
    Description

    filter by search term

  • 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
    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 items

    Default
    false
  • Name
    onlyDefaultWorkflow
    Type
    boolean
    Description

    filter by the default workflow

    Default
    false
  • Name
    matchAllStageNames
    Type
    boolean
    Description

    enforce all stage names must be matched

  • Name
    includeTotalCount
    Type
    boolean
    Description

    include installation wide total counts

  • Name
    includeArchived
    Type
    boolean
    Description

    include archived workflows

  • Name
    workflowIds
    Type
    array[integer]
    Description

    filter by workflow ids

    Format
    Comma separated values
  • Name
    stageNames
    Type
    array[string]
    Description

    filter workflows by the extact stage names

    Format
    Comma separated values
  • Name
    projectIds
    Type
    array[integer]
    Description

    filter by project ids

    Format
    Comma separated values
  • Name
    include
    Type
    array[string]
    Description

    include

    Format
    Comma separated values
    Allowed values
    • projects
    • stages
    • users
    • teams
    • companies
  • Name
    fields[workflows]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • statusId
  • Name
    fields[users]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • firstName
    • lastName
    • title
    • email
    • companyId
    • company
    • isAdmin
    • isClientUser
    • isServiceAccount
    • type
    • deleted
    • avatarUrl
    • lengthOfDay
    • workingHoursId
    • workingHour
    • userRate
    • userCost
    • canAddProjects
  • Name
    fields[teams]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • teamLogo
    • teamLogoIcon
    • teamLogoColor
  • Name
    fields[stages]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • stage
  • Name
    fields[projects]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
  • Name
    fields[companies]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • logoUploadedToServer
    • logoImage

Responses

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

Examples

200 OK

WorkflowsResponse
{
  "included": {
    "companies": {
      "additionalProp": {
        "accounts": 0,
        "addressOne": "string",
        "addressTwo": "string",
        "budgetDistribution": [
          {
            "companyId": 0,
            "count": 0,
            "from": 0,
            "to": 0
          }
        ],
        "canSeePrivate": true,
        "cid": "string",
        "city": "string",
        "clientManagedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "clients": 0,
        "collaborators": 0,
        "companyNameUrl": "string",
        "companyUpdate": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "contacts": 0,
        "countryCode": "string",
        "createdAt": "string",
        "emailOne": "string",
        "emailThree": "string",
        "emailTwo": "string",
        "fax": "string",
        "id": 0,
        "industry": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "industryId": 0,
        "isOwner": true,
        "logoUrl": "string",
        "name": "string",
        "phone": "string",
        "privateNotes": "string",
        "privateNotesText": "string",
        "profileText": "string",
        "profitability": {
          "billable": 0,
          "billableTime": 0,
          "cost": 0,
          "expenses": 0,
          "loggedTime": 0,
          "nonBillableTime": 0,
          "profit": 0
        },
        "state": "string",
        "stats": {
          "projectCount": 0,
          "taskCompleteCount": 0,
          "taskCount": 0,
          "unreadEmailCount": 0
        },
        "status": "string",
        "tags": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "updatedAt": "string",
        "website": "string",
        "zip": "string"
      }
    },
    "projects": {
      "additionalProp": {}
    },
    "stages": {
      "additionalProp": {
        "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"
        }
      }
    },
    "teams": {
      "additionalProp": {
        "id": 0,
        "name": "string",
        "teamLogo": "string",
        "teamLogoColor": "string",
        "teamLogoIcon": "string"
      }
    },
    "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
      }
    }
  },
  "meta": {
    "averageSpend": 0,
    "limit": 0,
    "nextCursor": "string",
    "page": {
      "count": 0,
      "hasMore": true,
      "pageOffset": 0,
      "pageSize": 0
    },
    "prevCursor": "string",
    "totalCapacity": 0
  },
  "workflows": [
    {
      "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
    }
  ]
}
Download Swagger