Get all tasks on a firm.

GET /api/v1/task

Constrained by the user role. For example, owners and admins can see all tasks. Members can only see tasks within groups they can access and clients can only see tasks they have access to.

Headers

Query parameters

include string

Comma separated list of relationships to include in the response. Valid relationships are [author, completed_by, parent_task, related_tasks, custom_fields].
per_page integer

Number of results to return with pagination (Default 15. Max 500).
filter[name] string

Filter Task name.
filter[taskable_type] string

Taskable type. Can be 'plan' or 'case'.
filter[taskable_uuid] string

Taskable uuid.
filter[priority] string

Priority. Available options are highest, high, medium, and low.
filter[assigned_to_uuids] string

Filter tasks that have been assigned to the account UUIDs.
filter[status_uuid] string

Status uuid. The task's status uuid.
filter[due_before] string

date Filter tasks that have a due at date before.
filter[due_after] string

date Filter tasks that have a due at date after.
filter[has_due_date] boolean

Filter tasks that have a due at date or not.
filter[open_tasks] boolean

Only show open tasks. When true, this will filter tasks in the "Completed" or "Archived" columns.
filter[show_child_tasks] boolean

Show child tasks in the top-level list. Defaults to false.
filter[completed_status] boolean

Filter tasks which have a system status of type completed.
filter[archived_status] boolean

Filter tasks which have a system status of type archived.
filter[not_started_status] boolean

Filter tasks which have a system status of type not started.
sort string

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

Responses

200 application/json
Hide response attribute Show response attribute object
- data array[object]

GET /api/v1/task

curl \
 -X GET https://api.plannrcrm.com/api/v1/task \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "data": [
    {
      "name": "Document the transaction",
      "uuid": "fbd81bd9-2b71-4330-953d-b1cd4651198a",
      "author": {
        "name": {
          "example": "Gareth Thompson",
          "collection": false,
          "description": "Name"
        },
        "role": {
          "example": "client",
          "collection": false,
          "description": "Account role"
        },
        "type": {
          "example": "client",
          "collection": false,
          "description": "Account type"
        },
        "uuid": {
          "example": "6a5dc161-c214-479a-864c-39291d70b25c",
          "collection": false,
          "description": "The UUID of the resource."
        },
        "email": {
          "example": "gareth@codepotato.co.uk",
          "collection": false,
          "description": "Email"
        },
        "last_name": {
          "example": "Thompson",
          "collection": false,
          "description": "Last name"
        },
        "photo_url": {
          "example": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
          "collection": false,
          "description": "The photo URL of the client"
        },
        "created_at": {
          "example": "2024-10-16T11:10:15+01:00",
          "collection": false,
          "description": "The timestamp of when the resource was created."
        },
        "first_name": {
          "example": "Gareth",
          "collection": false,
          "description": "First name"
        },
        "updated_at": {
          "example": "2024-10-16T11:10:15+01:00",
          "collection": false,
          "description": "The timestamp of when the resource was updated."
        },
        "external_references": {
          "example": "App\\Http\\Resources\\ExternalReferenceResource",
          "collection": true,
          "description": "The external references that have been added to the client."
        }
      },
      "due_at": "2021-01-01 00:00:00",
      "status": {
        "name": "Incomplete",
        "uuid": "544a3b03-1ffe-4e00-b45d-996c393f3466",
        "colour": "#398898",
        "position": 1,
        "created_at": "2024-10-16T11:10:15+01:00",
        "updated_at": "2024-10-16T11:10:15+01:00",
        "is_archived": false,
        "is_not_started": false,
        "is_type_completed": false
      },
      "position": 1,
      "priority": "high",
      "taskable": {
        "name": "finance",
        "slug": "finance",
        "type": "App\\Http\\Resources\\CasesTypeResource",
        "uuid": "1180070e-6645-436d-b336-fdcd1f5e5087",
        "plans": "App\\Http\\Resources\\Plans\\PlanResource",
        "value": {
          "amount": {
            "example": "4000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          },
          "formatted": {
            "example": "£40.00",
            "description": "Money amount formatted with currency"
          }
        },
        "status": "App\\Http\\Resources\\CasesStatusResource",
        "created_at": "2024-10-16T11:10:15+01:00",
        "updated_at": "2024-10-16T11:10:15+01:00",
        "completed_at": "2024-10-16T11:10:15+01:00",
        "participants": "App\\Http\\Resources\\AccountResource",
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "status_position": 4,
        "task_board_uuid": "21ce0588-6d58-4f53-a7fe-c8542e1aeb10",
        "participants_count": 4
      },
      "created_at": "2024-10-16T11:10:15+01:00",
      "updated_at": "2024-10-16T11:10:15+01:00",
      "assigned_to": {
        "name": {
          "example": "Gareth Thompson",
          "collection": false,
          "description": "Name"
        },
        "role": {
          "example": "client",
          "collection": false,
          "description": "Account role"
        },
        "type": {
          "example": "client",
          "collection": false,
          "description": "Account type"
        },
        "uuid": {
          "example": "30d23b50-4199-4e4e-b863-ee43b667bb1c",
          "collection": false,
          "description": "The UUID of the resource."
        },
        "email": {
          "example": "gareth@codepotato.co.uk",
          "collection": false,
          "description": "Email"
        },
        "last_name": {
          "example": "Thompson",
          "collection": false,
          "description": "Last name"
        },
        "photo_url": {
          "example": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
          "collection": false,
          "description": "The photo URL of the client"
        },
        "created_at": {
          "example": "2024-10-16T11:10:15+01:00",
          "collection": false,
          "description": "The timestamp of when the resource was created."
        },
        "first_name": {
          "example": "Gareth",
          "collection": false,
          "description": "First name"
        },
        "updated_at": {
          "example": "2024-10-16T11:10:15+01:00",
          "collection": false,
          "description": "The timestamp of when the resource was updated."
        },
        "external_references": {
          "example": "App\\Http\\Resources\\ExternalReferenceResource",
          "collection": true,
          "description": "The external references that have been added to the client."
        }
      },
      "completed_at": "2021-01-01 00:00:00",
      "completed_by": {
        "name": {
          "example": "Gareth Thompson",
          "collection": false,
          "description": "Name"
        },
        "role": {
          "example": "client",
          "collection": false,
          "description": "Account role"
        },
        "type": {
          "example": "client",
          "collection": false,
          "description": "Account type"
        },
        "uuid": {
          "example": "8afc4d68-3480-4871-93c8-c3cb5e6bd2e5",
          "collection": false,
          "description": "The UUID of the resource."
        },
        "email": {
          "example": "gareth@codepotato.co.uk",
          "collection": false,
          "description": "Email"
        },
        "last_name": {
          "example": "Thompson",
          "collection": false,
          "description": "Last name"
        },
        "photo_url": {
          "example": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
          "collection": false,
          "description": "The photo URL of the client"
        },
        "created_at": {
          "example": "2024-10-16T11:10:15+01:00",
          "collection": false,
          "description": "The timestamp of when the resource was created."
        },
        "first_name": {
          "example": "Gareth",
          "collection": false,
          "description": "First name"
        },
        "updated_at": {
          "example": "2024-10-16T11:10:15+01:00",
          "collection": false,
          "description": "The timestamp of when the resource was updated."
        },
        "external_references": {
          "example": "App\\Http\\Resources\\ExternalReferenceResource",
          "collection": true,
          "description": "The external references that have been added to the client."
        }
      },
      "custom_fields": [
        {
          "name": "Favourite Drink",
          "type": "string",
          "uuid": "a4579446-0f14-40f4-89f5-a32950c4e28d",
          "value": "Coffee",
          "help_text": "This is the client's favourite drink.",
          "reference": "favourite_drink",
          "created_at": "2024-10-16T11:10:15+01:00",
          "updated_at": "2024-10-16T11:10:15+01:00",
          "is_required": false,
          "selection_options": [
            "Coffee",
            "Tea",
            "Water"
          ]
        }
      ],
      "taskable_type": "case"
    }
  ]
}