Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
Query parameters
-
sort string
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'.
-
include string
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[name] string
Filter accounts by name. This is a partial match against first_name, last_name, and entity_name together.
-
filter[email] string
Filter accounts that have an email with a partial match. (DEPRECATED - Please use primary_email)
-
filter[primary_email] string
Filter accounts with a given primary email. Performs a partial match.
-
filter[primary_phone_number] string
Filter accounts with a given primary phone number. Performs a partial match.
-
filter[status] string
Filter client status by partial names or uuid's
-
filter[is_prospect] boolean
Get accounts with this is_prospect value
-
filter[role] string
Comma separated string to filter by different account roles. Valid types are [individual, joint, trust, business,member,owner,admin,introducer].
-
filter[type] string
Comma separated string to filter by different account types. Valid types are [client,employee,external].
-
filter[created_after] string
Date to filter when the accounts was created after. Example 2022-04-05
-
filter[created_before] string
Date to filter when the accounts was created before. Example 2022-05-31
-
Filter by a accounts custom field. Example filter[custom_field:pet_name]='Doug'
-
filter[groups] string
Comma separated list of partial groups names or group UUIDs.
-
filter[departments] string
Comma separated list of departments the employee is in.
-
filter[exclude_groups] string
Provide a group UUID (or multiple as a comma-separated string) to filter accounts within the provided groups out from the response.
-
filter[introduced_by] string
filter clients that have been introduced by this introducer account, expects introducer account uuid, can accept multiple,
-
filter[linked_to] string
Filter to clients that have been linked to the account given. This will also return the requested account.
-
filter[include] string
Comma separated list of employee account UUIDs that should always be returned no matter what other filters are applied.
-
filter[has_login] boolean
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
-
per_page integer
Number of results to return with pagination (Default 15. Max 500).
GET
/api/v1/account
curl \
--request GET https://api.plannrcrm.com/api/v1/account \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"data": [
{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "3bf8270e-79b4-419a-a9cd-0f00aa1eb176",
"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-02-20T10:13:00+00:00",
"updated_at": "2025-02-20T10:13:00+00: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",
"sidebar_background": "#0E0E56",
"sidebar_title_primary": "#FFC634",
"email_button_background": "#36367E",
"sidebar_title_secondary": "#ffffff",
"sidebar_title_background": "#36367E",
"email_logo_background_panel": "#36367E",
"sidebar_title_secondary_hover": "#ffffff"
},
"is_subscribed": true,
"regulatory_text": "Regulatory text",
"addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
"statement_frequency": "monthly",
"task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
"keep_deleted_files_for": 30,
"welcome_paragraph_html": "<h1>Welcome.</h1>",
"email_welcome_paragraph_html": "Welcome to Plannr!"
},
"name": "Gareth Thompson",
"role": "client",
"tags": [
{
"name": "Mortgage",
"slug": "mortgage",
"uuid": "3f1e5db2-e049-43a6-aae4-76c20ee5e3ca",
"colour": "#ef4582",
"created_at": "2025-02-20T10:13:00+00:00",
"updated_at": "2025-02-20T10:13:00+00:00"
}
],
"type": "client",
"uuid": "91069afc-f3ff-4218-b18b-4674af6a0637",
"email": "gareth@codepotato.co.uk",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "4f93a13e-3962-4621-bf7e-1d9ba85e0e55",
"created_at": "2025-02-20T10:13:00+00:00",
"updated_at": "2025-02-20T10:13:00+00:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "9e17eb68-5832-4085-8695-967214926557",
"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": "9dfcaed5-afa0-41ba-becf-955dc54d7284",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-02-20T10:13:00+00:00",
"first_name": "Gareth",
"updated_at": "2025-02-20T10:13:00+00:00",
"with_login": true,
"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-02-20T10:13:00+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-02-20T10:13:00+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2025-02-20T10:13:00+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-02-20T10:13:00+00:00"
}
],
"last_name": "Thompson",
"created_at": "2025-02-20T10:13:00+00:00",
"first_name": "Gareth",
"updated_at": "2025-02-20T10:13:00+00:00",
"with_login": true,
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "9bd15ef2-c5ba-4498-af92-adf555e5adae",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-02-20T10:13:00+00:00",
"updated_at": "2025-02-20T10:13:00+00: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": "efc9ca38-7f52-4778-839c-454b2aea12dc",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-02-20T10:13:00+00:00",
"first_name": "Gareth",
"updated_at": "2025-02-20T10:13:00+00:00",
"with_login": true,
"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-02-20T10:13:00+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-02-20T10:13:00+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2025-02-20T10:13:00+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-02-20T10:13:00+00:00"
},
"primary_email": {
"name": "Work number",
"type": "phone_number",
"uuid": "10c952bb-2eb7-42ac-bf90-2104d44e7033",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-02-20T10:13:00+00:00",
"updated_at": "2025-02-20T10:13:00+00: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": "f09752a7-9ab2-4e3a-abe5-9cede743edf9",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-02-20T10:13:00+00:00",
"first_name": "Gareth",
"updated_at": "2025-02-20T10:13:00+00:00",
"with_login": true,
"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-02-20T10:13:00+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-02-20T10:13:00+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2025-02-20T10:13:00+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-02-20T10:13:00+00:00"
},
"next_review_date": "2025-02-20T10:13:00+00:00",
"has_joint_account": true,
"current_time_entry": {
"name": "Research",
"uuid": "6564e138-611e-4cae-a7e6-0e5d1c0e643e",
"account": "App\\Http\\Resources\\MinimalAccountResource",
"end_date": "2025-02-20T09:51:00+00:00",
"is_active": true,
"trackable": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2025-02-20T10:13:00+00:00",
"start_date": "2025-02-20T09:23:00+00:00",
"updated_at": "2025-02-20T10:13:00+00:00",
"description": "This is a description.",
"trackable_type": "Client",
"total_time_in_minutes": 28,
"computed_time_elapsed_in_seconds": 1680
},
"first_contact_date": "2025-02-20T10:13:00+00:00",
"external_references": [
{
"uuid": "e2591764-1250-4af2-b455-31798a85cb6d",
"reference": "AB123456",
"created_at": "2025-02-20T10:13:00+00:00",
"updated_at": "2025-02-20T10:13:00+00:00",
"third_party": "nucleus"
}
],
"assigned_paraplanner": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "6ddd7fec-f6bf-4130-9f61-aaf9438dfee7",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-02-20T10:13:00+00:00",
"first_name": "Gareth",
"updated_at": "2025-02-20T10:13:00+00:00",
"with_login": true,
"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-02-20T10:13:00+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-02-20T10:13:00+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2025-02-20T10:13:00+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-02-20T10:13:00+00:00"
},
"previous_review_date": "2025-02-20T10:13:00+00:00",
"primary_phone_number": {
"name": "Work number",
"type": "phone_number",
"uuid": "b62b12f8-f7ae-4c40-bb20-de91bf5042e7",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-02-20T10:13:00+00:00",
"updated_at": "2025-02-20T10:13:00+00: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": "d708a16c-d5b0-442b-a18d-d5c974fd1c21",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-02-20T10:13:00+00:00",
"first_name": "Gareth",
"updated_at": "2025-02-20T10:13:00+00:00",
"with_login": true,
"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-02-20T10:13:00+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-02-20T10:13:00+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2025-02-20T10:13:00+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-02-20T10:13:00+00:00"
},
"anniversary_review_date": "2025-02-20T10:13:00+00:00"
}
]
}