Query parameters
-
Field to sort by. Valid fields are [created_at, updated_at, first_name, last_name, email, next_review_date, previous_review_date, anniversary_review_date]. Negative sign to denote DESC. Defaults to 'first_name'.
-
Comma separated list of relationships to include in the response. Valid relationships are [primary_phone_number, primary_email, primary_address, assigned_adviser, assigned_administrator, assigned_paraplanner, groups, tags, owners, custom_fields, external_references, charge_split_schema].
-
Filter accounts by a comma separated list of account UUIDs.
-
Exclude accounts by a comma separated list of account UUIDs.
-
Filter accounts by name. This is a partial match against first_name, last_name, and entity_name together.
-
Comma separated list of partial National Insurance Numbers to filter by.
-
Filter by date of birth with an operator.
-
(Deprecated! Please use primary_email) Filter accounts that have an email with a partial match.
-
Filter accounts with a given primary email. Performs a partial match.
-
Filter accounts with a given primary phone number. Performs a partial match.
-
Filter client status by partial names or uuid's
-
Get accounts with this is_prospect value
-
affects whether to include accounts based on the child account flag. Valid options are "exclude", "include", "only". (default: "include")
-
Get accounts set to inactive after this date
-
Get accounts set to inactive before this date
-
Comma separated string to filter by different account roles. Valid types are [individual, joint, trust, business,member,owner,admin,introducer].
-
Comma separated string to filter by different account types. Valid types are [client,employee,external].
-
Date to filter when the accounts was created after.
-
Date to filter when the accounts was created before.
-
Filter by a accounts custom field. Example filter[custom_field:pet_name]='Doug'
-
Comma separated list of partial groups names or group UUIDs.
-
Comma separated list of departments the employee is in.
-
Provide a group UUID (or multiple as a comma-separated string) to filter accounts within the provided groups out from the response.
-
filter clients that have been introduced by this introducer account, expects introducer account uuid, can accept multiple,
-
Filter to clients that have been linked to the account given. This will also return the requested account.
-
Comma separated list of employee account UUIDs that should always be returned no matter what other filters are applied.
-
Filter accounts that have an active login
-
Comma separated list of UUIDS to filter accounts who have the provided adviser account UUIDs
-
Comma separated list of UUIDS to filter accounts who have the provided administrator account UUIDs
-
Comma separated list of UUIDS to filter accounts who have the provided paraplanner account UUIDs
-
Number of results to return with pagination (Default 15. Max 500).
curl \
--request GET 'https://api.plannrcrm.com/api/v1/account' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
{
"data": [
{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "baff8f20-8236-4579-a9e2-bbbc773afbe0",
"county": "Hampshire",
"billing": {
"invoice_email": "gareth@codepotato.co.uk",
"invoice_county": "Hampshire",
"invoice_country": "United Kingdom",
"invoice_postcode": "PO7 7YH",
"invoice_address_1": "Suite E, 5 The Briars",
"invoice_address_2": "Waterberry Drive",
"invoice_town_city": "Waterlooville"
},
"country": "United Kingdom",
"postcode": "PO7 7YH",
"address_1": "Suite E, 5 The Briars",
"address_2": "Waterberry Drive",
"logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
"month_end": 25,
"town_city": "Waterlooville",
"created_at": "2025-10-24T10:34:17+01:00",
"updated_at": "2025-10-24T10:34:17+01:00",
"ip_whitelist": [
"192.168.0.1",
"127.0.0.1"
],
"brand_colours": {
"sidebar_text": "#ffffff",
"sidebar_hover": "#0A0A42",
"email_sub_text": "#ffffff",
"sidebar_accent": "#36367E",
"sidebar_active": "#53DBB8",
"email_background": "#0E0E56",
"email_button_text": "#ffffff",
"portal_background": "#f6f6f6",
"portal_brand_title": "#323b4b",
"sidebar_background": "#0E0E56",
"portal_sidebar_icon": "#828994",
"portal_sidebar_text": "#323b4b",
"portal_sidebar_title": "#11151d",
"sidebar_title_primary": "#FFC634",
"portal_brand_sub_title": "#828994",
"portal_sidebar_divider": "#e3e5e9",
"email_button_background": "#36367E",
"portal_dashboard_bg_one": "#EF4583",
"portal_dashboard_bg_two": "#FFC634",
"sidebar_title_secondary": "#ffffff",
"sidebar_title_background": "#36367E",
"portal_sidebar_icon_hover": "#828994",
"portal_sidebar_text_hover": "#323b4b",
"portal_sidebar_icon_active": "#828994",
"portal_sidebar_text_active": "#323b4b",
"email_logo_background_panel": "#36367E",
"portal_sidebar_button_hover": "#ffffff",
"portal_sidebar_account_email": "#828994",
"portal_sidebar_account_title": "#11151d",
"portal_sidebar_button_active": "#ffffff",
"sidebar_title_secondary_hover": "#ffffff",
"portal_sidebar_collapse_button": "#828994",
"portal_sidebar_user_select_text": "#323B4B",
"portal_sidebar_button_background": "#f6f6f6",
"portal_sidebar_user_select_hover": "transparent",
"portal_sidebar_user_select_border": "#EEEEEE",
"portal_sidebar_collapse_button_hover": "#B3B9C4",
"portal_sidebar_user_select_background": "transparent",
"portal_sidebar_user_select_text_hover": "#323B4B",
"portal_sidebar_user_select_border_hover": "#828994"
},
"is_subscribed": true,
"regulatory_text": "Regulatory text",
"cc_email_addresses": [
"jack@example.com",
"jill@example.com"
],
"addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
"bcc_email_addresses": [
"jack@example.com",
"jill@example.com"
],
"statement_frequency": "monthly",
"task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
"keep_deleted_files_for": 30,
"reply_to_email_address": "jack@example.com",
"welcome_paragraph_html": "<h1>Welcome.</h1>",
"email_welcome_paragraph_html": "Welcome to Plannr!",
"show_fact_find_illustrations": true
},
"name": "Gareth Thompson",
"role": "client",
"tags": [
{
"name": "Mortgage",
"slug": "mortgage",
"uuid": "1566478d-149a-44a7-a224-a6ad491348bb",
"colour": "#ef4582",
"created_at": "2025-10-24T10:34:17+01:00",
"updated_at": "2025-10-24T10:34:17+01:00"
}
],
"type": "client",
"uuid": "54be3283-e4cd-4b89-8a45-a73649fe9945",
"email": "gareth@codepotato.co.uk",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "36a26bb9-20e1-4d1c-9298-d7f4bd165071",
"created_at": "2025-10-24T10:34:17+01:00",
"updated_at": "2025-10-24T10:34:17+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "650ad914-41e5-4c5c-b069-2f7e28a68958",
"description": "UUID of the account"
},
"email": {
"example": "gareth@codepotato.co.uk",
"description": "Email of the account"
},
"last_name": {
"example": "Thompson",
"description": "Last name of the account"
},
"first_name": {
"example": "Gareth",
"description": "First name of the account"
}
},
"participants_count": "3"
}
],
"owners": [
{
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "462c571f-ca1c-421c-a730-e9b94b630b4c",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"circles": "App\\Http\\Resources\\CircleResource",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-10-24T10:34:17+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-24T10:34:17+01:00",
"with_login": true,
"inactive_at": "2025-10-24",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-10-24T10:34:17+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-10-24T10:34:17+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-10-24T10:34:17+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-10-24T10:34:17+01:00"
}
],
"circles": [
{
"name": "Jones Family",
"uuid": "f52fda95-e1fc-4cd6-adbe-5a1336795198",
"groups": "App\\Http\\Resources\\GroupResource",
"accounts": "App\\Http\\Resources\\AccountResource",
"bg_colour": "#35f4e1",
"photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
"created_at": "2025-10-24T10:34:17+01:00",
"updated_at": "2025-10-24T10:34:17+01:00",
"joint_account_uuid": "3db80f88-3e89-49ea-b8a5-50bfb2145b27",
"login_access_level": "write",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
}
],
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-10-24T10:34:17+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-24T10:34:17+01:00",
"with_login": true,
"inactive_at": "2025-10-24",
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "39ff5d08-9825-44c3-8142-79dd9a5b9429",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-10-24T10:34:17+01:00",
"updated_at": "2025-10-24T10:34:17+01:00",
"is_required": false,
"selection_options": [
"Coffee",
"Tea",
"Water"
]
}
],
"introduced_by": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "1af61f84-52db-4e0a-b34e-b8f874c666c1",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"circles": "App\\Http\\Resources\\CircleResource",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-10-24T10:34:17+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-24T10:34:17+01:00",
"with_login": true,
"inactive_at": "2025-10-24",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-10-24T10:34:17+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-10-24T10:34:17+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-10-24T10:34:17+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-10-24T10:34:17+01:00"
},
"primary_email": {
"name": "Work number",
"type": "phone_number",
"uuid": "070b4f7d-30cd-4401-9018-81f6c3fa8c76",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-10-24T10:34:17+01:00",
"updated_at": "2025-10-24T10:34:17+01:00",
"phone_number_meta": {
"country": "GB",
"formatted": "0333 090 3630"
}
},
"can_be_deleted": "false",
"assigned_adviser": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "32b997bd-1554-4da0-be56-e3f9e42d5e1f",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"circles": "App\\Http\\Resources\\CircleResource",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-10-24T10:34:17+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-24T10:34:17+01:00",
"with_login": true,
"inactive_at": "2025-10-24",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-10-24T10:34:17+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-10-24T10:34:17+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-10-24T10:34:17+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-10-24T10:34:17+01:00"
},
"next_review_date": "2025-10-24T10:34:17+01:00",
"has_joint_account": true,
"current_time_entry": {
"name": "Research",
"uuid": "25938a94-71ec-4e24-aacc-cd78c92981e8",
"account": "App\\Http\\Resources\\MinimalAccountResource",
"end_date": "2025-10-24T10:12:17+01:00",
"is_active": true,
"trackable": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2025-10-24T10:34:17+01:00",
"start_date": "2025-10-24T09:44:17+01:00",
"updated_at": "2025-10-24T10:34:17+01:00",
"description": "This is a description.",
"trackable_type": "Client",
"total_time_in_minutes": 28,
"computed_time_elapsed_in_seconds": 1680
},
"first_contact_date": "2025-10-24T10:34:17+01:00",
"external_references": [
{
"uuid": "ee9e0113-83a8-4db4-bdf8-34da05c6eff9",
"reference": "AB123456",
"created_at": "2025-10-24T10:34:17+01:00",
"updated_at": "2025-10-24T10:34:17+01:00",
"third_party": "nucleus"
}
],
"assigned_paraplanner": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "a8a240a4-722d-4216-b365-a15e48e3ea82",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"circles": "App\\Http\\Resources\\CircleResource",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-10-24T10:34:17+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-24T10:34:17+01:00",
"with_login": true,
"inactive_at": "2025-10-24",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-10-24T10:34:17+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-10-24T10:34:17+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-10-24T10:34:17+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-10-24T10:34:17+01:00"
},
"joint_account_circle": {
"name": "Jones Family",
"uuid": "add8eeba-7eda-43ae-9b71-accb6963733e",
"groups": "App\\Http\\Resources\\GroupResource",
"accounts": "App\\Http\\Resources\\AccountResource",
"bg_colour": "#35f4e1",
"photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
"created_at": "2025-10-24T10:34:17+01:00",
"updated_at": "2025-10-24T10:34:17+01:00",
"joint_account_uuid": "b2574752-e3b5-4996-b7f4-1eb9ac5a3108",
"login_access_level": "write",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"ownership_percentage": 100,
"previous_review_date": "2025-10-24T10:34:17+01:00",
"primary_phone_number": {
"name": "Work number",
"type": "phone_number",
"uuid": "82cd28b2-5025-4543-82fe-a25f5b692f6c",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-10-24T10:34:17+01:00",
"updated_at": "2025-10-24T10:34:17+01:00",
"phone_number_meta": {
"country": "GB",
"formatted": "0333 090 3630"
}
},
"assigned_administrator": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "9a7d56f1-6fde-4ed4-bc86-5b73b96cbb38",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"circles": "App\\Http\\Resources\\CircleResource",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-10-24T10:34:17+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-24T10:34:17+01:00",
"with_login": true,
"inactive_at": "2025-10-24",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-10-24T10:34:17+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-10-24T10:34:17+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-10-24T10:34:17+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-10-24T10:34:17+01:00"
},
"anniversary_review_date": "2025-10-24T10:34:17+01:00"
}
]
}