Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Query parameters
-
include
string Comma separated list of relationships to include in the response. Valid relationships are [primary_phone_number,primary_email, assigned_adviser, tags, groups].
-
filter[uuid]
string Filter by a comma separated list of UUIDs.
-
filter[name]
string Filter employees by name. This is a partial match against first_name, last_name, and entity_name together.
-
filter[email]
string Filter employees that have an email with a partial match.
-
filter[type]
string Comma separated string to filter by different employee types. Valid types are [owner, admin, member].
-
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[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 employees within the provided groups out from the response.
-
filter[departments]
string Comma separated list of departments the employee is in.
-
filter[include]
string Comma separated list of employee UUIDs that should always be returned no matter what other filters are applied.
-
sort
string Field to sort by. Valid fields are [created_at, updated_at, first_name, last_name, email]. Negative sign to denote DESC. Defaults to 'first_name'.
-
per_page
integer Number of results to return with pagination (Default 15. Max 500).
GET
/api/v1/employee
curl \
--request GET 'https://api.plannrcrm.com/api/v1/employee' \
--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": "2d63ea7a-7097-4173-b793-9bfc7b39c188",
"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-06-22T11:45:31+01:00",
"updated_at": "2025-06-22T11:45:31+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",
"portal_background": "#f6f6f6",
"portal_brand_title": "#323b4b",
"sidebar_background": "#0E0E56",
"portal_sidebar_icon": "#828994",
"portal_sidebar_text": "#323b4b",
"portal_account_email": "#828994",
"portal_sidebar_title": "#11151d",
"sidebar_title_primary": "#FFC634",
"portal_brand_sub_title": "#828994",
"portal_sidebar_divider": "#e3e5e9",
"email_button_background": "#36367E",
"portal_dashboard_bg_one": "#EF4583",
"portal_dashboard_bg_two": "#FFC634",
"sidebar_title_secondary": "#ffffff",
"sidebar_title_background": "#36367E",
"portal_sidebar_icon_hover": "#828994",
"portal_sidebar_text_hover": "#323b4b",
"portal_sidebar_icon_active": "#828994",
"portal_sidebar_text_active": "#323b4b",
"email_logo_background_panel": "#36367E",
"portal_sidebar_button_hover": "#ffffff",
"portal_sidebar_account_title": "#11151d",
"portal_sidebar_button_active": "#ffffff",
"sidebar_title_secondary_hover": "#ffffff",
"portal_sidebar_button_background": "#f6f6f6"
},
"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": "30cf2293-a802-4bdc-8eee-e9da36696739",
"colour": "#ef4582",
"created_at": "2025-06-22T11:45:31+01:00",
"updated_at": "2025-06-22T11:45:31+01:00"
}
],
"type": "client",
"uuid": "55a30fb9-c62b-41d1-88e8-bf34873c86f3",
"email": "gareth@codepotato.co.uk",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "e0d5ad1d-f83d-4363-85ce-b9f8b00a72c1",
"created_at": "2025-06-22T11:45:31+01:00",
"updated_at": "2025-06-22T11:45:31+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "ecf9ad60-89a1-4b37-ac4b-944c279d40f7",
"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": "49623f51-f582-4d78-9c56-da500fd9b923",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:31+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:31+01:00",
"with_login": true,
"inactive_at": "2025-06-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-06-22T11:45:31+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-22T11:45:31+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-06-22T11:45:31+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-22T11:45:31+01:00"
}
],
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:31+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:31+01:00",
"with_login": true,
"inactive_at": "2025-06-22",
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "ed8fea23-5b0a-4ce0-afa9-1b0454cdf829",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-06-22T11:45:31+01:00",
"updated_at": "2025-06-22T11:45:31+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": "c889efce-eb90-4463-814f-a95ac834c112",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:31+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:31+01:00",
"with_login": true,
"inactive_at": "2025-06-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-06-22T11:45:31+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-22T11:45:31+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-06-22T11:45:31+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-22T11:45:31+01:00"
},
"primary_email": {
"name": "Work number",
"type": "phone_number",
"uuid": "765c6021-8b3a-4f32-a56f-b12cbc4c5f59",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-06-22T11:45:31+01:00",
"updated_at": "2025-06-22T11:45:31+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": "796d6a0a-97f2-4025-9fbf-10d53470465b",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:31+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:31+01:00",
"with_login": true,
"inactive_at": "2025-06-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-06-22T11:45:31+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-22T11:45:31+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-06-22T11:45:31+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-22T11:45:31+01:00"
},
"next_review_date": "2025-06-22T11:45:31+01:00",
"has_joint_account": true,
"current_time_entry": {
"name": "Research",
"uuid": "af0a862b-218c-4598-a87a-00417aa6bc32",
"account": "App\\Http\\Resources\\MinimalAccountResource",
"end_date": "2025-06-22T11:23:31+01:00",
"is_active": true,
"trackable": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2025-06-22T11:45:31+01:00",
"start_date": "2025-06-22T10:55:31+01:00",
"updated_at": "2025-06-22T11:45:31+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-06-22T11:45:31+01:00",
"external_references": [
{
"uuid": "3ab6c2c3-a29d-4649-a393-8bdc053ac267",
"reference": "AB123456",
"created_at": "2025-06-22T11:45:31+01:00",
"updated_at": "2025-06-22T11:45:31+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": "2922638b-864a-4580-a9d0-8a400664325e",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:31+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:31+01:00",
"with_login": true,
"inactive_at": "2025-06-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-06-22T11:45:31+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-22T11:45:31+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-06-22T11:45:31+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-22T11:45:31+01:00"
},
"joint_account_circle": {
"name": "Jones Family",
"uuid": "412a3ec0-a851-48f6-913d-1f3842c1ed68",
"groups": "App\\Http\\Resources\\GroupResource",
"accounts": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2025-06-22T11:45:31+01:00",
"updated_at": "2025-06-22T11:45:31+01:00",
"joint_account_uuid": "c178bb3d-a1ca-42da-b567-360fdc4c2ffa"
},
"ownership_percentage": 100,
"previous_review_date": "2025-06-22T11:45:31+01:00",
"primary_phone_number": {
"name": "Work number",
"type": "phone_number",
"uuid": "8c9b910c-45d5-487d-8416-39ef0b48d1fd",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-06-22T11:45:31+01:00",
"updated_at": "2025-06-22T11:45:31+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": "3763409f-8980-46c0-bdb0-13a9eb7627d1",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:31+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:31+01:00",
"with_login": true,
"inactive_at": "2025-06-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-06-22T11:45:31+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-22T11:45:31+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-06-22T11:45:31+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-22T11:45:31+01:00"
},
"anniversary_review_date": "2025-06-22T11:45:31+01:00"
}