Get all workflows

GET /api/v1/workflow

Query parameters

  • include string

    Comma separated list of relationships to include in the response. Valid relationships are [author, tasks_count].

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at, name]. Negative sign to denote DESC. Defaults to 'name'.

  • per_page integer

    Number of results to return with pagination (Default 15. Max 500).

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      UUID of the account

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • name string

      Name of the workflow

    • type string

      The type of workflow.

    • tasks_count integer

      The number of tasks on the workflow.
GET /api/v1/workflow 
curl \
 -X GET https://api.plannrcrm.com/api/v1/workflow \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json"
Response examples (200) 
{
  "name": "Pension Transfer",
  "type": "simple",
  "uuid": "917d2db3-4116-4df6-9a4c-2c934f0ff3c2",
  "created_at": "2024-11-20T13:24:01+00:00",
  "updated_at": "2024-11-20T13:24:01+00:00",
  "tasks_count": 5
}