Get all tasks on a firm.

GET /api/v1/task
Personal access token & O auth2

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

  • X-PLANNR-ACCOUNT-UUID string

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[client_uuid] string

    Client 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[circle_uuids] string

    Filter tasks that have been assigned to the account UUIDs within the specified circles.

  • 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[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.

  • filter[show_child_tasks] boolean

    (deprecated, use subtask_visibility instead) Show child tasks in the top-level list. Defaults to false.

  • filter[subtask_visibility] string

    Filter subtasks in the top-level list. options are: include, exclude or only.

  • filter[unassigned_task_visibility] string

    Filter unassigned subtasks in the top-level list. options are: include, exclude or only.

  • 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]
      Hide data attributes Show data attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • priority string
      • position integer
      • due_at string
      • status object
        Hide status attributes Show status attributes object
        • uuid string
        • created_at string
        • updated_at string
        • name string
        • colour string
        • position integer
        • is_type_completed boolean
        • is_archived boolean
        • is_not_started boolean
      • taskable_type string
      • taskable object
        Hide taskable attributes Show taskable attributes object
        • uuid string
        • created_at string
        • updated_at string
        • name string
        • slug string
        • status string
        • type string
        • review_at string
        • assigned_to_uuids array[string]
        • group_uuids array[string]
        • completed_at string
        • value object
          Hide value attributes Show value attributes object
          • amount object
            Hide amount attributes Show amount attributes object
            • example string
            • description string
          • formatted object
            Hide formatted attributes Show formatted attributes object
            • example string
            • description string
          • currency object
            Hide currency attributes Show currency attributes object
            • example string
            • description string
        • status_position integer
        • participants_count integer
        • participants string
        • task_board_uuid string
        • plans string
        • custom_fields string
      • author object
        Hide author attributes Show author attributes object
        • uuid object
          Hide uuid attributes Show uuid attributes object
          • example string
          • description string
          • collection boolean
        • created_at object
          Hide created_at attributes Show created_at attributes object
          • example string
          • description string
          • collection boolean
        • updated_at object
          Hide updated_at attributes Show updated_at attributes object
          • example string
          • description string
          • collection boolean
        • type object
          Hide type attributes Show type attributes object
          • example string
          • description string
          • collection boolean
        • role object
          Hide role attributes Show role attributes object
          • example string
          • description string
          • collection boolean
        • first_name object
          Hide first_name attributes Show first_name attributes object
          • example string
          • description string
          • collection boolean
        • last_name object
          Hide last_name attributes Show last_name attributes object
          • example string
          • description string
          • collection boolean
        • name object
          Hide name attributes Show name attributes object
          • example string
          • description string
          • collection boolean
        • email object
          Hide email attributes Show email attributes object
          • example string
          • description string
          • collection boolean
        • photo_url object
          Hide photo_url attributes Show photo_url attributes object
          • example string
          • description string
          • collection boolean
        • external_references object
          Hide external_references attributes Show external_references attributes object
          • example string
          • description string
          • collection boolean
      • assigned_to object
        Hide assigned_to attributes Show assigned_to attributes object
        • uuid object
          Hide uuid attributes Show uuid attributes object
          • example string
          • description string
          • collection boolean
        • created_at object
          Hide created_at attributes Show created_at attributes object
          • example string
          • description string
          • collection boolean
        • updated_at object
          Hide updated_at attributes Show updated_at attributes object
          • example string
          • description string
          • collection boolean
        • type object
          Hide type attributes Show type attributes object
          • example string
          • description string
          • collection boolean
        • role object
          Hide role attributes Show role attributes object
          • example string
          • description string
          • collection boolean
        • first_name object
          Hide first_name attributes Show first_name attributes object
          • example string
          • description string
          • collection boolean
        • last_name object
          Hide last_name attributes Show last_name attributes object
          • example string
          • description string
          • collection boolean
        • name object
          Hide name attributes Show name attributes object
          • example string
          • description string
          • collection boolean
        • email object
          Hide email attributes Show email attributes object
          • example string
          • description string
          • collection boolean
        • photo_url object
          Hide photo_url attributes Show photo_url attributes object
          • example string
          • description string
          • collection boolean
        • external_references object
          Hide external_references attributes Show external_references attributes object
          • example string
          • description string
          • collection boolean
      • completed_at string
      • completed_by object
        Hide completed_by attributes Show completed_by attributes object
        • uuid object
          Hide uuid attributes Show uuid attributes object
          • example string
          • description string
          • collection boolean
        • created_at object
          Hide created_at attributes Show created_at attributes object
          • example string
          • description string
          • collection boolean
        • updated_at object
          Hide updated_at attributes Show updated_at attributes object
          • example string
          • description string
          • collection boolean
        • type object
          Hide type attributes Show type attributes object
          • example string
          • description string
          • collection boolean
        • role object
          Hide role attributes Show role attributes object
          • example string
          • description string
          • collection boolean
        • first_name object
          Hide first_name attributes Show first_name attributes object
          • example string
          • description string
          • collection boolean
        • last_name object
          Hide last_name attributes Show last_name attributes object
          • example string
          • description string
          • collection boolean
        • name object
          Hide name attributes Show name attributes object
          • example string
          • description string
          • collection boolean
        • email object
          Hide email attributes Show email attributes object
          • example string
          • description string
          • collection boolean
        • photo_url object
          Hide photo_url attributes Show photo_url attributes object
          • example string
          • description string
          • collection boolean
        • external_references object
          Hide external_references attributes Show external_references attributes object
          • example string
          • description string
          • collection boolean
      • custom_fields array[object]
        Hide custom_fields attributes Show custom_fields attributes object
        • uuid string
        • created_at string
        • updated_at string
        • type string
        • name string
        • reference string
        • is_required boolean
        • value string
        • selection_options array[string]
        • help_text string
GET /api/v1/task 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/task' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "name": "Document the transaction",
      "uuid": "c0eb7051-10f5-4fdb-8a39-995f68a8953f",
      "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": "c1987acc-ec8a-4d1a-86dc-eee2e749f6fc",
          "collection": false,
          "description": "The UUID of the resource."
        },
        "email": {
          "example": "gareth@codepotato.co.uk",
          "collection": false,
          "description": "(Deprecated - Please use the primary email of the account instead). The email of the account."
        },
        "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": "2025-06-25T15:10:43+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": "2025-06-25T15:10:43+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": "59711c69-a529-4a2b-ad18-4f62fc71730e",
        "colour": "#398898",
        "position": 1,
        "created_at": "2025-06-25T15:10:43+01:00",
        "updated_at": "2025-06-25T15:10:43+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": "337496aa-7b3e-4d39-aed7-1751487f60ee",
        "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",
        "review_at": "2025-06-25T15:10:43+01:00",
        "created_at": "2025-06-25T15:10:43+01:00",
        "updated_at": "2025-06-25T15:10:43+01:00",
        "group_uuids": [
          "93f6dbbc-8157-43b4-9ba1-0cf63fba49e4"
        ],
        "completed_at": "2025-06-25T15:10:43+01:00",
        "participants": "App\\Http\\Resources\\AccountResource",
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "status_position": 4,
        "task_board_uuid": "f59d9522-932d-4cbd-97b5-75532c4d2fa2",
        "assigned_to_uuids": [
          "1062c719-c5e4-473d-913d-01df518def5b"
        ],
        "participants_count": 4
      },
      "created_at": "2025-06-25T15:10:43+01:00",
      "updated_at": "2025-06-25T15:10:43+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": "bf8b89c2-7539-4e87-8c38-4e03f6e0cdfc",
          "collection": false,
          "description": "The UUID of the resource."
        },
        "email": {
          "example": "gareth@codepotato.co.uk",
          "collection": false,
          "description": "(Deprecated - Please use the primary email of the account instead). The email of the account."
        },
        "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": "2025-06-25T15:10:43+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": "2025-06-25T15:10:43+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": "ed7d6c35-bd67-4200-9002-938e32641dd5",
          "collection": false,
          "description": "The UUID of the resource."
        },
        "email": {
          "example": "gareth@codepotato.co.uk",
          "collection": false,
          "description": "(Deprecated - Please use the primary email of the account instead). The email of the account."
        },
        "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": "2025-06-25T15:10:43+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": "2025-06-25T15:10:43+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": "1ba800eb-0720-400b-8972-29d11ad3a04d",
          "value": "Coffee",
          "help_text": "This is the client's favourite drink.",
          "reference": "favourite_drink",
          "created_at": "2025-06-25T15:10:43+01:00",
          "updated_at": "2025-06-25T15:10:43+01:00",
          "is_required": false,
          "selection_options": [
            "Coffee",
            "Tea",
            "Water"
          ]
        }
      ],
      "taskable_type": "case"
    }
  ]
}