Create an employee [DEPRECATED: Use create an account route] Run in API Explorer
Ask AI
Body
-
The first name of the employee.
-
The last name of the employee.
-
The email of the employee. Required when with_login is present.
-
Uuid of the assigned adviser
-
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
Value Description independent Independent restricted Restricted Values are
independentorrestricted.
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":"c29fb71f-8ac2-4171-ba84-732687320574","role":"owner","with_login":true,"departments":["paraplanner","adviser"],"groups":["8efdb7fd-00de-48e6-b8f9-586ce0da56cd","e5f636cc-d0fc-495f-a720-21e13338b505","2ed7acb7-787c-478e-b1ee-87debcdd1b6b"],"adviser_split_uuid":"bedd7be4-85ec-4ad8-a8ec-5954753e5080","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": "c29fb71f-8ac2-4171-ba84-732687320574",
"role": "owner",
"with_login": true,
"departments": [
"paraplanner",
"adviser"
],
"groups": [
"8efdb7fd-00de-48e6-b8f9-586ce0da56cd",
"e5f636cc-d0fc-495f-a720-21e13338b505",
"2ed7acb7-787c-478e-b1ee-87debcdd1b6b"
],
"adviser_split_uuid": "bedd7be4-85ec-4ad8-a8ec-5954753e5080",
"advice_type": "independent"
}
Response examples (200)
{
"uuid": "35dfb40e-39b9-45d9-813b-6313b4324e93",
"created_at": "2026-04-30T17:33:15+01:00",
"updated_at": "2026-04-30T17:33:15+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"firm": {
"uuid": "77fd95fa-d598-4b36-9287-3c9207cc8b42",
"created_at": "2026-04-30T17:33:15+01:00",
"updated_at": "2026-04-30T17:33:15+01:00",
"name": "Codepotato",
"slug": "codepotato",
"address_1": "Suite E, 5 The Briars",
"address_2": "Waterberry Drive",
"town_city": "Waterlooville",
"county": "Hampshire",
"postcode": "PO7 7YH",
"country": "United Kingdom",
"regulatory_text": "Regulatory text",
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
"brand_colours": {
"sidebar_background": "#0E0E56",
"sidebar_accent": "#36367E",
"sidebar_text": "#FFFFFF",
"sidebar_hover": "#0A0A42",
"sidebar_active": "#53DBB8",
"sidebar_title_background": "#36367E",
"sidebar_title_primary": "#FFC634",
"sidebar_title_secondary": "#FFFFFF",
"sidebar_title_secondary_hover": "#FFFFFF",
"email_background": "#0E0E56",
"email_logo_background_panel": "#36367E",
"email_sub_text": "#FFFFFF",
"email_button_background": "#36367E",
"email_button_text": "#FFFFFF",
"portal_sidebar_button_background": "#F6F6F6",
"portal_sidebar_button_hover": "#FFFFFF",
"portal_sidebar_button_active": "#FFFFFF",
"portal_brand_title": "#323B4B",
"portal_brand_sub_title": "#828994",
"portal_sidebar_title": "#11151D",
"portal_sidebar_text": "#323B4B",
"portal_sidebar_text_hover": "#323B4B",
"portal_sidebar_text_active": "#323B4B",
"portal_sidebar_icon": "#828994",
"portal_sidebar_icon_hover": "#828994",
"portal_sidebar_icon_active": "#828994",
"portal_background": "#F6F6F6",
"portal_sidebar_account_title": "#11151D",
"portal_sidebar_account_email": "#828994",
"portal_sidebar_divider": "#E3E5E9",
"portal_dashboard_bg_one": "#EF4583",
"portal_dashboard_bg_two": "#FFC634",
"portal_sidebar_collapse_button": "#828994",
"portal_sidebar_collapse_button_hover": "#B3B9C4",
"portal_sidebar_user_select_background": "#F6F6F6",
"portal_sidebar_user_select_hover": "#F6F6F6",
"portal_sidebar_user_select_text": "#323B4B",
"portal_sidebar_user_select_text_hover": "#323B4B",
"portal_sidebar_user_select_border": "#EEEEEE",
"portal_sidebar_user_select_border_hover": "#828994"
},
"is_subscribed": true,
"addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
"keep_deleted_files_for": 30,
"tax": 17.5,
"month_end": 25,
"statement_frequency": "monthly",
"billing": {
"invoice_address_1": "Suite E, 5 The Briars",
"invoice_address_2": "Waterberry Drive",
"invoice_town_city": "Waterlooville",
"invoice_county": "Hampshire",
"invoice_postcode": "PO7 7YH",
"invoice_country": "United Kingdom",
"invoice_email": "gareth@codepotato.co.uk"
},
"task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
"ip_whitelist": [
"192.168.0.1",
"127.0.0.1"
],
"welcome_paragraph_html": "<h1>Welcome.</h1>",
"email_welcome_paragraph_html": "Welcome to Plannr!",
"show_fact_find_illustrations": true,
"cc_email_addresses": [
"jack@example.com",
"jill@example.com"
],
"bcc_email_addresses": [
"jack@example.com",
"jill@example.com"
],
"reply_to_email_address": "jack@example.com",
"mobile_app_support_number": "01234 567890",
"mobile_app_support_email": "support@example.com"
},
"primary_phone_number": {
"uuid": "54f21cfe-db2d-459c-90bd-bb376ea07708",
"created_at": "2026-04-30T17:33:15+01:00",
"updated_at": "2026-04-30T17:33:15+01:00",
"type": "phone_number",
"name": "Work number",
"value": "+443330903630",
"phone_number_meta": {
"country": "GB",
"formatted": "0333 090 3630"
},
"accounts": "App\\Http\\Resources\\AccountResource"
},
"primary_email": {
"uuid": "328e7619-a57d-476b-a98e-e2a1af63f598",
"created_at": "2026-04-30T17:33:15+01:00",
"updated_at": "2026-04-30T17:33:15+01:00",
"type": "phone_number",
"name": "Work number",
"value": "+443330903630",
"phone_number_meta": {
"country": "GB",
"formatted": "0333 090 3630"
},
"accounts": "App\\Http\\Resources\\AccountResource"
},
"current_time_entry": {
"uuid": "6f68a2e6-c077-49e9-8810-dabd3c69158c",
"created_at": "2026-04-30T17:33:15+01:00",
"updated_at": "2026-04-30T17:33:15+01:00",
"name": "Research",
"description": "This is a description.",
"trackable_type": "Client",
"trackable": "App\\Http\\Resources\\MinimalAccountResource",
"start_date": "2026-04-30T16:43:15+01:00",
"end_date": "2026-04-30T17:11:15+01:00",
"is_active": true,
"total_time_in_minutes": 28,
"computed_time_elapsed_in_seconds": 1680,
"account": "App\\Http\\Resources\\MinimalAccountResource"
},
"assigned_adviser": {
"uuid": "568264bd-4593-4732-a314-4ef1b1644b82",
"created_at": "2026-04-30T17:33:15+01:00",
"updated_at": "2026-04-30T17:33:15+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"firm": "App\\Http\\Resources\\FirmResource",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"business_unit": "App\\Http\\Resources\\BusinessUnitResource",
"groups": "App\\Http\\Resources\\GroupResource",
"tags": "App\\Http\\Resources\\TagResource",
"owners": "App\\Http\\Resources\\AccountResource",
"first_contact_date": "2026-04-30T17:33:15+01:00",
"next_review_date": "2026-04-30T17:33:15+01:00",
"previous_review_date": "2026-04-30T17:33:15+01:00",
"anniversary_review_date": "2026-04-30T17:33:15+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"circles": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"inactive_at": "2026-04-30",
"last_interaction_at": "2026-04-30 17:33:15",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"assigned_administrator": {
"uuid": "4fe1baf4-e4a8-4a05-ae45-fc3cba82cf6f",
"created_at": "2026-04-30T17:33:15+01:00",
"updated_at": "2026-04-30T17:33:15+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"firm": "App\\Http\\Resources\\FirmResource",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"business_unit": "App\\Http\\Resources\\BusinessUnitResource",
"groups": "App\\Http\\Resources\\GroupResource",
"tags": "App\\Http\\Resources\\TagResource",
"owners": "App\\Http\\Resources\\AccountResource",
"first_contact_date": "2026-04-30T17:33:15+01:00",
"next_review_date": "2026-04-30T17:33:15+01:00",
"previous_review_date": "2026-04-30T17:33:15+01:00",
"anniversary_review_date": "2026-04-30T17:33:15+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"circles": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"inactive_at": "2026-04-30",
"last_interaction_at": "2026-04-30 17:33:15",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"assigned_paraplanner": {
"uuid": "8b023beb-93f7-4920-964b-77b17e2f046d",
"created_at": "2026-04-30T17:33:15+01:00",
"updated_at": "2026-04-30T17:33:15+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"firm": "App\\Http\\Resources\\FirmResource",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"business_unit": "App\\Http\\Resources\\BusinessUnitResource",
"groups": "App\\Http\\Resources\\GroupResource",
"tags": "App\\Http\\Resources\\TagResource",
"owners": "App\\Http\\Resources\\AccountResource",
"first_contact_date": "2026-04-30T17:33:15+01:00",
"next_review_date": "2026-04-30T17:33:15+01:00",
"previous_review_date": "2026-04-30T17:33:15+01:00",
"anniversary_review_date": "2026-04-30T17:33:15+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"circles": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"inactive_at": "2026-04-30",
"last_interaction_at": "2026-04-30 17:33:15",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"introduced_by": {
"uuid": "6e28cf0e-f7d7-4ba6-a7cd-9caffd752d10",
"created_at": "2026-04-30T17:33:15+01:00",
"updated_at": "2026-04-30T17:33:15+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"firm": "App\\Http\\Resources\\FirmResource",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"business_unit": "App\\Http\\Resources\\BusinessUnitResource",
"groups": "App\\Http\\Resources\\GroupResource",
"tags": "App\\Http\\Resources\\TagResource",
"owners": "App\\Http\\Resources\\AccountResource",
"first_contact_date": "2026-04-30T17:33:15+01:00",
"next_review_date": "2026-04-30T17:33:15+01:00",
"previous_review_date": "2026-04-30T17:33:15+01:00",
"anniversary_review_date": "2026-04-30T17:33:15+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"circles": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"inactive_at": "2026-04-30",
"last_interaction_at": "2026-04-30 17:33:15",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"business_unit": {
"uuid": "e1600a3c-40c2-43b5-8f60-35bbd5dccf13",
"name": "Wealth Management",
"has_alternative_branding": false,
"brand_colours": [],
"members_count": 3,
"members": "App\\Http\\Resources\\AccountResource",
"groups_count": 2,
"groups": "App\\Http\\Resources\\GroupResource",
"firm": "App\\Http\\Resources\\FirmResource",
"created_at": "2026-04-30T17:33:15+01:00",
"updated_at": "2026-04-30T17:33:15+01:00"
},
"groups": [
{
"uuid": "db38aa84-c29f-4816-8117-db37c0f68bcb",
"name": "finance",
"slug": "finance",
"participants_count": "3",
"participants": {
"uuid": {
"example": "ed5bbd02-d4cc-448f-87b8-afbb31940c4c",
"description": "UUID of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"first_name": {
"example": "Gareth",
"description": "First name of the account"
},
"last_name": {
"example": "Thompson",
"description": "Last name of the account"
},
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"email": {
"example": "gareth@codepotato.co.uk",
"description": "Email of the account"
}
},
"created_at": "2026-04-30T17:33:15+01:00",
"updated_at": "2026-04-30T17:33:15+01:00"
}
],
"tags": [
{
"uuid": "384680fd-df5d-4bc1-b285-24b2e52ff71c",
"created_at": "2026-04-30T17:33:15+01:00",
"updated_at": "2026-04-30T17:33:15+01:00",
"name": "Mortgage",
"slug": "mortgage",
"colour": "#ef4582"
}
],
"owners": [
{
"uuid": "1be4d139-eb23-4ff9-8401-932370824677",
"created_at": "2026-04-30T17:33:15+01:00",
"updated_at": "2026-04-30T17:33:15+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"firm": "App\\Http\\Resources\\FirmResource",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"business_unit": "App\\Http\\Resources\\BusinessUnitResource",
"groups": "App\\Http\\Resources\\GroupResource",
"tags": "App\\Http\\Resources\\TagResource",
"owners": "App\\Http\\Resources\\AccountResource",
"first_contact_date": "2026-04-30T17:33:15+01:00",
"next_review_date": "2026-04-30T17:33:15+01:00",
"previous_review_date": "2026-04-30T17:33:15+01:00",
"anniversary_review_date": "2026-04-30T17:33:15+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"circles": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"inactive_at": "2026-04-30",
"last_interaction_at": "2026-04-30 17:33:15",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
}
],
"first_contact_date": "2026-04-30T17:33:15+01:00",
"next_review_date": "2026-04-30T17:33:15+01:00",
"previous_review_date": "2026-04-30T17:33:15+01:00",
"anniversary_review_date": "2026-04-30T17:33:15+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"joint_account_circle": {
"uuid": "14977a25-ae27-4508-aa0f-df25644c95ae",
"created_at": "2026-04-30T17:33:15+01:00",
"updated_at": "2026-04-30T17:33:15+01:00",
"name": "Jones Family",
"photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
"bg_colour": "#35f4e1",
"accounts": "App\\Http\\Resources\\AccountResource",
"groups": "App\\Http\\Resources\\GroupResource",
"joint_account_uuid": "9c55a202-c8f8-4e1d-9912-8195a43fdf37",
"login_access_level": "write",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"circles": [
{
"uuid": "12071b33-622c-4d13-bf6e-5915a92444d7",
"created_at": "2026-04-30T17:33:15+01:00",
"updated_at": "2026-04-30T17:33:15+01:00",
"name": "Jones Family",
"photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
"bg_colour": "#35f4e1",
"accounts": "App\\Http\\Resources\\AccountResource",
"groups": "App\\Http\\Resources\\GroupResource",
"joint_account_uuid": "93568382-050d-4bb2-b00a-7f2a69be6617",
"login_access_level": "write",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
}
],
"ownership_percentage": 100,
"inactive_at": "2026-04-30",
"last_interaction_at": "2026-04-30 17:33:15",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": [
{
"uuid": "e1b69a5f-da80-4e22-9abd-1768b8cb5038",
"created_at": "2026-04-30T17:33:15+01:00",
"updated_at": "2026-04-30T17:33:15+01:00",
"type": "string",
"name": "Favourite Drink",
"reference": "favourite_drink",
"is_required": false,
"value": "Coffee",
"selection_options": [
"Coffee",
"Tea",
"Water"
],
"help_text": "This is the client's favourite drink."
}
],
"external_references": [
{
"uuid": "e13619c1-839c-4ddc-9a65-6ea01fcec5dd",
"created_at": "2026-04-30T17:33:15+01:00",
"updated_at": "2026-04-30T17:33:15+01:00",
"third_party": "nucleus",
"reference": "AB123456"
}
]
}