Body
object
Client route for Create an account
-
The type of the account being created. For creating a client, this type must be
client
. -
The role of the account being created. For creating a client, the available roles are: individual, joint, trust and business
-
Title
-
First Name
-
Middle Name
-
Last Name
-
Maiden Name
-
Email address
-
Send an email on account creation and create a login
-
Phone number
-
Address
-
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
-
Date of birth
-
Gender. Possible values are: male, female, non-binary, transgender, intersex, other and unknown
-
National Insurance Number
-
preferred nickname of the client
-
Targest retirement age.
-
Pronouns
-
Smoker Status. Possible values are: smoker, non-smoker, vaper, ex-smoker, never-smoked, unknown
-
The date of the last time the client used nicotine products.
-
Residential status
-
Country of residence
-
Marital Status. Possible values are: single, cohabiting, married, divorced, civil-partnership, dissolved-civil-partnership, widowed, separated, engaged, in-relationship, other, unknown
-
whether the client is vulnerable. Possible values are: "yes", "no", and "possibly"
-
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.
-
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
-
Are the Attorneys appointed for Health, Wealth or Both?
-
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.
-
The clients current life stage for expenditure. Defaults to first available to firm if not provided.
-
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
-
Inactive from date
-
A third-party external reference to attach when creating the model. The third party must be one of the following: adviser_office, aj_bell, be_iq_organisation, conquest, filehaven, finio, fundment, intelliflo_office, octopus_money, nucleus, parmenion, seccl, smartsearch, soderberg and transact_remuneration
curl \
--request POST 'https://api.plannrcrm.com/api/v1/account' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"type":"client","role":"individual","title":"Mr","first_name":"Gareth","middle_name":"Alex","last_name":"Thompson","maiden_name":"Thompson","email":"gareth@codepotato.co.uk","send_welcome_email":true,"phone":"443330509960","address":[{"name":{"type":"string","example":"Work Address","required":false,"description":"Name of the address"},"county":{"type":"string","example":"Hampshire","required":false,"description":"County"},"country":{"type":"string","example":"United Kingdom","required":false,"description":"Country"},"postcode":{"type":"string","example":"PO7 7YH","required":false,"description":"Postcode"},"address_1":{"type":"string","example":"Suite E","required":false,"description":"First line of the address"},"address_2":{"type":"string","example":"5 The Briars","required":false,"description":"Second line of the address"},"address_3":{"type":"string","example":"Waterberry Drive","required":false,"description":"Third line of the address"},"address_4":{"type":"string","example":"The Innovative Centre","required":false,"description":"Fourth line of the address"},"town_city":{"type":"string","example":"Waterlooville","required":false,"description":"Town/City"},"move_in_date":{"type":"string","example":"2024-06-20","required":false,"description":"Move in date"},"moved_in_year":{"type":"integer","example":2022,"required":false,"description":"The year the client moved into this address."},"moved_in_month":{"type":"integer","example":6,"required":false,"description":"The month the client moved into this address."},"moved_out_year":{"type":"integer","example":2024,"required":false,"description":"The year the client moved out of this address."},"moved_out_month":{"type":"integer","example":1,"required":false,"description":"The month the client moved out of this address."},"residential_status":{"type":"string","example":"homeowner","required":false,"description":"The client's residential status when living at the address."},"residential_status_other":{"type":"string","example":"Non-tenant occupier","required":false,"description":"The client's residential status if it is not provided in the residential_status options. Must only be provided if residential_status is other."}}],"assigned_adviser_uuid":"d8aa60e8-3a44-4d23-abab-cd5b492b25e7","assigned_administrator_uuid":"7b3ab7d0-dd65-402b-8ee5-d73499cf26b6","assigned_paraplanner_uuid":"1c6c82fb-39d1-4f86-81a2-e295328dfc07","introduced_by_uuid":"e4a7d416-c24b-479a-9c6f-bbef3ce59984","date_of_birth":"1975-07-25","gender":"Male","ni_number":"AB 12 34 56 C","nickname":"G","target_retirement_age":60,"pronouns":"he/him","smoker_status":"non-smoker","last_used_nicotine_products_date":"2024-07-25","residential_status":"settled","country_of_residence":"United Kingdom","marital_status":"married","is_vulnerable":"possibly","is_prospect":false,"prospect_converted_at":"2025-07-25T15:56:15+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","third_party_offered":true,"procedure_adaptation":true,"adaption_details_notes":"Adaptation notes","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":"2015-07-25","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":"2025-07-24","has_power_of_attorney":true,"power_of_attorney_notes":"Notes on the client's power of attorney.","first_contact_date":"2025-06-25","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":"2025-08-25","previous_review_date":"2025-06-25","anniversary_review_date":"2025-07-25","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":"2025-07-25T00:00:00+01:00","will_poa_details":"string","are_poa_documents_registered":true,"will_gifts_details":"string","groups":["c6bd1771-a226-416e-8e9a-af14568dee4f","28d01b45-49fe-46c2-b2aa-a92105c02b24"],"is_in_receipt_of_your_state_pension":true,"has_obtained_a_forecast":true,"date_of_forecast":"2025-07-25T15:56:15+01:00","projected_state_pension":50000,"years_of_national_insurance_contributions":5,"pension_notes":"string","status_uuid":"039b77af-e3f3-4818-a186-f97ff39bdec1","current_life_stage_uuid":"e73f17b3-6d7a-49b1-9533-b0807da1ed1b","date_of_marriage":"2025-07-25","is_deceased":false,"deceased_at":"2025-07-25","is_married_to_partner":true,"checked_sanctions_at":"2025-07-25","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,"inactive_at":"2025-07-25","external_reference":[{"reference":"AB123456","third_party":"nucleus"}]}'
{
"type": "client",
"role": "individual",
"title": "Mr",
"first_name": "Gareth",
"middle_name": "Alex",
"last_name": "Thompson",
"maiden_name": "Thompson",
"email": "gareth@codepotato.co.uk",
"send_welcome_email": true,
"phone": "443330509960",
"address": [
{
"name": {
"type": "string",
"example": "Work Address",
"required": false,
"description": "Name of the address"
},
"county": {
"type": "string",
"example": "Hampshire",
"required": false,
"description": "County"
},
"country": {
"type": "string",
"example": "United Kingdom",
"required": false,
"description": "Country"
},
"postcode": {
"type": "string",
"example": "PO7 7YH",
"required": false,
"description": "Postcode"
},
"address_1": {
"type": "string",
"example": "Suite E",
"required": false,
"description": "First line of the address"
},
"address_2": {
"type": "string",
"example": "5 The Briars",
"required": false,
"description": "Second line of the address"
},
"address_3": {
"type": "string",
"example": "Waterberry Drive",
"required": false,
"description": "Third line of the address"
},
"address_4": {
"type": "string",
"example": "The Innovative Centre",
"required": false,
"description": "Fourth line of the address"
},
"town_city": {
"type": "string",
"example": "Waterlooville",
"required": false,
"description": "Town/City"
},
"move_in_date": {
"type": "string",
"example": "2024-06-20",
"required": false,
"description": "Move in date"
},
"moved_in_year": {
"type": "integer",
"example": 2022,
"required": false,
"description": "The year the client moved into this address."
},
"moved_in_month": {
"type": "integer",
"example": 6,
"required": false,
"description": "The month the client moved into this address."
},
"moved_out_year": {
"type": "integer",
"example": 2024,
"required": false,
"description": "The year the client moved out of this address."
},
"moved_out_month": {
"type": "integer",
"example": 1,
"required": false,
"description": "The month the client moved out of this address."
},
"residential_status": {
"type": "string",
"example": "homeowner",
"required": false,
"description": "The client's residential status when living at the address."
},
"residential_status_other": {
"type": "string",
"example": "Non-tenant occupier",
"required": false,
"description": "The client's residential status if it is not provided in the residential_status options. Must only be provided if residential_status is other."
}
}
],
"assigned_adviser_uuid": "d8aa60e8-3a44-4d23-abab-cd5b492b25e7",
"assigned_administrator_uuid": "7b3ab7d0-dd65-402b-8ee5-d73499cf26b6",
"assigned_paraplanner_uuid": "1c6c82fb-39d1-4f86-81a2-e295328dfc07",
"introduced_by_uuid": "e4a7d416-c24b-479a-9c6f-bbef3ce59984",
"date_of_birth": "1975-07-25",
"gender": "Male",
"ni_number": "AB 12 34 56 C",
"nickname": "G",
"target_retirement_age": 60,
"pronouns": "he/him",
"smoker_status": "non-smoker",
"last_used_nicotine_products_date": "2024-07-25",
"residential_status": "settled",
"country_of_residence": "United Kingdom",
"marital_status": "married",
"is_vulnerable": "possibly",
"is_prospect": false,
"prospect_converted_at": "2025-07-25T15:56:15+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",
"third_party_offered": true,
"procedure_adaptation": true,
"adaption_details_notes": "Adaptation notes",
"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": "2015-07-25",
"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": "2025-07-24",
"has_power_of_attorney": true,
"power_of_attorney_notes": "Notes on the client's power of attorney.",
"first_contact_date": "2025-06-25",
"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": "2025-08-25",
"previous_review_date": "2025-06-25",
"anniversary_review_date": "2025-07-25",
"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": "2025-07-25T00:00:00+01:00",
"will_poa_details": "string",
"are_poa_documents_registered": true,
"will_gifts_details": "string",
"groups": [
"c6bd1771-a226-416e-8e9a-af14568dee4f",
"28d01b45-49fe-46c2-b2aa-a92105c02b24"
],
"is_in_receipt_of_your_state_pension": true,
"has_obtained_a_forecast": true,
"date_of_forecast": "2025-07-25T15:56:15+01:00",
"projected_state_pension": 50000,
"years_of_national_insurance_contributions": 5,
"pension_notes": "string",
"status_uuid": "039b77af-e3f3-4818-a186-f97ff39bdec1",
"current_life_stage_uuid": "e73f17b3-6d7a-49b1-9533-b0807da1ed1b",
"date_of_marriage": "2025-07-25",
"is_deceased": false,
"deceased_at": "2025-07-25",
"is_married_to_partner": true,
"checked_sanctions_at": "2025-07-25",
"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,
"inactive_at": "2025-07-25",
"external_reference": [
{
"reference": "AB123456",
"third_party": "nucleus"
}
]
}
{
"type": "employee",
"role": "member",
"first_name": "Gareth",
"last_name": "Thompson",
"email": "gareth@codepotato.co.uk",
"send_welcome_email": true,
"phone": "443330509960",
"address": [
{
"name": {
"type": "string",
"example": "Work Address",
"required": false,
"description": "Name of the address"
},
"county": {
"type": "string",
"example": "Hampshire",
"required": false,
"description": "County"
},
"country": {
"type": "string",
"example": "United Kingdom",
"required": false,
"description": "Country"
},
"postcode": {
"type": "string",
"example": "PO7 7YH",
"required": false,
"description": "Postcode"
},
"address_1": {
"type": "string",
"example": "Suite E",
"required": false,
"description": "First line of the address"
},
"address_2": {
"type": "string",
"example": "5 The Briars",
"required": false,
"description": "Second line of the address"
},
"address_3": {
"type": "string",
"example": "Waterberry Drive",
"required": false,
"description": "Third line of the address"
},
"address_4": {
"type": "string",
"example": "The Innovative Centre",
"required": false,
"description": "Fourth line of the address"
},
"town_city": {
"type": "string",
"example": "Waterlooville",
"required": false,
"description": "Town/City"
},
"move_in_date": {
"type": "string",
"example": "2024-06-20",
"required": false,
"description": "Move in date"
},
"moved_in_year": {
"type": "integer",
"example": 2022,
"required": false,
"description": "The year the client moved into this address."
},
"moved_in_month": {
"type": "integer",
"example": 6,
"required": false,
"description": "The month the client moved into this address."
},
"moved_out_year": {
"type": "integer",
"example": 2024,
"required": false,
"description": "The year the client moved out of this address."
},
"moved_out_month": {
"type": "integer",
"example": 1,
"required": false,
"description": "The month the client moved out of this address."
},
"residential_status": {
"type": "string",
"example": "homeowner",
"required": false,
"description": "The client's residential status when living at the address."
},
"residential_status_other": {
"type": "string",
"example": "Non-tenant occupier",
"required": false,
"description": "The client's residential status if it is not provided in the residential_status options. Must only be provided if residential_status is other."
}
}
],
"assigned_adviser_uuid": "88ebb909-d3d5-4042-b1a1-f170ead0fa44",
"departments": [
"paraplanner",
"adviser"
],
"groups": [
"410802f5-5b56-4313-9432-875082d6b677",
"3141a433-f4d4-4467-a4cc-d4506de73aff"
],
"adviser_split_uuid": "7c7e52dc-af50-4792-b27b-02b7d4861e90",
"advice_type": "independent",
"next_review_date": "2025-08-25",
"previous_review_date": "2025-06-25",
"anniversary_review_date": "2025-07-25",
"meeting_booking_url": "https://calendly.com/gareth-codepotato",
"inactive_at": "2025-07-25"
}
{
"type": "introducer",
"role": "introducer",
"title": "Mr",
"first_name": "Patrick",
"last_name": "Stanton",
"entity_name": "PatrickCo",
"email": "gareth@codepotato.co.uk",
"send_welcome_email": true,
"phone": "443330509960",
"address": [
{
"name": {
"type": "string",
"example": "Work Address",
"required": false,
"description": "Name of the address"
},
"county": {
"type": "string",
"example": "Hampshire",
"required": false,
"description": "County"
},
"country": {
"type": "string",
"example": "United Kingdom",
"required": false,
"description": "Country"
},
"postcode": {
"type": "string",
"example": "PO7 7YH",
"required": false,
"description": "Postcode"
},
"address_1": {
"type": "string",
"example": "Suite E",
"required": false,
"description": "First line of the address"
},
"address_2": {
"type": "string",
"example": "5 The Briars",
"required": false,
"description": "Second line of the address"
},
"address_3": {
"type": "string",
"example": "Waterberry Drive",
"required": false,
"description": "Third line of the address"
},
"address_4": {
"type": "string",
"example": "The Innovative Centre",
"required": false,
"description": "Fourth line of the address"
},
"town_city": {
"type": "string",
"example": "Waterlooville",
"required": false,
"description": "Town/City"
},
"move_in_date": {
"type": "string",
"example": "2024-06-20",
"required": false,
"description": "Move in date"
},
"moved_in_year": {
"type": "integer",
"example": 2022,
"required": false,
"description": "The year the client moved into this address."
},
"moved_in_month": {
"type": "integer",
"example": 6,
"required": false,
"description": "The month the client moved into this address."
},
"moved_out_year": {
"type": "integer",
"example": 2024,
"required": false,
"description": "The year the client moved out of this address."
},
"moved_out_month": {
"type": "integer",
"example": 1,
"required": false,
"description": "The month the client moved out of this address."
},
"residential_status": {
"type": "string",
"example": "homeowner",
"required": false,
"description": "The client's residential status when living at the address."
},
"residential_status_other": {
"type": "string",
"example": "Non-tenant occupier",
"required": false,
"description": "The client's residential status if it is not provided in the residential_status options. Must only be provided if residential_status is other."
}
}
],
"assigned_adviser_uuid": "52f21497-3386-422d-8337-04ecf80678ef",
"groups": [
"e3dddcaf-c0bf-4937-9774-1e43a5e379d5",
"fa216d54-b814-4a91-a80a-21f9f06027e3"
],
"charge_split_schema_uuid": "8af7620e-f120-43fd-9062-d9ea92fe82c8",
"next_review_date": "2025-08-25",
"previous_review_date": "2025-06-25",
"anniversary_review_date": "2025-07-25",
"inactive_at": "2025-07-25"
}
{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "2f1d51b8-a8c9-4ce6-b43d-0c87f19f85ae",
"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-07-25T15:56:15+01:00",
"updated_at": "2025-07-25T15:56:15+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_account_email": "#828994",
"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_title": "#11151d",
"portal_sidebar_button_active": "#ffffff",
"sidebar_title_secondary_hover": "#ffffff",
"portal_sidebar_button_background": "#f6f6f6"
},
"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": "82980664-38de-4af7-a464-73ce5d04e684",
"colour": "#ef4582",
"created_at": "2025-07-25T15:56:15+01:00",
"updated_at": "2025-07-25T15:56:15+01:00"
}
],
"type": "client",
"uuid": "d6428864-a4f7-42d9-bb72-151f266087fd",
"email": "gareth@codepotato.co.uk",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "70e7eb3d-08da-4570-bd82-1a18bdc533df",
"created_at": "2025-07-25T15:56:15+01:00",
"updated_at": "2025-07-25T15:56:15+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "a46ed6d6-2222-4597-a9ef-d02e9d1cb830",
"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": "69ddf954-fb1a-42d0-9f71-eb388e390d47",
"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": "2025-07-25T15:56:15+01:00",
"first_name": "Gareth",
"updated_at": "2025-07-25T15:56:15+01:00",
"with_login": true,
"inactive_at": "2025-07-25",
"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-07-25T15:56:15+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-07-25T15:56:15+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-07-25T15:56:15+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-07-25T15:56:15+01:00"
}
],
"circles": [
{
"name": "Jones Family",
"uuid": "52ce73b5-01c3-418b-95c6-2c970f3ab924",
"groups": "App\\Http\\Resources\\GroupResource",
"accounts": "App\\Http\\Resources\\MinimalAccountResource",
"bg_colour": "#35f4e1",
"photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
"created_at": "2025-07-25T15:56:15+01:00",
"updated_at": "2025-07-25T15:56:15+01:00",
"joint_account_uuid": "7f5a478a-d00f-437c-a01f-aa6cb5cb4739",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
}
],
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-07-25T15:56:15+01:00",
"first_name": "Gareth",
"updated_at": "2025-07-25T15:56:15+01:00",
"with_login": true,
"inactive_at": "2025-07-25",
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "e6fdb812-ef84-4568-a1c5-cf6bb37f87bd",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-07-25T15:56:15+01:00",
"updated_at": "2025-07-25T15:56:15+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": "004818ab-5d9c-4912-8c5b-fbccdd84da0c",
"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": "2025-07-25T15:56:15+01:00",
"first_name": "Gareth",
"updated_at": "2025-07-25T15:56:15+01:00",
"with_login": true,
"inactive_at": "2025-07-25",
"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-07-25T15:56:15+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-07-25T15:56:15+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-07-25T15:56:15+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-07-25T15:56:15+01:00"
},
"primary_email": {
"name": "Work number",
"type": "phone_number",
"uuid": "f22601c1-6625-4485-91b0-78cf9bc9eb5b",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-07-25T15:56:15+01:00",
"updated_at": "2025-07-25T15:56:15+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": "5c0221f7-ee56-4a2d-991c-6c6ccc4a8700",
"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": "2025-07-25T15:56:15+01:00",
"first_name": "Gareth",
"updated_at": "2025-07-25T15:56:15+01:00",
"with_login": true,
"inactive_at": "2025-07-25",
"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-07-25T15:56:15+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-07-25T15:56:15+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-07-25T15:56:15+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-07-25T15:56:15+01:00"
},
"next_review_date": "2025-07-25T15:56:15+01:00",
"has_joint_account": true,
"current_time_entry": {
"name": "Research",
"uuid": "438166d3-956d-49f9-9b6f-77d96457c11e",
"account": "App\\Http\\Resources\\MinimalAccountResource",
"end_date": "2025-07-25T15:34:15+01:00",
"is_active": true,
"trackable": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2025-07-25T15:56:15+01:00",
"start_date": "2025-07-25T15:06:15+01:00",
"updated_at": "2025-07-25T15:56:15+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-07-25T15:56:15+01:00",
"external_references": [
{
"uuid": "dc109e52-0cac-490d-9bec-fd18a07e9c13",
"reference": "AB123456",
"created_at": "2025-07-25T15:56:15+01:00",
"updated_at": "2025-07-25T15:56:15+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": "1f9711ce-50a0-43c2-ba91-85bc664ed130",
"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": "2025-07-25T15:56:15+01:00",
"first_name": "Gareth",
"updated_at": "2025-07-25T15:56:15+01:00",
"with_login": true,
"inactive_at": "2025-07-25",
"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-07-25T15:56:15+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-07-25T15:56:15+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-07-25T15:56:15+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-07-25T15:56:15+01:00"
},
"joint_account_circle": {
"name": "Jones Family",
"uuid": "33f21152-d8d1-467e-b73b-49d58f076129",
"groups": "App\\Http\\Resources\\GroupResource",
"accounts": "App\\Http\\Resources\\MinimalAccountResource",
"bg_colour": "#35f4e1",
"photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
"created_at": "2025-07-25T15:56:15+01:00",
"updated_at": "2025-07-25T15:56:15+01:00",
"joint_account_uuid": "687917bc-ef7e-4f7c-ab4e-b612863018a6",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"ownership_percentage": 100,
"previous_review_date": "2025-07-25T15:56:15+01:00",
"primary_phone_number": {
"name": "Work number",
"type": "phone_number",
"uuid": "bbb8698f-e400-4663-945e-f31d3ab9f2fe",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-07-25T15:56:15+01:00",
"updated_at": "2025-07-25T15:56:15+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": "7ff0d868-cf19-40e4-9a85-ed9b99b9af2f",
"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": "2025-07-25T15:56:15+01:00",
"first_name": "Gareth",
"updated_at": "2025-07-25T15:56:15+01:00",
"with_login": true,
"inactive_at": "2025-07-25",
"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-07-25T15:56:15+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-07-25T15:56:15+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-07-25T15:56:15+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-07-25T15:56:15+01:00"
},
"anniversary_review_date": "2025-07-25T15:56:15+01:00"
}