Get all clients [DEPRECATED: Use account route]

GET /api/v1/client

Personal access token & O auth2

Headers

Query parameters

include string

Comma separated list of relationships to include in the response. Valid relationships are [primary_phone_number,primary_email, assigned_adviser, assigned_administrator, groups, tags, owners, external_references].
filter[uuid] string

Filter by a comma separated list of UUIDs.
filter[name] string

Filter clients by name. This is a partial match against first_name, last_name, and entity_name together.
filter[email] string

Filter clients that have an email with a partial match.
filter[is_prospect] boolean

Get clients with this is_prospect value
filter[status] string

Filter client status by partial names or uuid's
filter[type] string

Comma separated string to filter by different client types. Valid types are [individual, joint, trust, business].
filter[created_after] string

Date to filter when the client was created after. Example 2022-04-05
filter[created_before] string

Date to filter when the client was created before. Example 2022-05-31
filter[custom_field:REFERENCE] string

Filter by a client custom field. Example filter[custom_field:pet_name]='Doug'
filter[tags] string

Comma separated list of tag names or tag UUIDs.
filter[groups] string

Comma separated list of partial groups names or group UUIDs.
filter[exclude_groups] string

Provide a group UUID (or multiple as a comma-separated string) to filter clients within the provided groups out from the response.
filter[introduced_by] string

Filter clients that have been introduced by this account.
filter[linked_to] string

Filter to clients that have been linked to the account given. This will also return the requested account.
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'.
per_page integer

Number of results to return with pagination (Default 15. Max 500).

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- type string
  
  Account type
- role string
  
  Account role
- first_name string
  
  First name
- last_name string
  
  Last name
- name string
  
  Name
- email string
  
  (Deprecated - Please use primary_email instead). The email of the account.
- firm object
  
  Firm
- primary_phone_number object
  
  Primary phone number
- primary_email object
  
  Primary email
- current_time_entry object
  
  Current time entry
- assigned_adviser object
  
  Assigned adviser
- assigned_administrator object
  
  Assigned administrator
- assigned_paraplanner object
  
  Assigned paraplanner
- introduced_by object
  
  Introduced by
- groups array[object]
  
  Groups
- tags array[object]
  
  Tags
- owners array[object]
  
  Accounts that own this account
- first_contact_date string
  
  First contact date
- next_review_date string
  
  Next review date
- previous_review_date string
  
  Previous review date
- anniversary_review_date string
  
  Anniversary review date
- with_login boolean
  
  Denotes whether the account has a login to Plannr
- has_joint_account boolean
  
  Denotes whether this account belongs to a joint account too
- can_be_deleted string
  
  Denotes if the account can be deleted
- joint_account_circle object
  
  This field is only present when viewing a joint account directly. This will contain the circle that we automatically created when we released circles.
- ownership_percentage integer
  
  Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
- inactive_at string
  
  Inactive from date
- custom_fields array[object]
  
  Any custom fields on the model.
- external_references array[object]
  
  The external references that have been added to the client.

GET /api/v1/client

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/client' \
 --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)

{
  "firm": {
    "tax": 17.5,
    "logo": "https://api.plannrcrm.com/images/plannr.jpg",
    "name": "Codepotato",
    "slug": "codepotato",
    "uuid": "52bfd821-c63e-4f16-8a1b-a41fb5bdfa38",
    "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-04-22T13:44:17+01:00",
    "updated_at": "2025-04-22T13:44: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",
      "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!",
    "show_fact_find_illustrations": true
  },
  "name": "Gareth Thompson",
  "role": "client",
  "tags": [
    {
      "name": "Mortgage",
      "slug": "mortgage",
      "uuid": "c1e79d02-ef3c-4b5a-8347-ffaa98727c9a",
      "colour": "#ef4582",
      "created_at": "2025-04-22T13:44:17+01:00",
      "updated_at": "2025-04-22T13:44:17+01:00"
    }
  ],
  "type": "client",
  "uuid": "72c3e5be-8151-49e8-b696-d48d8b5cd122",
  "email": "gareth@codepotato.co.uk",
  "groups": [
    {
      "name": "finance",
      "slug": "finance",
      "uuid": "c6842b99-17b0-43ff-9b8a-6ffa641fc2f3",
      "created_at": "2025-04-22T13:44:17+01:00",
      "updated_at": "2025-04-22T13:44:17+01:00",
      "participants": {
        "name": {
          "example": "Gareth Thompson",
          "description": "Name of the account"
        },
        "role": {
          "example": "client",
          "description": "Role of the account"
        },
        "uuid": {
          "example": "79b46b80-cfeb-4d43-8acd-a3ed245288c8",
          "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": "35fe25b7-63da-47f6-ac74-67c751ca21e4",
      "email": "gareth@codepotato.co.uk",
      "groups": "App\\Http\\Resources\\GroupResource",
      "owners": "App\\Http\\Resources\\AccountResource",
      "last_name": "Thompson",
      "created_at": "2025-04-22T13:44:17+01:00",
      "first_name": "Gareth",
      "updated_at": "2025-04-22T13:44:17+01:00",
      "with_login": true,
      "inactive_at": "2025-04-22",
      "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-04-22T13:44:17+01:00",
      "has_joint_account": true,
      "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
      "first_contact_date": "2025-04-22T13:44: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-04-22T13:44:17+01:00",
      "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
      "assigned_administrator": "App\\Http\\Resources\\AccountResource",
      "anniversary_review_date": "2025-04-22T13:44:17+01:00"
    }
  ],
  "last_name": "Thompson",
  "created_at": "2025-04-22T13:44:17+01:00",
  "first_name": "Gareth",
  "updated_at": "2025-04-22T13:44:17+01:00",
  "with_login": true,
  "inactive_at": "2025-04-22",
  "custom_fields": [
    {
      "name": "Favourite Drink",
      "type": "string",
      "uuid": "e2095e64-da6e-4b0b-8139-44efd8b60655",
      "value": "Coffee",
      "help_text": "This is the client's favourite drink.",
      "reference": "favourite_drink",
      "created_at": "2025-04-22T13:44:17+01:00",
      "updated_at": "2025-04-22T13:44: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": "a134f6f3-527d-4896-bb37-07902819bae9",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-04-22T13:44:17+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-04-22T13:44:17+01:00",
    "with_login": true,
    "inactive_at": "2025-04-22",
    "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-04-22T13:44:17+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-04-22T13:44: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-04-22T13:44:17+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-04-22T13:44:17+01:00"
  },
  "primary_email": {
    "name": "Work number",
    "type": "phone_number",
    "uuid": "1c9f6aaa-8779-440d-9599-b0a3231cc28e",
    "value": "+443330903630",
    "accounts": "App\\Http\\Resources\\AccountResource",
    "created_at": "2025-04-22T13:44:17+01:00",
    "updated_at": "2025-04-22T13:44: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": "c761753e-b87b-4c4c-aadf-afd4c3763256",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-04-22T13:44:17+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-04-22T13:44:17+01:00",
    "with_login": true,
    "inactive_at": "2025-04-22",
    "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-04-22T13:44:17+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-04-22T13:44: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-04-22T13:44:17+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-04-22T13:44:17+01:00"
  },
  "next_review_date": "2025-04-22T13:44:17+01:00",
  "has_joint_account": true,
  "current_time_entry": {
    "name": "Research",
    "uuid": "04546fb3-a19f-4dfb-8969-195b5a37264c",
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "end_date": "2025-04-22T13:22:17+01:00",
    "is_active": true,
    "trackable": "App\\Http\\Resources\\MinimalAccountResource",
    "created_at": "2025-04-22T13:44:17+01:00",
    "start_date": "2025-04-22T12:54:17+01:00",
    "updated_at": "2025-04-22T13:44: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-04-22T13:44:17+01:00",
  "external_references": [
    {
      "uuid": "b9a4ba9f-3130-44d2-815a-65eed2517e83",
      "reference": "AB123456",
      "created_at": "2025-04-22T13:44:17+01:00",
      "updated_at": "2025-04-22T13:44: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": "268c4110-dd38-4d4c-a97f-d8014391b56b",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-04-22T13:44:17+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-04-22T13:44:17+01:00",
    "with_login": true,
    "inactive_at": "2025-04-22",
    "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-04-22T13:44:17+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-04-22T13:44: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-04-22T13:44:17+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-04-22T13:44:17+01:00"
  },
  "joint_account_circle": {
    "name": "Jones Family",
    "uuid": "115ea74b-a8e9-4f76-9b85-7e28fe0616c5",
    "groups": "App\\Http\\Resources\\GroupResource",
    "accounts": "App\\Http\\Resources\\MinimalAccountResource",
    "created_at": "2025-04-22T13:44:17+01:00",
    "updated_at": "2025-04-22T13:44:17+01:00",
    "joint_account_uuid": "d488a416-7616-4ba0-8f92-29de9723b87c"
  },
  "ownership_percentage": 100,
  "previous_review_date": "2025-04-22T13:44:17+01:00",
  "primary_phone_number": {
    "name": "Work number",
    "type": "phone_number",
    "uuid": "cd5a269c-3576-4415-a90c-261ee204b667",
    "value": "+443330903630",
    "accounts": "App\\Http\\Resources\\AccountResource",
    "created_at": "2025-04-22T13:44:17+01:00",
    "updated_at": "2025-04-22T13:44: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": "79097c25-fb21-4eb9-a6e5-55a2c03f7141",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-04-22T13:44:17+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-04-22T13:44:17+01:00",
    "with_login": true,
    "inactive_at": "2025-04-22",
    "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-04-22T13:44:17+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-04-22T13:44: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-04-22T13:44:17+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-04-22T13:44:17+01:00"
  },
  "anniversary_review_date": "2025-04-22T13:44:17+01:00"
}