Get all clients [DEPRECATED: Use account route]

GET /api/v1/client

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

GET /api/v1/client 
curl \
 -X GET https://api.plannrcrm.com/api/v1/client \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "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": "20fb2b3c-f1fc-47d4-877d-d4cedb922b21",
    "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": "2024-10-16T11:10:13+01:00",
    "updated_at": "2024-10-16T11:10:13+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!"
  },
  "name": "Gareth Thompson",
  "role": "client",
  "tags": [
    {
      "name": "Mortgage",
      "slug": "mortgage",
      "uuid": "2f91f0f6-d80a-4c73-a7aa-6a8dfe340629",
      "colour": "#ef4582",
      "created_at": "2024-10-16T11:10:13+01:00",
      "updated_at": "2024-10-16T11:10:13+01:00"
    }
  ],
  "type": "client",
  "uuid": "9bb1a968-d6d0-4384-9dd8-3d5fc669da9e",
  "email": "gareth@codepotato.co.uk",
  "groups": [
    {
      "name": "finance",
      "slug": "finance",
      "uuid": "b675f4b5-38e5-443e-9a3f-699907e9c1e1",
      "created_at": "2024-10-16T11:10:13+01:00",
      "updated_at": "2024-10-16T11:10:13+01:00",
      "participants": {
        "name": {
          "example": "Gareth Thompson",
          "description": "Name of the account"
        },
        "role": {
          "example": "client",
          "description": "Role of the account"
        },
        "uuid": {
          "example": "25445a48-3140-404b-bdb3-61f220807ea8",
          "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": "6f993f3f-93cc-4a06-94f1-674b51764889",
      "email": "gareth@codepotato.co.uk",
      "groups": "App\\Http\\Resources\\GroupResource",
      "owners": "App\\Http\\Resources\\AccountResource",
      "last_name": "Thompson",
      "created_at": "2024-10-16T11:10:13+01:00",
      "first_name": "Gareth",
      "updated_at": "2024-10-16T11:10:13+01: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": "2024-10-16T11:10:13+01:00",
      "has_joint_account": true,
      "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
      "first_contact_date": "2024-10-16T11:10:13+01:00",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
      "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
      "previous_review_date": "2024-10-16T11:10:13+01:00",
      "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
      "assigned_administrator": "App\\Http\\Resources\\AccountResource",
      "anniversary_review_date": "2024-10-16T11:10:13+01:00"
    }
  ],
  "last_name": "Thompson",
  "created_at": "2024-10-16T11:10:13+01:00",
  "first_name": "Gareth",
  "updated_at": "2024-10-16T11:10:13+01:00",
  "with_login": true,
  "custom_fields": [
    {
      "name": "Favourite Drink",
      "type": "string",
      "uuid": "8f3fdc62-0719-4f30-b1d2-3ebed197b557",
      "value": "Coffee",
      "help_text": "This is the client's favourite drink.",
      "reference": "favourite_drink",
      "created_at": "2024-10-16T11:10:13+01:00",
      "updated_at": "2024-10-16T11:10:13+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": "c08d0e8d-6732-4d08-a7d2-8460dbe2800c",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-10-16T11:10:13+01:00",
    "first_name": "Gareth",
    "updated_at": "2024-10-16T11:10:13+01: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": "2024-10-16T11:10:13+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-10-16T11:10:13+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-10-16T11:10:13+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-10-16T11:10:13+01:00"
  },
  "primary_email": {
    "name": "Work number",
    "type": "phone_number",
    "uuid": "87941073-d1f6-406f-81c3-452f1dd87d65",
    "value": "+443330903630",
    "account": "App\\Http\\Resources\\AccountResource",
    "primary": true,
    "created_at": "2024-10-16T11:10:13+01:00",
    "updated_at": "2024-10-16T11:10:13+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": "3ce350ac-8f06-4de2-9144-7469a15a396e",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-10-16T11:10:13+01:00",
    "first_name": "Gareth",
    "updated_at": "2024-10-16T11:10:13+01: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": "2024-10-16T11:10:13+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-10-16T11:10:13+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-10-16T11:10:13+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-10-16T11:10:13+01:00"
  },
  "next_review_date": "2024-10-16T11:10:13+01:00",
  "has_joint_account": true,
  "current_time_entry": {
    "name": "Research",
    "uuid": "79c18406-86f3-4c25-87d6-e0744dccc2ae",
    "end_date": "2024-10-16T11:10:13+01:00",
    "is_active": "1",
    "trackable": "Client",
    "start_date": "2024-10-16T11:10:13+01:00"
  },
  "first_contact_date": "2024-10-16T11:10:13+01:00",
  "external_references": [
    {
      "uuid": "fa08e945-e41b-4dab-b526-864b7a939566",
      "reference": "AB123456",
      "created_at": "2024-10-16T11:10:13+01:00",
      "updated_at": "2024-10-16T11:10:13+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": "5f2b4ef0-71e2-4c4e-ad7f-84e8560bb2b7",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-10-16T11:10:13+01:00",
    "first_name": "Gareth",
    "updated_at": "2024-10-16T11:10:13+01: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": "2024-10-16T11:10:13+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-10-16T11:10:13+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-10-16T11:10:13+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-10-16T11:10:13+01:00"
  },
  "previous_review_date": "2024-10-16T11:10:13+01:00",
  "primary_phone_number": {
    "name": "Work number",
    "type": "phone_number",
    "uuid": "3e8241cf-04cd-481d-b931-c7ea0e598d8a",
    "value": "+443330903630",
    "account": "App\\Http\\Resources\\AccountResource",
    "primary": true,
    "created_at": "2024-10-16T11:10:13+01:00",
    "updated_at": "2024-10-16T11:10:13+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": "f485aa98-286d-4539-88f4-c0616929a979",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-10-16T11:10:13+01:00",
    "first_name": "Gareth",
    "updated_at": "2024-10-16T11:10:13+01: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": "2024-10-16T11:10:13+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-10-16T11:10:13+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-10-16T11:10:13+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-10-16T11:10:13+01:00"
  },
  "anniversary_review_date": "2024-10-16T11:10:13+01:00"
}