Create an employee [DEPRECATED: Use create an account route]

POST /api/v1/employee

Personal access token & O auth2

Headers

application/json

Body Required

first_name string Required

The first name of the employee.
last_name string Required

The last name of the employee.
email string

The email of the employee. Required when with_login is present.
assigned_adviser_uuid string

35df8a3e-6279-49a8-8f5c-3992d17e16e8
role string Required

The role of the employee.
with_login boolean Required

Denotes if the employee needs a billable login.
departments array[string] Required

The departments the employee is part of
groups array[string]

Group uuids belonging to the firm.
adviser_split_uuid string

The uuid of the the adviser split that will be applied when this adviser adds charges
advice_type string

Employee's RMAR advice type

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- type string
  
  Account type
- role string
  
  Account role
- first_name string
  
  First name
- last_name string
  
  Last name
- name string
  
  Name
- email string
  
  (Deprecated - Please use primary_email instead). The email of the account.
- firm object
  
  Firm
- primary_phone_number object
  
  Primary phone number
- primary_email object
  
  Primary email
- current_time_entry object
  
  Current time entry
- assigned_adviser object
  
  Assigned adviser
- assigned_administrator object
  
  Assigned administrator
- assigned_paraplanner object
  
  Assigned paraplanner
- introduced_by object
  
  Introduced by
- groups array[object]
  
  Groups
- tags array[object]
  
  Tags
- owners array[object]
  
  Accounts that own this account
- first_contact_date string
  
  First contact date
- next_review_date string
  
  Next review date
- previous_review_date string
  
  Previous review date
- anniversary_review_date string
  
  Anniversary review date
- with_login boolean
  
  Denotes whether the account has a login to Plannr
- has_joint_account boolean
  
  Denotes whether this account belongs to a joint account too
- can_be_deleted string
  
  Denotes if the account can be deleted
- joint_account_circle object
  
  This field is only present when viewing a joint account directly. This will contain the circle that we automatically created when we released circles.
- ownership_percentage integer
  
  Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
- inactive_at string
  
  Inactive from date
- custom_fields array[object]
  
  Any custom fields on the model.
- external_references array[object]
  
  The external references that have been added to the client.

POST /api/v1/employee

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/employee' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: 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":"222ca221-491f-4711-8459-0de23c1c65ab","role":"owner","with_login":true,"departments":["paraplanner","adviser"],"groups":["e6358b1a-7eed-4ee9-8989-61e966d5e23d","709b9e90-f3f7-4595-8b8f-1c364e202bae"],"adviser_split_uuid":"2b941387-5c5d-4962-8d67-74b2b9d4c219","advice_type":"independent"}'

Request examples

# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "first_name": "Gareth",
  "last_name": "Thompson",
  "email": "gareth.thompson@plannrcrm.com",
  "assigned_adviser_uuid": "222ca221-491f-4711-8459-0de23c1c65ab",
  "role": "owner",
  "with_login": true,
  "departments": [
    "paraplanner",
    "adviser"
  ],
  "groups": [
    "e6358b1a-7eed-4ee9-8989-61e966d5e23d",
    "709b9e90-f3f7-4595-8b8f-1c364e202bae"
  ],
  "adviser_split_uuid": "2b941387-5c5d-4962-8d67-74b2b9d4c219",
  "advice_type": "independent"
}

Response examples (200)

{
  "firm": {
    "tax": 17.5,
    "logo": "https://api.plannrcrm.com/images/plannr.jpg",
    "name": "Codepotato",
    "slug": "codepotato",
    "uuid": "c3bf5c17-ecdf-48b9-a55b-551f4dd63325",
    "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-05T11:39:38+01:00",
    "updated_at": "2025-06-05T11:39:38+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",
      "sidebar_background": "#0E0E56",
      "sidebar_title_primary": "#FFC634",
      "email_button_background": "#36367E",
      "sidebar_title_secondary": "#ffffff",
      "sidebar_title_background": "#36367E",
      "email_logo_background_panel": "#36367E",
      "sidebar_title_secondary_hover": "#ffffff"
    },
    "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": "b6396bb1-a7ef-47bd-b46c-cfc14c060e78",
      "colour": "#ef4582",
      "created_at": "2025-06-05T11:39:38+01:00",
      "updated_at": "2025-06-05T11:39:38+01:00"
    }
  ],
  "type": "client",
  "uuid": "9780c598-9a78-428d-9314-1389bd22a00e",
  "email": "gareth@codepotato.co.uk",
  "groups": [
    {
      "name": "finance",
      "slug": "finance",
      "uuid": "ba1a46f5-ef4f-4115-a34f-8f09587b6d67",
      "created_at": "2025-06-05T11:39:38+01:00",
      "updated_at": "2025-06-05T11:39:38+01:00",
      "participants": {
        "name": {
          "example": "Gareth Thompson",
          "description": "Name of the account"
        },
        "role": {
          "example": "client",
          "description": "Role of the account"
        },
        "uuid": {
          "example": "02101211-63c1-4e62-ae7d-8d02cd21b74c",
          "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": "81d9ddde-5fe2-4e88-9a4f-ebcee69406b6",
      "email": "gareth@codepotato.co.uk",
      "groups": "App\\Http\\Resources\\GroupResource",
      "owners": "App\\Http\\Resources\\AccountResource",
      "last_name": "Thompson",
      "created_at": "2025-06-05T11:39:38+01:00",
      "first_name": "Gareth",
      "updated_at": "2025-06-05T11:39:38+01:00",
      "with_login": true,
      "inactive_at": "2025-06-05",
      "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-05T11:39:38+01:00",
      "has_joint_account": true,
      "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
      "first_contact_date": "2025-06-05T11:39:38+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-05T11:39:38+01:00",
      "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
      "assigned_administrator": "App\\Http\\Resources\\AccountResource",
      "anniversary_review_date": "2025-06-05T11:39:38+01:00"
    }
  ],
  "last_name": "Thompson",
  "created_at": "2025-06-05T11:39:38+01:00",
  "first_name": "Gareth",
  "updated_at": "2025-06-05T11:39:38+01:00",
  "with_login": true,
  "inactive_at": "2025-06-05",
  "custom_fields": [
    {
      "name": "Favourite Drink",
      "type": "string",
      "uuid": "7fd0aec8-0e05-4645-99c1-706d03e855b2",
      "value": "Coffee",
      "help_text": "This is the client's favourite drink.",
      "reference": "favourite_drink",
      "created_at": "2025-06-05T11:39:38+01:00",
      "updated_at": "2025-06-05T11:39:38+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": "1f9a40e2-a827-48b5-94fb-109ff42f1802",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-06-05T11:39:38+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-06-05T11:39:38+01:00",
    "with_login": true,
    "inactive_at": "2025-06-05",
    "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-05T11:39:38+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-06-05T11:39:38+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-05T11:39:38+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-06-05T11:39:38+01:00"
  },
  "primary_email": {
    "name": "Work number",
    "type": "phone_number",
    "uuid": "a3515181-65a9-4cc2-8f68-4e3835f5b8bf",
    "value": "+443330903630",
    "accounts": "App\\Http\\Resources\\AccountResource",
    "created_at": "2025-06-05T11:39:38+01:00",
    "updated_at": "2025-06-05T11:39:38+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": "1d836111-0dfb-4585-b4f9-20812fdaecb1",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-06-05T11:39:38+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-06-05T11:39:38+01:00",
    "with_login": true,
    "inactive_at": "2025-06-05",
    "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-05T11:39:38+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-06-05T11:39:38+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-05T11:39:38+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-06-05T11:39:38+01:00"
  },
  "next_review_date": "2025-06-05T11:39:38+01:00",
  "has_joint_account": true,
  "current_time_entry": {
    "name": "Research",
    "uuid": "7925d1d2-0314-4edd-8f35-e8d64bb15c3d",
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "end_date": "2025-06-05T11:17:38+01:00",
    "is_active": true,
    "trackable": "App\\Http\\Resources\\MinimalAccountResource",
    "created_at": "2025-06-05T11:39:38+01:00",
    "start_date": "2025-06-05T10:49:38+01:00",
    "updated_at": "2025-06-05T11:39:38+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-05T11:39:38+01:00",
  "external_references": [
    {
      "uuid": "fc8cb994-04dd-4d02-8bca-504d3e8a0234",
      "reference": "AB123456",
      "created_at": "2025-06-05T11:39:38+01:00",
      "updated_at": "2025-06-05T11:39:38+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": "0908692d-68be-45d9-b696-f291515d9fe7",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-06-05T11:39:38+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-06-05T11:39:38+01:00",
    "with_login": true,
    "inactive_at": "2025-06-05",
    "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-05T11:39:38+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-06-05T11:39:38+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-05T11:39:38+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-06-05T11:39:38+01:00"
  },
  "joint_account_circle": {
    "name": "Jones Family",
    "uuid": "a20bf742-d5a5-4f7c-bf98-c926ac9d275d",
    "groups": "App\\Http\\Resources\\GroupResource",
    "accounts": "App\\Http\\Resources\\MinimalAccountResource",
    "created_at": "2025-06-05T11:39:38+01:00",
    "updated_at": "2025-06-05T11:39:38+01:00",
    "joint_account_uuid": "f1958008-9a27-45d8-adc6-587ac23e3040"
  },
  "ownership_percentage": 100,
  "previous_review_date": "2025-06-05T11:39:38+01:00",
  "primary_phone_number": {
    "name": "Work number",
    "type": "phone_number",
    "uuid": "681173c3-bf02-4a05-899b-2bfb050e074b",
    "value": "+443330903630",
    "accounts": "App\\Http\\Resources\\AccountResource",
    "created_at": "2025-06-05T11:39:38+01:00",
    "updated_at": "2025-06-05T11:39:38+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": "b99bbe6e-4194-4996-96ad-07fa9e584da0",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-06-05T11:39:38+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-06-05T11:39:38+01:00",
    "with_login": true,
    "inactive_at": "2025-06-05",
    "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-05T11:39:38+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-06-05T11:39:38+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-05T11:39:38+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-06-05T11:39:38+01:00"
  },
  "anniversary_review_date": "2025-06-05T11:39:38+01:00"
}