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.
-
d514f3eb-cc10-4e08-ac0a-142a79d58596
-
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":"74d78cf6-132f-44ef-9e6d-bc6b9058f1c1","role":"owner","with_login":true,"departments":["paraplanner","adviser"],"groups":["b0f0b2ea-4ff8-4a35-a120-5f11fccd7d8a","558b329a-4512-47bb-a64b-d1a12c028311"],"adviser_split_uuid":"2f09680b-dcd2-4696-bcb5-b9ecac2ad64c","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": "74d78cf6-132f-44ef-9e6d-bc6b9058f1c1",
"role": "owner",
"with_login": true,
"departments": [
"paraplanner",
"adviser"
],
"groups": [
"b0f0b2ea-4ff8-4a35-a120-5f11fccd7d8a",
"558b329a-4512-47bb-a64b-d1a12c028311"
],
"adviser_split_uuid": "2f09680b-dcd2-4696-bcb5-b9ecac2ad64c",
"advice_type": "independent"
}
Response examples (200)
{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "2e866321-8e6a-4d8a-8293-b8415edda4d0",
"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-10-08T10:40:14+01:00",
"updated_at": "2025-10-08T10:40:14+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_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_email": "#828994",
"portal_sidebar_account_title": "#11151d",
"portal_sidebar_button_active": "#ffffff",
"sidebar_title_secondary_hover": "#ffffff",
"portal_sidebar_collapse_button": "#828994",
"portal_sidebar_user_select_text": "#323B4B",
"portal_sidebar_button_background": "#f6f6f6",
"portal_sidebar_user_select_hover": "transparent",
"portal_sidebar_user_select_border": "#EEEEEE",
"portal_sidebar_collapse_button_hover": "#B3B9C4",
"portal_sidebar_user_select_background": "transparent",
"portal_sidebar_user_select_text_hover": "#323B4B",
"portal_sidebar_user_select_border_hover": "#828994"
},
"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": "c9a16099-4da8-4786-9388-dabdabab8801",
"colour": "#ef4582",
"created_at": "2025-10-08T10:40:14+01:00",
"updated_at": "2025-10-08T10:40:14+01:00"
}
],
"type": "client",
"uuid": "bdd94b1f-2093-4f81-bac5-3087f0c7272e",
"email": "gareth@codepotato.co.uk",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "37edc229-4c97-44e4-8397-2b8aef73a29d",
"created_at": "2025-10-08T10:40:14+01:00",
"updated_at": "2025-10-08T10:40:14+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "14640beb-7c8d-47ef-9cde-0f9f8da87b8c",
"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": "a1898b58-9a68-4407-a44e-b63ad5202ff5",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"circles": "App\\Http\\Resources\\CircleResource",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-10-08T10:40:14+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-08T10:40:14+01:00",
"with_login": true,
"inactive_at": "2025-10-08",
"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-10-08T10:40:14+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-10-08T10:40:14+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-10-08T10:40:14+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-10-08T10:40:14+01:00"
}
],
"circles": [
{
"name": "Jones Family",
"uuid": "3a910572-c9aa-4217-91ee-0b4e1b1a3702",
"groups": "App\\Http\\Resources\\GroupResource",
"accounts": "App\\Http\\Resources\\MinimalAccountResource",
"bg_colour": "#35f4e1",
"photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
"created_at": "2025-10-08T10:40:14+01:00",
"updated_at": "2025-10-08T10:40:14+01:00",
"joint_account_uuid": "ed358caa-109e-49b6-81b7-5e4d21574c7f",
"login_access_level": "write",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
}
],
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-10-08T10:40:14+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-08T10:40:14+01:00",
"with_login": true,
"inactive_at": "2025-10-08",
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "1aee1cd7-82cf-40de-9463-89da3ce0ed52",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-10-08T10:40:14+01:00",
"updated_at": "2025-10-08T10:40:14+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": "f51e8612-ea8e-4a78-bb10-9863799d7d62",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"circles": "App\\Http\\Resources\\CircleResource",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-10-08T10:40:14+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-08T10:40:14+01:00",
"with_login": true,
"inactive_at": "2025-10-08",
"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-10-08T10:40:14+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-10-08T10:40:14+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-10-08T10:40:14+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-10-08T10:40:14+01:00"
},
"primary_email": {
"name": "Work number",
"type": "phone_number",
"uuid": "bbe48839-596d-4f43-bd48-5cf905c254b7",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-10-08T10:40:14+01:00",
"updated_at": "2025-10-08T10:40:14+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": "aab304c9-4b6b-4430-b09c-a4ee3461ee9c",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"circles": "App\\Http\\Resources\\CircleResource",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-10-08T10:40:14+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-08T10:40:14+01:00",
"with_login": true,
"inactive_at": "2025-10-08",
"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-10-08T10:40:14+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-10-08T10:40:14+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-10-08T10:40:14+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-10-08T10:40:14+01:00"
},
"next_review_date": "2025-10-08T10:40:14+01:00",
"has_joint_account": true,
"current_time_entry": {
"name": "Research",
"uuid": "b9aced95-11db-467d-8cbb-9d9b13c97ec9",
"account": "App\\Http\\Resources\\MinimalAccountResource",
"end_date": "2025-10-08T10:18:14+01:00",
"is_active": true,
"trackable": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2025-10-08T10:40:14+01:00",
"start_date": "2025-10-08T09:50:14+01:00",
"updated_at": "2025-10-08T10:40:14+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-10-08T10:40:14+01:00",
"external_references": [
{
"uuid": "365294cb-cce2-4bc3-8eea-631916849ee5",
"reference": "AB123456",
"created_at": "2025-10-08T10:40:14+01:00",
"updated_at": "2025-10-08T10:40:14+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": "c7af00ad-b146-4ebe-9c3e-84cf6280f03d",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"circles": "App\\Http\\Resources\\CircleResource",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-10-08T10:40:14+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-08T10:40:14+01:00",
"with_login": true,
"inactive_at": "2025-10-08",
"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-10-08T10:40:14+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-10-08T10:40:14+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-10-08T10:40:14+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-10-08T10:40:14+01:00"
},
"joint_account_circle": {
"name": "Jones Family",
"uuid": "a255fbde-d41a-47f4-a949-abafb1990bec",
"groups": "App\\Http\\Resources\\GroupResource",
"accounts": "App\\Http\\Resources\\MinimalAccountResource",
"bg_colour": "#35f4e1",
"photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
"created_at": "2025-10-08T10:40:14+01:00",
"updated_at": "2025-10-08T10:40:14+01:00",
"joint_account_uuid": "60ec543d-4b05-403c-8bd1-adae7bfa2757",
"login_access_level": "write",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"ownership_percentage": 100,
"previous_review_date": "2025-10-08T10:40:14+01:00",
"primary_phone_number": {
"name": "Work number",
"type": "phone_number",
"uuid": "e365977d-43e2-4fdb-a352-76014b29c69f",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-10-08T10:40:14+01:00",
"updated_at": "2025-10-08T10:40:14+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": "3373ea54-2d30-4fc2-a8ee-ddb70104fb0d",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"circles": "App\\Http\\Resources\\CircleResource",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-10-08T10:40:14+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-08T10:40:14+01:00",
"with_login": true,
"inactive_at": "2025-10-08",
"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-10-08T10:40:14+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-10-08T10:40:14+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-10-08T10:40:14+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-10-08T10:40:14+01:00"
},
"anniversary_review_date": "2025-10-08T10:40:14+01:00"
}