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":"daa8803d-9d38-425e-b72e-dade5397d0c6","role":"owner","with_login":true,"departments":["paraplanner","adviser"],"groups":["c279e2ed-2716-423a-bf54-e230fe1b1289","6b884dc9-cb10-4cd7-b77d-cf6e3b94c5c3","99ef7fe8-c996-4e31-89ba-9030ce74f747"],"adviser_split_uuid":"ec6f44ba-1cd4-48ae-963d-7f09d7039caf","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": "daa8803d-9d38-425e-b72e-dade5397d0c6",
"role": "owner",
"with_login": true,
"departments": [
"paraplanner",
"adviser"
],
"groups": [
"c279e2ed-2716-423a-bf54-e230fe1b1289",
"6b884dc9-cb10-4cd7-b77d-cf6e3b94c5c3",
"99ef7fe8-c996-4e31-89ba-9030ce74f747"
],
"adviser_split_uuid": "ec6f44ba-1cd4-48ae-963d-7f09d7039caf",
"advice_type": "independent"
}
Response examples (200)
{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "d31bab92-44fb-44ac-a047-5e2160fca4aa",
"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": "2026-04-09T17:35:05+01:00",
"updated_at": "2026-04-09T17:35:05+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": "#F6F6F6",
"portal_sidebar_user_select_border": "#EEEEEE",
"portal_sidebar_collapse_button_hover": "#B3B9C4",
"portal_sidebar_user_select_background": "#F6F6F6",
"portal_sidebar_user_select_text_hover": "#323B4B",
"portal_sidebar_user_select_border_hover": "#828994"
},
"is_subscribed": true,
"regulatory_text": "Regulatory text",
"cc_email_addresses": [
"jack@example.com",
"jill@example.com"
],
"addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
"bcc_email_addresses": [
"jack@example.com",
"jill@example.com"
],
"statement_frequency": "monthly",
"task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
"keep_deleted_files_for": 30,
"reply_to_email_address": "jack@example.com",
"welcome_paragraph_html": "<h1>Welcome.</h1>",
"mobile_app_support_email": "support@example.com",
"mobile_app_support_number": "01234 567890",
"email_welcome_paragraph_html": "Welcome to Plannr!",
"show_fact_find_illustrations": true
},
"name": "Gareth Thompson",
"role": "client",
"tags": [
{
"name": "Mortgage",
"slug": "mortgage",
"uuid": "273afa8a-694f-4199-949b-d08dcf583a92",
"colour": "#ef4582",
"created_at": "2026-04-09T17:35:05+01:00",
"updated_at": "2026-04-09T17:35:05+01:00"
}
],
"type": "client",
"uuid": "22a7690d-5de1-48d5-ab71-85b84fcbe974",
"email": "gareth@codepotato.co.uk",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "36dc4203-5f8e-4035-b263-cc20a7bb5bd9",
"created_at": "2026-04-09T17:35:05+01:00",
"updated_at": "2026-04-09T17:35:05+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "86b9b967-16a8-4cf6-9f8f-c4a23a38461c",
"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": "1afe198c-7734-43aa-aa68-994188ffc380",
"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": "2026-04-09T17:35:05+01:00",
"first_name": "Gareth",
"updated_at": "2026-04-09T17:35:05+01:00",
"with_login": true,
"inactive_at": "2026-04-09",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"referral_code": "ABC12345",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2026-04-09T17:35:05+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2026-04-09T17:35:05+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"last_interaction_at": "2026-04-09 17:35:05",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2026-04-09T17:35:05+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2026-04-09T17:35:05+01:00"
}
],
"circles": [
{
"name": "Jones Family",
"uuid": "9022a022-2ceb-4b05-b5d1-738b86f1dc07",
"groups": "App\\Http\\Resources\\GroupResource",
"accounts": "App\\Http\\Resources\\AccountResource",
"bg_colour": "#35f4e1",
"photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
"created_at": "2026-04-09T17:35:05+01:00",
"updated_at": "2026-04-09T17:35:05+01:00",
"joint_account_uuid": "20acd3d4-aa1d-4631-930b-776421efdab1",
"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": "2026-04-09T17:35:05+01:00",
"first_name": "Gareth",
"updated_at": "2026-04-09T17:35:05+01:00",
"with_login": true,
"inactive_at": "2026-04-09",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "1d622da2-9c0b-4ca4-91f9-4575906de95b",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2026-04-09T17:35:05+01:00",
"updated_at": "2026-04-09T17:35:05+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": "583e9ddb-c85f-4b9f-a15f-953d08296e1a",
"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": "2026-04-09T17:35:05+01:00",
"first_name": "Gareth",
"updated_at": "2026-04-09T17:35:05+01:00",
"with_login": true,
"inactive_at": "2026-04-09",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"referral_code": "ABC12345",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2026-04-09T17:35:05+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2026-04-09T17:35:05+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"last_interaction_at": "2026-04-09 17:35:05",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2026-04-09T17:35:05+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2026-04-09T17:35:05+01:00"
},
"primary_email": {
"name": "Work number",
"type": "phone_number",
"uuid": "26aadd40-3a5e-416d-ae9e-26051e96ac8f",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2026-04-09T17:35:05+01:00",
"updated_at": "2026-04-09T17:35:05+01:00",
"phone_number_meta": {
"country": "GB",
"formatted": "0333 090 3630"
}
},
"referral_code": "ABC12345",
"can_be_deleted": "false",
"assigned_adviser": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "6dbbb2d8-aac4-4193-9c78-228f9a724c86",
"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": "2026-04-09T17:35:05+01:00",
"first_name": "Gareth",
"updated_at": "2026-04-09T17:35:05+01:00",
"with_login": true,
"inactive_at": "2026-04-09",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"referral_code": "ABC12345",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2026-04-09T17:35:05+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2026-04-09T17:35:05+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"last_interaction_at": "2026-04-09 17:35:05",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2026-04-09T17:35:05+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2026-04-09T17:35:05+01:00"
},
"next_review_date": "2026-04-09T17:35:05+01:00",
"has_joint_account": true,
"current_time_entry": {
"name": "Research",
"uuid": "2aafa860-712c-4de5-a026-f8b05e5bb359",
"account": "App\\Http\\Resources\\MinimalAccountResource",
"end_date": "2026-04-09T17:13:05+01:00",
"is_active": true,
"trackable": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2026-04-09T17:35:05+01:00",
"start_date": "2026-04-09T16:45:05+01:00",
"updated_at": "2026-04-09T17:35:05+01:00",
"description": "This is a description.",
"trackable_type": "Client",
"total_time_in_minutes": 28,
"computed_time_elapsed_in_seconds": 1680
},
"first_contact_date": "2026-04-09T17:35:05+01:00",
"external_references": [
{
"uuid": "6f9ccdcc-5147-494c-8674-0fa5b4f3db32",
"reference": "AB123456",
"created_at": "2026-04-09T17:35:05+01:00",
"updated_at": "2026-04-09T17:35:05+01:00",
"third_party": "nucleus"
}
],
"last_interaction_at": "2026-04-09 17:35:05",
"assigned_paraplanner": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "5af1069c-ffcc-4c76-a7cd-b3e3a598fa27",
"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": "2026-04-09T17:35:05+01:00",
"first_name": "Gareth",
"updated_at": "2026-04-09T17:35:05+01:00",
"with_login": true,
"inactive_at": "2026-04-09",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"referral_code": "ABC12345",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2026-04-09T17:35:05+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2026-04-09T17:35:05+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"last_interaction_at": "2026-04-09 17:35:05",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2026-04-09T17:35:05+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2026-04-09T17:35:05+01:00"
},
"joint_account_circle": {
"name": "Jones Family",
"uuid": "f6d5ba9c-cf0c-4156-81b2-b6bcdd8fcb9b",
"groups": "App\\Http\\Resources\\GroupResource",
"accounts": "App\\Http\\Resources\\AccountResource",
"bg_colour": "#35f4e1",
"photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
"created_at": "2026-04-09T17:35:05+01:00",
"updated_at": "2026-04-09T17:35:05+01:00",
"joint_account_uuid": "e5f1b91d-42de-408e-9037-d65de58a9008",
"login_access_level": "write",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"ownership_percentage": 100,
"previous_review_date": "2026-04-09T17:35:05+01:00",
"primary_phone_number": {
"name": "Work number",
"type": "phone_number",
"uuid": "c848529c-b09c-45b0-94d2-02703ebcfdfe",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2026-04-09T17:35:05+01:00",
"updated_at": "2026-04-09T17:35:05+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": "7fec82e1-767a-46f6-8d62-0eab15241121",
"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": "2026-04-09T17:35:05+01:00",
"first_name": "Gareth",
"updated_at": "2026-04-09T17:35:05+01:00",
"with_login": true,
"inactive_at": "2026-04-09",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"referral_code": "ABC12345",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2026-04-09T17:35:05+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2026-04-09T17:35:05+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"last_interaction_at": "2026-04-09 17:35:05",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2026-04-09T17:35:05+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2026-04-09T17:35:05+01:00"
},
"anniversary_review_date": "2026-04-09T17:35:05+01:00"
}