# Get all accounts

**GET /api/v1/account**




## Servers
- https://api.plannrcrm.com: https://api.plannrcrm.com ()


## Authentication methods
- Personal access token & O auth2


## Parameters
### Headers
- **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, status_changed_at]. 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[uuid]** (string)
  Filter accounts by a comma separated list of account UUIDs.
- **filter[exclude_uuid]** (string)
  Exclude accounts by a comma separated list of account UUIDs.
- **filter[name]** (string)
  Filter accounts by name. This is a partial match against first_name, last_name, and entity_name together.
- **filter[ni_number]** (string)
  Comma separated list of partial National Insurance Numbers to filter by.
- **filter[date_of_birth]** (string)
  Filter by date of birth with an operator.
- **filter[email]** (string)
  Filter accounts that have an email with a partial match.
- **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[status_changed_at_from]** (string)
  Date to filter accounts by when their status was changed from.
- **filter[status_changed_at_to]** (string)
  Date to filter accounts by when their status was changed fup until.
- **filter[is_prospect]** (boolean)
  Get accounts with this is_prospect value
- **filter[is_child]** (string)
  affects whether to include accounts based on the child account flag. Valid options are "exclude", "include", "only". (default: "include")
- **filter[inactive_after]** (string)
  Get accounts set to inactive after this date
- **filter[inactive_before]** (string)
  Get accounts set to inactive before this date
- **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.
- **filter[created_before]** (string)
  Date to filter when the accounts was created before.
- **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[circle_uuids]** (string)
  Comma separated list of circle 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]** (string)
  Comma separated list of UUIDS to filter accounts who have the provided adviser account UUIDs
- **filter[assigned_administrator_uuids]** (string)
  Comma separated list of UUIDS to filter accounts who have the provided administrator account UUIDs
- **filter[assigned_paraplanner_uuids]** (string)
  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).


## Responses
### 200


#### Body: application/json (object)
- **data** (array[object])



[Powered by Bump.sh](https://bump.sh)