Get all tasks on a firm. Run in API Explorer
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.
Query parameters
-
Comma separated list of relationships to include in the response. Valid relationships are [author, completed_by, parent_task, related_tasks, custom_fields, workflow_task].
-
Number of results to return with pagination (Default 15. Max 500).
-
Filter Task name.
-
Taskable type. Can be 'plan' or 'case'.
-
Taskable uuid.
-
Client Taskable uuid.
-
Priority. Available options are highest, high, medium, and low.
-
Filter tasks that have been assigned to the account UUIDs.
-
Filter tasks that have been assigned to the account UUIDs within the specified circles.
-
Status uuid. The task's status uuid.
-
date Filter tasks that have a due at date before.
-
date Filter tasks that have a due at date after.
-
Filter tasks that have a due at date or not.
-
Only show open tasks. When true, this will filter tasks in the "Completed" or "Archived" columns.
-
Filter tasks which have a system status of type completed.
-
Filter tasks which have a system status of type archived.
-
Filter tasks which have a system status of type not started.
-
(deprecated, use subtask_visibility instead) Show child tasks in the top-level list. Defaults to false.
-
Filter subtasks in the top-level list. options are: include, exclude or only.
-
Filter unassigned subtasks in the top-level list. options are: include, exclude or only.
-
Filter recurring tasks.
-
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'.
curl \
--request GET 'https://api.plannrcrm.com/api/v1/task' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
{
"data": [
{
"uuid": "498329c7-352b-4f19-8ed2-aebe3eba0440",
"created_at": "2026-07-17T15:25:29+01:00",
"updated_at": "2026-07-17T15:25:29+01:00",
"name": "Document the transaction",
"priority": "high",
"position": 1,
"due_at": "2021-01-01 00:00:00",
"status": {
"uuid": "6d7bf936-a784-4ef6-873e-db3c9b127b18",
"created_at": "2026-07-17T15:25:29+01:00",
"updated_at": "2026-07-17T15:25:29+01:00",
"name": "Incomplete",
"colour": "#398898",
"position": 1,
"is_type_completed": false,
"is_archived": false,
"is_not_started": false
},
"taskable_type": "case",
"taskable": {
"uuid": "bee9bc34-1a67-42d8-a524-c5fa37b190b3",
"created_at": "2026-07-17T15:25:29+01:00",
"updated_at": "2026-07-17T15:25:29+01:00",
"name": "finance",
"slug": "finance",
"status": {
"uuid": "448db5f9-a642-42a5-8a99-7e5a179d16dc",
"created_at": "2026-07-17T15:25:36+01:00",
"updated_at": "2026-07-17T15:25:36+01:00",
"name": "To Be Reviewed",
"colour": "#23852B",
"position": 5,
"is_type_completed": false
},
"type": {
"uuid": null,
"name": "Mortgage Plan",
"created_at": "2026-07-17T15:25:36+01:00",
"updated_at": "2026-07-17T15:25:36+01:00"
},
"review_at": "2026-07-17T15:25:29+01:00",
"assigned_to_uuids": [
"4ea8242d-5b44-4a73-8b13-76f962c48eb5"
],
"group_uuids": [
"ad0af48f-7279-4346-b29d-d79620a5dbfc"
],
"completed_at": "2026-07-17T15:25:29+01:00",
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
}
},
"status_position": 4,
"participants_count": 4,
"participants": {
"uuid": "543b4daa-a2a5-40d9-b97a-af39e3746a8f",
"created_at": "2026-07-17T15:25:36+01:00",
"updated_at": "2026-07-17T15:25:36+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"first_contact_date": "2026-07-17T15:25:36+01:00",
"next_review_date": "2026-07-17T15:25:36+01:00",
"previous_review_date": "2026-07-17T15:25:36+01:00",
"anniversary_review_date": "2026-07-17T15:25:36+01:00",
"terms_of_business_at": "2026-07-17T15:25:36+01:00",
"client_agreement_at": "2026-07-17T15:25:36+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"ownership_percentage": 100.0,
"inactive_at": "2026-07-17",
"last_interaction_at": "2026-07-17 15:25:36",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
}
},
"task_board_uuid": "a36f3ce7-7da1-4c02-aba2-e59d38d5c641",
"plans": {
"uuid": "71e659a7-9e83-46b4-ac51-28d5db89ee6b",
"created_at": "2026-07-17T15:25:36+01:00",
"updated_at": "2026-07-17T15:25:36+01:00",
"opened_at": "2026-07-17T15:25:36+01:00",
"name": "Johns ISA",
"type": "cash_account",
"sub_type": "lifetime isa",
"abstract_type": "asset",
"policy_number": "AVIVA-123",
"proposal_reference": "AB123456",
"status": "inactive",
"inactive_at": "2026-07-17T15:25:36+01:00",
"inactive_reason": "claimed",
"agency_in_your_name": true,
"agency_in_your_name_from": "2025-07-17",
"originally_sold_by_firm": true,
"under_advice": true,
"visible_on_client_portal": true,
"include_in_client_valuation": true,
"show_on_joint": true,
"shown_on_circles": true,
"review_date": "2025-07-17",
"on_panel": true,
"is_group_scheme": false,
"is_sub_group_scheme": false,
"is_group_scheme_member": false,
"advice_area": "non_investment_insurance",
"total_benefit_amount": {
"amount": {
"example": "25000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£250,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": null,
"description": "Currency of the money"
}
},
"total_benefits": {
"critical_illness": {
"amount": {
"example": "15000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£150,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": null,
"description": "Currency of the money"
}
},
"family_income_benefit": {
"amount": {
"example": "10000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£100,000.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": null,
"description": "Currency of the money"
}
}
},
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
},
"currency": {
"example": null,
"description": "Currency of the money"
}
},
"valued_at": "2026-07-17T15:25:36+01:00",
"original_valued_at": "2026-07-16T15:25:36+01:00",
"statistics": {
"recent_growth": 100
},
"is_wrap_product": false,
"is_wrap_child": false,
"can_be_deleted": "false"
},
"custom_fields": {
"uuid": null,
"created_at": "2026-07-17T15:25:36+01:00",
"updated_at": "2026-07-17T15:25:36+01:00",
"type": "string",
"name": "Favourite Drink",
"reference": "favourite_drink",
"is_required": false,
"value": "Coffee",
"selection_options": [
"Coffee",
"Tea",
"Water"
],
"help_text": "This is the client's favourite drink."
}
},
"author": {
"uuid": "b13a50ee-a08a-4acb-95cd-455bad45e60c",
"created_at": "2026-07-17T15:25:29+01:00",
"updated_at": "2026-07-17T15:25:29+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"external_references": {
"uuid": "11b7fb3c-bff7-4355-b5d5-6e063a2cdde5",
"created_at": "2026-07-17T15:25:36+01:00",
"updated_at": "2026-07-17T15:25:36+01:00",
"third_party": "nucleus",
"reference": "AB123456"
}
},
"assigned_to": [
{
"uuid": "028eef94-6caf-4072-9371-074837911ebe",
"created_at": "2026-07-17T15:25:29+01:00",
"updated_at": "2026-07-17T15:25:29+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"external_references": {
"uuid": "11b7fb3c-bff7-4355-b5d5-6e063a2cdde5",
"created_at": "2026-07-17T15:25:36+01:00",
"updated_at": "2026-07-17T15:25:36+01:00",
"third_party": "nucleus",
"reference": "AB123456"
}
}
],
"completed_at": "2021-01-01 00:00:00",
"completed_by": {
"uuid": "7a386ed2-fcee-46cd-aaf1-dbaf808ed280",
"created_at": "2026-07-17T15:25:29+01:00",
"updated_at": "2026-07-17T15:25:29+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"external_references": {
"uuid": "11b7fb3c-bff7-4355-b5d5-6e063a2cdde5",
"created_at": "2026-07-17T15:25:36+01:00",
"updated_at": "2026-07-17T15:25:36+01:00",
"third_party": "nucleus",
"reference": "AB123456"
}
},
"workflow_task": {
"uuid": "71149342-6f79-4b49-9c40-3ad8702e87e0",
"created_at": "2026-07-17T15:25:29+01:00",
"updated_at": "2026-07-17T15:25:29+01:00",
"name": "Mortgage Review",
"description": "We need to run through a mortgage review with Gareth, as he can probably find a better deal.",
"priority": "high",
"position": 2,
"task_status": {
"uuid": "e947ba0e-8b4f-452e-87fa-f6a1ea6d77c1",
"created_at": "2026-07-17T15:25:37+01:00",
"updated_at": "2026-07-17T15:25:37+01:00",
"name": "Incomplete",
"colour": "#398898",
"position": 1,
"is_type_completed": false,
"is_archived": false,
"is_not_started": false
},
"offset_due_at_by": 2,
"visible_to_clients": true,
"auto_assign_assigned_adviser": true,
"auto_assign_assigned_administrator": true,
"auto_assign_clients": true,
"author": {
"uuid": "543b4daa-a2a5-40d9-b97a-af39e3746a8f",
"created_at": "2026-07-17T15:25:36+01:00",
"updated_at": "2026-07-17T15:25:36+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"first_contact_date": "2026-07-17T15:25:36+01:00",
"next_review_date": "2026-07-17T15:25:36+01:00",
"previous_review_date": "2026-07-17T15:25:36+01:00",
"anniversary_review_date": "2026-07-17T15:25:36+01:00",
"terms_of_business_at": "2026-07-17T15:25:36+01:00",
"client_agreement_at": "2026-07-17T15:25:36+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"ownership_percentage": 100.0,
"inactive_at": "2026-07-17",
"last_interaction_at": "2026-07-17 15:25:36",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
}
},
"participants": {
"uuid": "543b4daa-a2a5-40d9-b97a-af39e3746a8f",
"created_at": "2026-07-17T15:25:36+01:00",
"updated_at": "2026-07-17T15:25:36+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"first_contact_date": "2026-07-17T15:25:36+01:00",
"next_review_date": "2026-07-17T15:25:36+01:00",
"previous_review_date": "2026-07-17T15:25:36+01:00",
"anniversary_review_date": "2026-07-17T15:25:36+01:00",
"terms_of_business_at": "2026-07-17T15:25:36+01:00",
"client_agreement_at": "2026-07-17T15:25:36+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"ownership_percentage": 100.0,
"inactive_at": "2026-07-17",
"last_interaction_at": "2026-07-17 15:25:36",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
}
},
"tags": {
"uuid": "f1ecba6d-f8a7-415f-90f1-db030dd72262",
"created_at": "2026-07-17T15:25:36+01:00",
"updated_at": "2026-07-17T15:25:36+01:00",
"name": "Mortgage",
"slug": "mortgage",
"colour": "#ef4582"
},
"location_uuid": "90d5213b-d34b-44b2-abe9-5442fff0d7bb",
"parent": {
"uuid": "892542e6-2a93-433b-b737-0612368a8581",
"created_at": "2026-07-17T15:25:37+01:00",
"updated_at": "2026-07-17T15:25:37+01:00",
"name": "Mortgage Review",
"description": "We need to run through a mortgage review with Gareth, as he can probably find a better deal.",
"priority": "high",
"position": 2,
"offset_due_at_by": 2,
"visible_to_clients": true,
"auto_assign_assigned_adviser": true,
"auto_assign_assigned_administrator": true,
"auto_assign_clients": true,
"location_uuid": "29cb632d-f813-48d4-bd97-0780a8a4c51a",
"is_trigger_task": true
},
"trigger": {
"uuid": "892542e6-2a93-433b-b737-0612368a8581",
"created_at": "2026-07-17T15:25:37+01:00",
"updated_at": "2026-07-17T15:25:37+01:00",
"name": "Mortgage Review",
"description": "We need to run through a mortgage review with Gareth, as he can probably find a better deal.",
"priority": "high",
"position": 2,
"offset_due_at_by": 2,
"visible_to_clients": true,
"auto_assign_assigned_adviser": true,
"auto_assign_assigned_administrator": true,
"auto_assign_clients": true,
"location_uuid": "29cb632d-f813-48d4-bd97-0780a8a4c51a",
"is_trigger_task": true
},
"trigger_tasks": {
"uuid": "892542e6-2a93-433b-b737-0612368a8581",
"created_at": "2026-07-17T15:25:37+01:00",
"updated_at": "2026-07-17T15:25:37+01:00",
"name": "Mortgage Review",
"description": "We need to run through a mortgage review with Gareth, as he can probably find a better deal.",
"priority": "high",
"position": 2,
"offset_due_at_by": 2,
"visible_to_clients": true,
"auto_assign_assigned_adviser": true,
"auto_assign_assigned_administrator": true,
"auto_assign_clients": true,
"location_uuid": "29cb632d-f813-48d4-bd97-0780a8a4c51a",
"is_trigger_task": true
},
"sub_tasks": {
"uuid": "892542e6-2a93-433b-b737-0612368a8581",
"created_at": "2026-07-17T15:25:37+01:00",
"updated_at": "2026-07-17T15:25:37+01:00",
"name": "Mortgage Review",
"description": "We need to run through a mortgage review with Gareth, as he can probably find a better deal.",
"priority": "high",
"position": 2,
"offset_due_at_by": 2,
"visible_to_clients": true,
"auto_assign_assigned_adviser": true,
"auto_assign_assigned_administrator": true,
"auto_assign_clients": true,
"location_uuid": "29cb632d-f813-48d4-bd97-0780a8a4c51a",
"is_trigger_task": true
},
"groups": {
"uuid": null,
"name": "finance",
"slug": "finance",
"participants_count": "3",
"participants": {
"uuid": {
"example": null,
"description": "UUID of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"first_name": {
"example": "Gareth",
"description": "First name of the account"
},
"last_name": {
"example": "Thompson",
"description": "Last name of the account"
},
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"email": {
"example": "gareth@codepotato.co.uk",
"description": "Email of the account"
}
},
"created_at": "2026-07-17T15:25:36+01:00",
"updated_at": "2026-07-17T15:25:36+01:00"
},
"workflow": {
"uuid": "40642913-9ca1-435b-a5a1-f4df2b89f3aa",
"created_at": "2026-07-17T15:25:37+01:00",
"updated_at": "2026-07-17T15:25:37+01:00",
"name": "Pension Transfer",
"type": "simple",
"tasks_count": 5
},
"is_trigger_task": true
},
"workflow": {
"uuid": "d9cdab61-c973-4b62-95ec-cdd708155c32",
"name": "New Client Onboarding"
},
"is_recurring": true,
"recurring_frequency": "weekly",
"recurring_last_run": "2026-01-01 00:00:00",
"recurring_next_run": "2026-01-01 00:00:00",
"custom_fields": [
{
"uuid": "2e571f19-085a-4f39-9f4e-0b48cf488abb",
"created_at": "2026-07-17T15:25:29+01:00",
"updated_at": "2026-07-17T15:25:29+01:00",
"type": "string",
"name": "Favourite Drink",
"reference": "favourite_drink",
"is_required": false,
"value": "Coffee",
"selection_options": [
"Coffee",
"Tea",
"Water"
],
"help_text": "This is the client's favourite drink."
}
]
}
]
}