Create a client [DEPRECATED: Use create an account route] Run in API Explorer
Body
-
Title
-
First Name
-
Middle Name
-
Last Name
-
Maiden Name
-
Email address
-
Clients primary phone number
-
The UUID of the employee that the client directly reports to
-
The UUID of the adviser employee that the client has been assigned
-
The UUID of the paraplanner employee that the client has been assigned
-
The UUID of the introducer for this client
-
Set to true if you would like Plannr to send an email to the client on account creation
-
Date of birth
-
Gender. Possible values are: male, female, non-binary, transgender, intersex, other and unknown
Value Description male male female female non-binary non-binary transgender transgender intersex intersex other other unknown unknown Values are
male,female,non-binary,transgender,intersex,other, orunknown. -
National Insurance Number
-
preferred nickname of the client
-
Target retirement age.
-
Pronouns
-
Smoker Status. Possible values are: smoker, non-smoker, vaper, ex-smoker, never-smoked, unknown
Value Description smoker Smoker non-smoker Non Smoker vaper Vaper ex-smoker Ex Smoker never-smoked Never Smoked unknown Unknown Values are
smoker,non-smoker,vaper,ex-smoker,never-smoked, orunknown. -
Residential status
Value Description homeowner Homeowner renting Renting living_with_parents Living With Parents other Other Values are
homeowner,renting,living_with_parents, orother. -
Country of residence
-
Marital Status. Possible values are: single, cohabiting, married, divorced, civil-partnership, dissolved-civil-partnership, widowed, separated, engaged, in-relationship, other, unknown
Value Description single single cohabiting cohabiting married married divorced divorced civil-partnership civil partnership dissolved-civil-partnership dissolved-civil-partnership widowed widowed separated separated engaged engaged in-relationship in a relationship other other unknown unknown Values are
single,cohabiting,married,divorced,civil-partnership,dissolved-civil-partnership,widowed,separated,engaged,in-relationship,other, orunknown. -
whether the client is vulnerable. Possible values are: "yes", "no", and "possibly"
Values are
yes,no, orpossibly. -
Denotes if the client is a prospect or not.
-
The datetime when the prospect was converted into a client.
-
The value of the client in penny format. E.g £5,000 would be 500000.
-
Whether the client is a UK resident or not.
-
Whether the client is a UK domicile or not.
-
The expected retirement age.
-
The state retirement age.
-
Nationalities of the client. You can use the api/v1/static/nationalities endpoint to get our list.
-
Any details regarding the client's vulnerabilities.
-
One or more vulnerability sub types.
Values are
health,life_events,resilience, orcapability. -
The date of the last vulnerability assessment.
-
Whether the vulnerability is temporary or permanent.
Value Description temporary Temporary permanent Permanent Values are
temporaryorpermanent. -
Whether the client has been offered any third party.
-
Whether any procedures need to be adapted to the client.
-
Any notes regarding adaptations
-
Any client preferences.
-
The client's current state of health.
-
Explanation of the current state of health.
-
The amount of cigarettes the client smokes a day.
-
The date of when the client started smoking.
-
Whether the client required long term care.
-
Notes on the client's long term care.
-
Whether the client has a will or not.
-
Notes on the client's will.
-
The date of the last time the will's been reviewed.
-
Whether the client has power of attorney.
-
Notes on the client's power of attorney.
-
The date of the first contact.
-
The units of alcohol digested weekly.
-
The height of the client in centimeters.
-
The weight of the client in pounds.
-
Notes on the client's health.
-
Whether the client has Inheritance Tax (IHT) planning or not.
-
Notes on the client's Inheritance Tax (IHT) planning.
-
Whether the client has gifted the family.
-
Notes on the gifts.
-
Whether the client is anticipating/ expecting any inheritance.
-
Notes on the client's inheritance anticipation/ expectations.
-
Date of next review
-
Date of previous review
-
Anniversary review date
-
Does your current will reflect your wishes?
-
Who are the executors?
-
Where is the will stored?
-
Details of any Bequests
-
Is the Power of Attorney Registered as a EPA or LPA
Value Description epa Epa lpa Lpa Values are
epaorlpa. -
Are the Attorneys appointed for Health, Wealth or Both?
Values are
health,wealth, orboth. -
When were the Attorney’s appointed?
-
Who are the Attorney’s?
-
Are the documents registered?
-
Notes of gifts
-
Group UUIDs to sync client to.
-
Are you in receipt of your State Pension
-
Have you recently obtained a forecast
-
What is the date of the obtained forecast
-
What is the projected State Pension
-
How many years have you made Nation Insurance Contributions
-
Notes on the pension
-
The status of the client.
-
Date of marriage
-
Denotes if the client is deceased
-
Date of death
-
Denotes if the client is married to their partner
-
Date the client was checked for sanctions
-
Marks the lead source of the client
-
Marks the name of the client to write to
-
The passport number of the client
-
Denotes if the client can be contacted via fax
-
Denotes if the client can be contacted via mail
-
Denotes if the client can be contacted via SMS
-
Denotes if the client can be contacted via email
-
Denotes if the client can be contacted via telephone
-
Denotes if the client can be visited
-
Denotes if the client can be marketed to
-
The regulatory classification of the client. Possible values are: retail_client, professional_client, eligible_counterparty, not_applicable and unknown
Value Description retail_client Retail Client professional_client Professional Client eligible_counterparty Eligible Counterparty not_applicable Not Applicable unknown Unknown Values are
retail_client,professional_client,eligible_counterparty,not_applicable, orunknown.
curl \
--request POST 'https://api.plannrcrm.com/api/v1/client' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"title":"Mr","first_name":"Gareth","middle_name":"Alex","last_name":"Thompson","maiden_name":"Thompson","email":"gareth@codepotato.co.uk","phone":"443330509960","assigned_adviser_uuid":"86282cb3-02de-4b61-be06-a5167b0f86f7","assigned_administrator_uuid":"b16ab305-8cac-4962-b4af-d9faebc4a62e","assigned_paraplanner_uuid":"52614fb9-6b56-45c7-b0de-dab540f0fda6","introduced_by_uuid":"44bc17e0-4ecf-4eb3-8ddf-3ba755dbc6d1","send_welcome_email":true,"date_of_birth":"1976-04-24","gender":"male","ni_number":"AB 12 34 56 C","nickname":"G","target_retirement_age":60,"pronouns":"he/him","smoker_status":"smoker","residential_status":"homeowner","country_of_residence":"United Kingdom","marital_status":"single","is_vulnerable":"yes","is_prospect":false,"prospect_converted_at":"2026-04-24T17:14:53+01:00","value":500000,"is_uk_resident":true,"is_uk_domicile":true,"expected_retirement_age":60,"state_retirement_age":60,"nationalities":["British","Romanian"],"vulnerability_details":"No vulnerabilities","vulnerability_sub_type":["health"],"vulnerability_last_assessment_date":"2026-01-24","vulnerability_duration":"temporary","third_party_offered":true,"procedure_adaptation":true,"adaption_details_notes":true,"client_preferences":"Prefers telephone calls in the morning.","current_state_of_health":"Fit and healthy","state_of_health_explanation":"Explanation of the current state of health.","cigarettes_daily":6,"smoker_since":"2016-04-24","long_term_care_needed":false,"long_term_care_notes":"Notes on the client's long term care.","has_will":false,"will_notes":"Notes on the client's will.","will_last_reviewed":"2026-04-23","has_power_of_attorney":true,"power_of_attorney_notes":"Notes on the client's power of attorney.","first_contact_date":"2026-03-24","units_of_alcohol_weekly":28,"height":186,"weight":220,"health_notes":"Notes on the client's health.","has_iht_planning":true,"iht_planning_notes":"Notes on the client's Inheritance Tax (IHT) planning.","has_gifted_family":true,"gift_notes":"Notes on the gifts.","is_anticipating_inheritance":true,"anticipating_inheritance_notes":"Notes on the client's inheritance anticipation/ expectations.","next_review_date":"2026-05-24","previous_review_date":"2026-03-24","anniversary_review_date":"2026-04-24","is_will_accurate":true,"will_executors":"string","will_location":"string","will_bequests_detail":"string","is_poa_registered_epa_or_lpa":"epa","are_poa_appointed_for_health_or_wealth":"health","poa_attorney_appointed_at":"2026-04-24","will_poa_details":"string","are_poa_documents_registered":true,"will_gifts_details":"string","groups":["4e292004-ea85-4f2e-a89d-b91978d98198","cd20a4ca-9503-4eb3-b9f3-981ed3c2af4f","e6dec161-a46f-44c1-985a-7409ad914163"],"is_in_receipt_of_your_state_pension":true,"has_obtained_a_forecast":true,"date_of_forecast":"2026-04-24","projected_state_pension":50000,"years_of_national_insurance_contributions":5,"pension_notes":"string","status_uuid":"2d7f4694-db0f-4325-9637-7a36eaa5ee1d","date_of_marriage":"2026-04-24","is_deceased":false,"deceased_at":"2026-04-24","is_married_to_partner":true,"checked_sanctions_at":"2026-04-24","lead_source":"LeadGen Company","write_to_whom":"Gareth","passport_number":"123456","do_not_contact_via_fax":false,"do_not_contact_via_mail":false,"do_not_contact_via_sms":false,"do_not_contact_via_email":false,"do_not_contact_via_telephone":false,"do_not_visit":false,"do_not_market":false,"client_regulatory_classification":"retail_client","external_reference":{"third_party":"adviser_office","reference":"AB123456"}}'
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"title": "Mr",
"first_name": "Gareth",
"middle_name": "Alex",
"last_name": "Thompson",
"maiden_name": "Thompson",
"email": "gareth@codepotato.co.uk",
"phone": "443330509960",
"assigned_adviser_uuid": "86282cb3-02de-4b61-be06-a5167b0f86f7",
"assigned_administrator_uuid": "b16ab305-8cac-4962-b4af-d9faebc4a62e",
"assigned_paraplanner_uuid": "52614fb9-6b56-45c7-b0de-dab540f0fda6",
"introduced_by_uuid": "44bc17e0-4ecf-4eb3-8ddf-3ba755dbc6d1",
"send_welcome_email": true,
"date_of_birth": "1976-04-24",
"gender": "male",
"ni_number": "AB 12 34 56 C",
"nickname": "G",
"target_retirement_age": 60,
"pronouns": "he/him",
"smoker_status": "smoker",
"residential_status": "homeowner",
"country_of_residence": "United Kingdom",
"marital_status": "single",
"is_vulnerable": "yes",
"is_prospect": false,
"prospect_converted_at": "2026-04-24T17:14:53+01:00",
"value": 500000,
"is_uk_resident": true,
"is_uk_domicile": true,
"expected_retirement_age": 60,
"state_retirement_age": 60,
"nationalities": [
"British",
"Romanian"
],
"vulnerability_details": "No vulnerabilities",
"vulnerability_sub_type": [
"health"
],
"vulnerability_last_assessment_date": "2026-01-24",
"vulnerability_duration": "temporary",
"third_party_offered": true,
"procedure_adaptation": true,
"adaption_details_notes": true,
"client_preferences": "Prefers telephone calls in the morning.",
"current_state_of_health": "Fit and healthy",
"state_of_health_explanation": "Explanation of the current state of health.",
"cigarettes_daily": 6,
"smoker_since": "2016-04-24",
"long_term_care_needed": false,
"long_term_care_notes": "Notes on the client's long term care.",
"has_will": false,
"will_notes": "Notes on the client's will.",
"will_last_reviewed": "2026-04-23",
"has_power_of_attorney": true,
"power_of_attorney_notes": "Notes on the client's power of attorney.",
"first_contact_date": "2026-03-24",
"units_of_alcohol_weekly": 28,
"height": 186,
"weight": 220,
"health_notes": "Notes on the client's health.",
"has_iht_planning": true,
"iht_planning_notes": "Notes on the client's Inheritance Tax (IHT) planning.",
"has_gifted_family": true,
"gift_notes": "Notes on the gifts.",
"is_anticipating_inheritance": true,
"anticipating_inheritance_notes": "Notes on the client's inheritance anticipation/ expectations.",
"next_review_date": "2026-05-24",
"previous_review_date": "2026-03-24",
"anniversary_review_date": "2026-04-24",
"is_will_accurate": true,
"will_executors": "string",
"will_location": "string",
"will_bequests_detail": "string",
"is_poa_registered_epa_or_lpa": "epa",
"are_poa_appointed_for_health_or_wealth": "health",
"poa_attorney_appointed_at": "2026-04-24",
"will_poa_details": "string",
"are_poa_documents_registered": true,
"will_gifts_details": "string",
"groups": [
"4e292004-ea85-4f2e-a89d-b91978d98198",
"cd20a4ca-9503-4eb3-b9f3-981ed3c2af4f",
"e6dec161-a46f-44c1-985a-7409ad914163"
],
"is_in_receipt_of_your_state_pension": true,
"has_obtained_a_forecast": true,
"date_of_forecast": "2026-04-24",
"projected_state_pension": 50000,
"years_of_national_insurance_contributions": 5,
"pension_notes": "string",
"status_uuid": "2d7f4694-db0f-4325-9637-7a36eaa5ee1d",
"date_of_marriage": "2026-04-24",
"is_deceased": false,
"deceased_at": "2026-04-24",
"is_married_to_partner": true,
"checked_sanctions_at": "2026-04-24",
"lead_source": "LeadGen Company",
"write_to_whom": "Gareth",
"passport_number": "123456",
"do_not_contact_via_fax": false,
"do_not_contact_via_mail": false,
"do_not_contact_via_sms": false,
"do_not_contact_via_email": false,
"do_not_contact_via_telephone": false,
"do_not_visit": false,
"do_not_market": false,
"client_regulatory_classification": "retail_client",
"external_reference": {
"third_party": "adviser_office",
"reference": "AB123456"
}
}
{
"uuid": "cf285e14-17f6-4975-9f24-9d8382d3a4be",
"created_at": "2026-04-24T17:14:53+01:00",
"updated_at": "2026-04-24T17:14:53+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": "cb555a7c-2e3d-4afe-94b0-79b9a3994678",
"created_at": "2026-04-24T17:14:53+01:00",
"updated_at": "2026-04-24T17:14:53+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": "7274ec19-25a3-420c-8dbf-08b7a744b7eb",
"created_at": "2026-04-24T17:14:53+01:00",
"updated_at": "2026-04-24T17:14:53+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": "d323188c-a5e8-4682-86d8-ef1ad080ca80",
"created_at": "2026-04-24T17:14:53+01:00",
"updated_at": "2026-04-24T17:14:53+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": "fd53e267-94d2-4cd2-b286-689802c49856",
"created_at": "2026-04-24T17:14:53+01:00",
"updated_at": "2026-04-24T17:14:53+01:00",
"name": "Research",
"description": "This is a description.",
"trackable_type": "Client",
"trackable": "App\\Http\\Resources\\MinimalAccountResource",
"start_date": "2026-04-24T16:24:53+01:00",
"end_date": "2026-04-24T16:52:53+01:00",
"is_active": true,
"total_time_in_minutes": 28,
"computed_time_elapsed_in_seconds": 1680,
"account": "App\\Http\\Resources\\MinimalAccountResource"
},
"assigned_adviser": {
"uuid": "814c7a99-eaec-40c1-a696-ac712551e813",
"created_at": "2026-04-24T17:14:53+01:00",
"updated_at": "2026-04-24T17:14:53+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-24T17:14:53+01:00",
"next_review_date": "2026-04-24T17:14:53+01:00",
"previous_review_date": "2026-04-24T17:14:53+01:00",
"anniversary_review_date": "2026-04-24T17:14:53+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-24",
"last_interaction_at": "2026-04-24 17:14:53",
"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": "540c6ef0-7e71-456c-951d-cd2b006f64dc",
"created_at": "2026-04-24T17:14:53+01:00",
"updated_at": "2026-04-24T17:14:53+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-24T17:14:53+01:00",
"next_review_date": "2026-04-24T17:14:53+01:00",
"previous_review_date": "2026-04-24T17:14:53+01:00",
"anniversary_review_date": "2026-04-24T17:14:53+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-24",
"last_interaction_at": "2026-04-24 17:14:53",
"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": "34dad677-6876-41eb-aa5c-802b360ce549",
"created_at": "2026-04-24T17:14:53+01:00",
"updated_at": "2026-04-24T17:14:53+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-24T17:14:53+01:00",
"next_review_date": "2026-04-24T17:14:53+01:00",
"previous_review_date": "2026-04-24T17:14:53+01:00",
"anniversary_review_date": "2026-04-24T17:14:53+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-24",
"last_interaction_at": "2026-04-24 17:14:53",
"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": "38853f50-01b1-4d47-993a-c4f91a41e8cc",
"created_at": "2026-04-24T17:14:53+01:00",
"updated_at": "2026-04-24T17:14:53+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-24T17:14:53+01:00",
"next_review_date": "2026-04-24T17:14:53+01:00",
"previous_review_date": "2026-04-24T17:14:53+01:00",
"anniversary_review_date": "2026-04-24T17:14:53+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-24",
"last_interaction_at": "2026-04-24 17:14:53",
"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": "d1c1e5c1-05aa-47eb-97bf-8614fe0e71d1",
"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-24T17:14:53+01:00",
"updated_at": "2026-04-24T17:14:53+01:00"
},
"groups": [
{
"uuid": "6d32e174-8105-4a5d-8048-5d0a9cc29eb3",
"name": "finance",
"slug": "finance",
"participants_count": "3",
"participants": {
"uuid": {
"example": "0c9a32f1-3e19-4c92-a980-e82c21be7fd4",
"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-24T17:14:53+01:00",
"updated_at": "2026-04-24T17:14:53+01:00"
}
],
"tags": [
{
"uuid": "cc68a017-77a6-4056-a221-a6ad9aa56740",
"created_at": "2026-04-24T17:14:53+01:00",
"updated_at": "2026-04-24T17:14:53+01:00",
"name": "Mortgage",
"slug": "mortgage",
"colour": "#ef4582"
}
],
"owners": [
{
"uuid": "52ebd8d2-6151-4077-863f-45ac2581c140",
"created_at": "2026-04-24T17:14:53+01:00",
"updated_at": "2026-04-24T17:14:53+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-24T17:14:53+01:00",
"next_review_date": "2026-04-24T17:14:53+01:00",
"previous_review_date": "2026-04-24T17:14:53+01:00",
"anniversary_review_date": "2026-04-24T17:14:53+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-24",
"last_interaction_at": "2026-04-24 17:14:53",
"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-24T17:14:53+01:00",
"next_review_date": "2026-04-24T17:14:53+01:00",
"previous_review_date": "2026-04-24T17:14:53+01:00",
"anniversary_review_date": "2026-04-24T17:14:53+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"joint_account_circle": {
"uuid": "637cd12c-2ddb-4522-b6a2-d69d26c17747",
"created_at": "2026-04-24T17:14:53+01:00",
"updated_at": "2026-04-24T17:14:53+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": "9bdca074-11fa-4c9f-89ce-43a9598f10b6",
"login_access_level": "write",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"circles": [
{
"uuid": "e620383d-d2d7-4d0b-9812-87d41b529d9b",
"created_at": "2026-04-24T17:14:53+01:00",
"updated_at": "2026-04-24T17:14:53+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": "60a55c17-2e07-443a-a1b8-611ca3cfe140",
"login_access_level": "write",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
}
],
"ownership_percentage": 100,
"inactive_at": "2026-04-24",
"last_interaction_at": "2026-04-24 17:14:53",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": [
{
"uuid": "2f9bffd4-a326-40c3-b8b5-716bc7ecc23c",
"created_at": "2026-04-24T17:14:53+01:00",
"updated_at": "2026-04-24T17:14:53+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": "a239d677-6d7b-409c-963c-d560cd95237b",
"created_at": "2026-04-24T17:14:53+01:00",
"updated_at": "2026-04-24T17:14:53+01:00",
"third_party": "nucleus",
"reference": "AB123456"
}
]
}