Body
Required
-
The first name of the employee.
-
The last name of the employee.
-
The email of the employee. Required when with_login is present.
-
77e7b99a-31ab-4a57-8908-4ebb4b10b3b9
-
The role of the employee.
-
Denotes if the employee needs a billable login.
-
The departments the employee is part of
-
Group uuids belonging to the firm.
-
The uuid of the the adviser split that will be applied when this adviser adds charges
-
Employee's RMAR advice type
POST
/api/v1/employee
curl \
--request POST 'https://api.plannrcrm.com/api/v1/employee' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"first_name":"Gareth","last_name":"Thompson","email":"gareth.thompson@plannrcrm.com","assigned_adviser_uuid":"175f417e-1a7d-4cd6-90d4-f0baff7bb1f2","role":"owner","with_login":true,"departments":["paraplanner","adviser"],"groups":["573a1867-d14d-42c4-a654-a18f6bd5260b","452e66ca-e740-4a73-a316-b1f87f740280"],"adviser_split_uuid":"aca6b3d3-d43d-429f-b8ff-e8fce1c70132","advice_type":"independent"}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"first_name": "Gareth",
"last_name": "Thompson",
"email": "gareth.thompson@plannrcrm.com",
"assigned_adviser_uuid": "175f417e-1a7d-4cd6-90d4-f0baff7bb1f2",
"role": "owner",
"with_login": true,
"departments": [
"paraplanner",
"adviser"
],
"groups": [
"573a1867-d14d-42c4-a654-a18f6bd5260b",
"452e66ca-e740-4a73-a316-b1f87f740280"
],
"adviser_split_uuid": "aca6b3d3-d43d-429f-b8ff-e8fce1c70132",
"advice_type": "independent"
}
Response examples (200)
{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "0fe160b1-a388-4e6d-b723-7387abe4941d",
"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-26T11:37:03+01:00",
"updated_at": "2025-06-26T11:37:03+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": "6d79731f-50fd-40a1-8956-6cf21552eb39",
"colour": "#ef4582",
"created_at": "2025-06-26T11:37:03+01:00",
"updated_at": "2025-06-26T11:37:03+01:00"
}
],
"type": "client",
"uuid": "a80fd1d1-2c42-4dde-88ca-8b6835a8b88d",
"email": "gareth@codepotato.co.uk",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "1f9ea995-4c0b-4abf-87ec-6f67984737de",
"created_at": "2025-06-26T11:37:03+01:00",
"updated_at": "2025-06-26T11:37:03+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "cdc66813-2292-4f93-9d53-d0df5c97e435",
"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": "5f0da46e-f7c0-47a7-83d9-cf307e81061b",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-26T11:37:03+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-26T11:37:03+01:00",
"with_login": true,
"inactive_at": "2025-06-26",
"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-26T11:37:03+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-26T11:37:03+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-26T11:37:03+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-26T11:37:03+01:00"
}
],
"last_name": "Thompson",
"created_at": "2025-06-26T11:37:03+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-26T11:37:03+01:00",
"with_login": true,
"inactive_at": "2025-06-26",
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "8255afd2-3073-4091-9285-f93961be9d2d",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-06-26T11:37:03+01:00",
"updated_at": "2025-06-26T11:37:03+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": "b9dfc094-132a-4997-b358-93f76822b50c",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-26T11:37:03+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-26T11:37:03+01:00",
"with_login": true,
"inactive_at": "2025-06-26",
"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-26T11:37:03+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-26T11:37:03+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-26T11:37:03+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-26T11:37:03+01:00"
},
"primary_email": {
"name": "Work number",
"type": "phone_number",
"uuid": "14ce26c8-f755-407e-b1f2-662336d8e9bd",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-06-26T11:37:03+01:00",
"updated_at": "2025-06-26T11:37:03+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": "d2500de9-4a9a-4b55-ae5e-6c341cde9e03",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-26T11:37:03+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-26T11:37:03+01:00",
"with_login": true,
"inactive_at": "2025-06-26",
"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-26T11:37:03+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-26T11:37:03+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-26T11:37:03+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-26T11:37:03+01:00"
},
"next_review_date": "2025-06-26T11:37:03+01:00",
"has_joint_account": true,
"current_time_entry": {
"name": "Research",
"uuid": "08ddfbdf-4967-4d86-8a53-7dc1800fc638",
"account": "App\\Http\\Resources\\MinimalAccountResource",
"end_date": "2025-06-26T11:15:03+01:00",
"is_active": true,
"trackable": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2025-06-26T11:37:03+01:00",
"start_date": "2025-06-26T10:47:03+01:00",
"updated_at": "2025-06-26T11:37:03+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-26T11:37:03+01:00",
"external_references": [
{
"uuid": "0e7ab56d-d00f-4b85-8be4-83b11af7685f",
"reference": "AB123456",
"created_at": "2025-06-26T11:37:03+01:00",
"updated_at": "2025-06-26T11:37:03+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": "880da09f-23b4-4c4d-b60d-7b3a1abd855f",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-26T11:37:03+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-26T11:37:03+01:00",
"with_login": true,
"inactive_at": "2025-06-26",
"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-26T11:37:03+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-26T11:37:03+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-26T11:37:03+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-26T11:37:03+01:00"
},
"joint_account_circle": {
"name": "Jones Family",
"uuid": "4e506677-b49c-4f72-9024-3b8b401bc7c2",
"groups": "App\\Http\\Resources\\GroupResource",
"accounts": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2025-06-26T11:37:03+01:00",
"updated_at": "2025-06-26T11:37:03+01:00",
"joint_account_uuid": "26c581e3-873f-4af1-9c07-82ab63d4c1d9"
},
"ownership_percentage": 100,
"previous_review_date": "2025-06-26T11:37:03+01:00",
"primary_phone_number": {
"name": "Work number",
"type": "phone_number",
"uuid": "109656bd-35e8-4dc0-819e-f4d9fa7b367d",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-06-26T11:37:03+01:00",
"updated_at": "2025-06-26T11:37:03+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": "c1fee469-0fd8-4a70-adf5-24c9a2e1cfbd",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-26T11:37:03+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-26T11:37:03+01:00",
"with_login": true,
"inactive_at": "2025-06-26",
"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-26T11:37:03+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-26T11:37:03+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-26T11:37:03+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-26T11:37:03+01:00"
},
"anniversary_review_date": "2025-06-26T11:37:03+01:00"
}