Get all accounts

GET /api/v1/account

Headers

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, 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[custom_field:REFERENCE] string

Filter by a accounts 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[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
filter[assigned_adviser_uuids] boolean

Filter accounts who have the provided adviser account UUIDs
filter[assigned_administrator_uuids] boolean

Filter accounts who have the provided administrator account UUIDs
filter[assigned_paraplanner_uuids] boolean

Filter accounts who have the provided paraplanner account UUIDs
per_page integer

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

Responses

200 application/json
Hide response attribute Show response attribute object
- data array[object]

GET /api/v1/account

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

{
  "data": [
    {
      "firm": {
        "tax": 17.5,
        "logo": "https://api.plannrcrm.com/images/plannr.jpg",
        "name": "Codepotato",
        "slug": "codepotato",
        "uuid": "f279aba6-5497-4a43-a6eb-02cd45c1ba2b",
        "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": "4fc25376-20b1-4206-abe6-4d56920fd657",
          "colour": "#ef4582",
          "created_at": "2024-10-16T11:10:13+01:00",
          "updated_at": "2024-10-16T11:10:13+01:00"
        }
      ],
      "type": "client",
      "uuid": "53955477-ce35-4f32-8dbb-a08f86a17f97",
      "email": "gareth@codepotato.co.uk",
      "groups": [
        {
          "name": "finance",
          "slug": "finance",
          "uuid": "afdab161-7bda-47a6-abb6-268e4981a59a",
          "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": "08108537-13a0-4925-bfd6-20971390a0c1",
              "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": "fb6e8796-8c76-4fc8-ab71-8891a8b06f79",
          "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": "2209306d-ae74-457d-8ba2-057ad1efb6a2",
          "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": "2f6e77b5-fa4a-46bb-a7a3-63fe11861340",
        "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": "1b4f9f4b-4f75-4629-883e-0faed2a57548",
        "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": "d1f4b10e-4ad7-4dd0-afc8-396620748dcf",
        "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": "35a9aa92-cee8-47d2-83d2-eba1ae92599d",
        "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": "c2403dce-2ba1-4543-828e-aacaaa179f36",
          "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": "4fa011cb-ae7a-4330-b129-cfb9976b4c3e",
        "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": "87aa300e-0bf3-4e43-99eb-ca21b84a748e",
        "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": "b4371029-1578-42c6-85d0-a86e26947839",
        "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"
    }
  ]
}