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":"d59af2cb-4a67-4edd-8de9-1deeaa01f772","role":"owner","with_login":true,"departments":["paraplanner","adviser"],"groups":["351eff51-04de-49db-ba4b-ce7cc5c6e651","d58e3fda-2517-4e83-86e1-3b766de9f698","64bfc554-a224-4a35-813e-8bf5e96ac887"],"adviser_split_uuid":"fd66d973-3193-4e5f-8ab7-fbcf54ed7bcf","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": "d59af2cb-4a67-4edd-8de9-1deeaa01f772",
"role": "owner",
"with_login": true,
"departments": [
"paraplanner",
"adviser"
],
"groups": [
"351eff51-04de-49db-ba4b-ce7cc5c6e651",
"d58e3fda-2517-4e83-86e1-3b766de9f698",
"64bfc554-a224-4a35-813e-8bf5e96ac887"
],
"adviser_split_uuid": "fd66d973-3193-4e5f-8ab7-fbcf54ed7bcf",
"advice_type": "independent"
}
Response examples (200)
{
"uuid": "1cadf6be-6510-42c2-a991-8f15ac64bbf6",
"created_at": "2026-06-09T14:10:13+01:00",
"updated_at": "2026-06-09T14:10:13+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": "d08b07a8-f4ac-4e0c-9e7c-3d83130c48de",
"created_at": "2026-06-09T14:10:13+01:00",
"updated_at": "2026-06-09T14:10:13+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": "30e5f678-141b-4334-9569-2f00a2d66e24",
"created_at": "2026-06-09T14:10:13+01:00",
"updated_at": "2026-06-09T14:10:13+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": "018e406a-6749-4c9e-95ea-49e3f3cff7e1",
"created_at": "2026-06-09T14:10:13+01:00",
"updated_at": "2026-06-09T14:10:13+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": "53696bbf-4e3a-42f1-ab46-d7063ed81d95",
"created_at": "2026-06-09T14:10:13+01:00",
"updated_at": "2026-06-09T14:10:13+01:00",
"name": "Research",
"description": "This is a description.",
"trackable_type": "Client",
"trackable": "App\\Http\\Resources\\MinimalAccountResource",
"start_date": "2026-06-09T13:20:13+01:00",
"end_date": "2026-06-09T13:48:13+01:00",
"is_active": true,
"total_time_in_minutes": 28,
"computed_time_elapsed_in_seconds": 1680,
"account": "App\\Http\\Resources\\MinimalAccountResource"
},
"assigned_adviser": {
"uuid": "71d80128-cc3d-4159-9b9a-90028c2e7e07",
"created_at": "2026-06-09T14:10:13+01:00",
"updated_at": "2026-06-09T14:10:13+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-06-09T14:10:13+01:00",
"next_review_date": "2026-06-09T14:10:13+01:00",
"previous_review_date": "2026-06-09T14:10:13+01:00",
"anniversary_review_date": "2026-06-09T14:10:13+01:00",
"terms_of_business_at": "2026-06-09T14:10:13+01:00",
"client_agreement_at": "2026-06-09T14:10:13+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-06-09",
"last_interaction_at": "2026-06-09 14:10:13",
"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": "4036e9e5-9319-4b5a-a5a9-8d17c81a632c",
"created_at": "2026-06-09T14:10:13+01:00",
"updated_at": "2026-06-09T14:10:13+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-06-09T14:10:13+01:00",
"next_review_date": "2026-06-09T14:10:13+01:00",
"previous_review_date": "2026-06-09T14:10:13+01:00",
"anniversary_review_date": "2026-06-09T14:10:13+01:00",
"terms_of_business_at": "2026-06-09T14:10:13+01:00",
"client_agreement_at": "2026-06-09T14:10:13+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-06-09",
"last_interaction_at": "2026-06-09 14:10:13",
"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": "8a4c84a2-691d-4feb-a5ec-76022bce67da",
"created_at": "2026-06-09T14:10:13+01:00",
"updated_at": "2026-06-09T14:10:13+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-06-09T14:10:13+01:00",
"next_review_date": "2026-06-09T14:10:13+01:00",
"previous_review_date": "2026-06-09T14:10:13+01:00",
"anniversary_review_date": "2026-06-09T14:10:13+01:00",
"terms_of_business_at": "2026-06-09T14:10:13+01:00",
"client_agreement_at": "2026-06-09T14:10:13+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-06-09",
"last_interaction_at": "2026-06-09 14:10:13",
"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": "a3931760-c7a3-4cf8-a812-d01556c28c65",
"created_at": "2026-06-09T14:10:13+01:00",
"updated_at": "2026-06-09T14:10:13+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-06-09T14:10:13+01:00",
"next_review_date": "2026-06-09T14:10:13+01:00",
"previous_review_date": "2026-06-09T14:10:13+01:00",
"anniversary_review_date": "2026-06-09T14:10:13+01:00",
"terms_of_business_at": "2026-06-09T14:10:13+01:00",
"client_agreement_at": "2026-06-09T14:10:13+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-06-09",
"last_interaction_at": "2026-06-09 14:10:13",
"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": "000b8240-9e58-478f-97c3-729e6fc2d1f1",
"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-06-09T14:10:13+01:00",
"updated_at": "2026-06-09T14:10:13+01:00"
},
"groups": [
{
"uuid": "97bfa252-1d12-4d4f-a03a-84afe0f847eb",
"name": "finance",
"slug": "finance",
"participants_count": "3",
"participants": {
"uuid": {
"example": "acff3b2e-22dd-40a0-ac45-078e4f108645",
"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-06-09T14:10:13+01:00",
"updated_at": "2026-06-09T14:10:13+01:00"
}
],
"tags": [
{
"uuid": "0227d804-ef1c-4293-883e-8868ac08d889",
"created_at": "2026-06-09T14:10:13+01:00",
"updated_at": "2026-06-09T14:10:13+01:00",
"name": "Mortgage",
"slug": "mortgage",
"colour": "#ef4582"
}
],
"owners": [
{
"uuid": "8539f68f-43f2-47d8-80b7-7097e2be7378",
"created_at": "2026-06-09T14:10:13+01:00",
"updated_at": "2026-06-09T14:10:13+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-06-09T14:10:13+01:00",
"next_review_date": "2026-06-09T14:10:13+01:00",
"previous_review_date": "2026-06-09T14:10:13+01:00",
"anniversary_review_date": "2026-06-09T14:10:13+01:00",
"terms_of_business_at": "2026-06-09T14:10:13+01:00",
"client_agreement_at": "2026-06-09T14:10:13+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-06-09",
"last_interaction_at": "2026-06-09 14:10:13",
"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-06-09T14:10:13+01:00",
"next_review_date": "2026-06-09T14:10:13+01:00",
"previous_review_date": "2026-06-09T14:10:13+01:00",
"anniversary_review_date": "2026-06-09T14:10:13+01:00",
"terms_of_business_at": "2026-06-09T14:10:13+01:00",
"client_agreement_at": "2026-06-09T14:10:13+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"joint_account_circle": {
"uuid": "b4ee5bc9-222e-4d9a-950d-575ecae8c668",
"created_at": "2026-06-09T14:10:13+01:00",
"updated_at": "2026-06-09T14:10:13+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": "4d487c04-8c6f-4516-9868-25d486535d24",
"login_access_level": "write",
"current_life_stage_uuid": "d38a6a93-5a35-4aa2-b88d-48a171f29016",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"circles": [
{
"uuid": "dc89e01f-e170-4598-8825-1faae3eecc04",
"created_at": "2026-06-09T14:10:13+01:00",
"updated_at": "2026-06-09T14:10:13+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": "66709113-8acb-4191-9141-60e4cfc5e15f",
"login_access_level": "write",
"current_life_stage_uuid": "44717fa3-004c-496c-b25d-9ef865223da4",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
}
],
"ownership_percentage": 100,
"inactive_at": "2026-06-09",
"last_interaction_at": "2026-06-09 14:10:13",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": [
{
"uuid": "c3b1ad2b-9986-4801-889c-b2e94b0538a9",
"created_at": "2026-06-09T14:10:13+01:00",
"updated_at": "2026-06-09T14:10:13+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": "b9f0e9c7-32d0-4f1e-adf2-dfcd619ad6e4",
"created_at": "2026-06-09T14:10:13+01:00",
"updated_at": "2026-06-09T14:10:13+01:00",
"third_party": "nucleus",
"reference": "AB123456"
}
]
}