POST
/api/v1/account
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":"b2d7c116-5682-4ce8-b63e-1c0c787a910e","assigned_administrator_uuid":"208ad0bb-978b-4b30-8d10-09746f6269a4","assigned_paraplanner_uuid":"903ab7f6-8ff0-4417-8a6f-93a695cba457","introduced_by_uuid":"31375e85-d415-4508-a0b0-231b56bfbb12","date_of_birth":"1975-09-26","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-09-26","residential_status":"settled","country_of_residence":"United Kingdom","marital_status":"married","is_vulnerable":"possibly","is_prospect":false,"prospect_converted_at":"2025-09-26T13:23:31+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-09-26","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-09-25","has_power_of_attorney":true,"power_of_attorney_notes":"Notes on the client's power of attorney.","first_contact_date":"2025-08-26","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-10-26","previous_review_date":"2025-08-26","anniversary_review_date":"2025-09-26","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-09-26T00:00:00+01:00","will_poa_details":"string","are_poa_documents_registered":true,"will_gifts_details":"string","groups":["b4df8adc-06ca-4466-bc34-1525880ed4a5","b9ce6cb1-acd2-4d34-80ad-a03a4e8c3bb1"],"is_in_receipt_of_your_state_pension":true,"has_obtained_a_forecast":true,"date_of_forecast":"2025-09-26T13:23:31+01:00","projected_state_pension":50000,"years_of_national_insurance_contributions":5,"pension_notes":"string","status_uuid":"39dc18e2-be40-48e4-94cb-58c145edb631","current_life_stage_uuid":"0de90b1d-b32c-4e73-8d3e-3b32e42e9e68","date_of_marriage":"2025-09-26","is_deceased":false,"deceased_at":"2025-09-26","is_married_to_partner":true,"checked_sanctions_at":"2025-09-26","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-09-26","circles":[{"uuid":null,"login_access_level":"write"}],"external_reference":[{"reference":"AB123456","third_party":"nucleus"}],"owners":[null,null],"shareholders":[],"shareholders.*.full_name":"John Smith","shareholders.*.role":"Director","shareholders.*.appointed_at":"2025-09-26","shareholders.*.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."}}],"shareholders.*.percentage":60,"shareholders.*.shares_owned":20,"shareholders.*.voting_rights":"Right to appoint or remove directors","incomes":[],"incomes.*.name":"State Pension","incomes.*.type":"pension","incomes.*.amount":20000,"incomes.*.amount_type":"net","incomes.*.start_date":"2025-09-26","incomes.*.end_date":"2025-09-26","incomes.*.frequency":"monthly","incomes.*.is_taxable":false,"business_details":[],"business_details.status":"Insolvent","business_details.status_comments":"This was due to an accounting error","business_details.type":"Public Limited Company","business_details.type_comments":"They became a Public Limited Company after May 2025","business_details.incorporated_on":"2025-09-26","business_details.business_registered_address":[],"business_details.business_registered_address.name":"Work Address","business_details.business_registered_address.address_1":"Suite E","business_details.business_registered_address.address_2":"5 The Briars","business_details.business_registered_address.address_3":"Waterberry Drive","business_details.business_registered_address.address_4":"The Innovative Centre","business_details.business_registered_address.town_city":"Waterlooville","business_details.business_registered_address.county":"Hampshire","business_details.business_registered_address.postcode":"PO7 7YH","business_details.business_registered_address.country":"United Kingdom","business_details.nature":"Construction","business_details.uk_sic_code":"12345","business_details.companies_house_number":"OC999999","business_details.year_end_day":11,"business_details.year_end_month":7,"business_details.firm_website":"www.google.com","business_details.employee_count":30,"business_details.self_employed_staff_count":30,"business_details.business_value":45000000,"business_details.is_registered_vat":false,"business_details.vat_number":"12345","business_details.accountant_company":"Accurate Accounting","business_details.accountant_name":"Andy Accountant","business_details.business_accountant_address":[],"business_details.business_accountant_address.name":"Work Address","business_details.business_accountant_address.address_1":"Suite E","business_details.business_accountant_address.address_2":"5 The Briars","business_details.business_accountant_address.address_3":"Waterberry Drive","business_details.business_accountant_address.address_4":"The Innovative Centre","business_details.business_accountant_address.town_city":"Waterlooville","business_details.business_accountant_address.county":"Hampshire","business_details.business_accountant_address.postcode":"PO7 7YH","business_details.business_accountant_address.country":"United Kingdom","business_details.legal_adviser_name":"Lenny Legal","business_details.business_legal_adviser_address":[],"business_details.business_legal_adviser_address.name":"Work Address","business_details.business_legal_adviser_address.address_1":"Suite E","business_details.business_legal_adviser_address.address_2":"5 The Briars","business_details.business_legal_adviser_address.address_3":"Waterberry Drive","business_details.business_legal_adviser_address.address_4":"The Innovative Centre","business_details.business_legal_adviser_address.town_city":"Waterlooville","business_details.business_legal_adviser_address.county":"Hampshire","business_details.business_legal_adviser_address.postcode":"PO7 7YH","business_details.business_legal_adviser_address.country":"United Kingdom","business_details.auditor_name":"Andy Audit","business_details.business_auditor_address":[],"business_details.business_auditor_address.name":"Work Address","business_details.business_auditor_address.address_1":"Suite E","business_details.business_auditor_address.address_2":"5 The Briars","business_details.business_auditor_address.address_3":"Waterberry Drive","business_details.business_auditor_address.address_4":"The Innovative Centre","business_details.business_auditor_address.town_city":"Waterlooville","business_details.business_auditor_address.county":"Hampshire","business_details.business_auditor_address.postcode":"PO7 7YH","business_details.business_auditor_address.country":"United Kingdom","business_details.data_protection_officer":"Dave Data","business_details.primary_contacts":[],"business_details.primary_contacts.*.uuid":"8b42731c-d67f-4e58-b098-3ac944622ab1","business_details.primary_contacts.*.name":"Jane Doe","business_details.primary_contacts.*.email":"janedoe@primarycontact.com","business_details.primary_contacts.*.address":[],"business_details.primary_contacts.*.address.name":"Work Address","business_details.primary_contacts.*.address.address_1":"Suite E","business_details.primary_contacts.*.address.address_2":"5 The Briars","business_details.primary_contacts.*.address.address_3":"Waterberry Drive","business_details.primary_contacts.*.address.address_4":"The Innovative Centre","business_details.primary_contacts.*.address.town_city":"Waterlooville","business_details.primary_contacts.*.address.county":"Hampshire","business_details.primary_contacts.*.address.postcode":"PO7 7YH","business_details.primary_contacts.*.address.country":"United Kingdom"}'
Request examples
Create client account
{
"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": "b2d7c116-5682-4ce8-b63e-1c0c787a910e",
"assigned_administrator_uuid": "208ad0bb-978b-4b30-8d10-09746f6269a4",
"assigned_paraplanner_uuid": "903ab7f6-8ff0-4417-8a6f-93a695cba457",
"introduced_by_uuid": "31375e85-d415-4508-a0b0-231b56bfbb12",
"date_of_birth": "1975-09-26",
"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-09-26",
"residential_status": "settled",
"country_of_residence": "United Kingdom",
"marital_status": "married",
"is_vulnerable": "possibly",
"is_prospect": false,
"prospect_converted_at": "2025-09-26T13:23:31+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-09-26",
"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-09-25",
"has_power_of_attorney": true,
"power_of_attorney_notes": "Notes on the client's power of attorney.",
"first_contact_date": "2025-08-26",
"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-10-26",
"previous_review_date": "2025-08-26",
"anniversary_review_date": "2025-09-26",
"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-09-26T00:00:00+01:00",
"will_poa_details": "string",
"are_poa_documents_registered": true,
"will_gifts_details": "string",
"groups": [
"b4df8adc-06ca-4466-bc34-1525880ed4a5",
"b9ce6cb1-acd2-4d34-80ad-a03a4e8c3bb1"
],
"is_in_receipt_of_your_state_pension": true,
"has_obtained_a_forecast": true,
"date_of_forecast": "2025-09-26T13:23:31+01:00",
"projected_state_pension": 50000,
"years_of_national_insurance_contributions": 5,
"pension_notes": "string",
"status_uuid": "39dc18e2-be40-48e4-94cb-58c145edb631",
"current_life_stage_uuid": "0de90b1d-b32c-4e73-8d3e-3b32e42e9e68",
"date_of_marriage": "2025-09-26",
"is_deceased": false,
"deceased_at": "2025-09-26",
"is_married_to_partner": true,
"checked_sanctions_at": "2025-09-26",
"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-09-26",
"circles": [
{
"uuid": null,
"login_access_level": "write"
}
],
"external_reference": [
{
"reference": "AB123456",
"third_party": "nucleus"
}
],
"owners": [
null,
null
],
"shareholders": [],
"shareholders.*.full_name": "John Smith",
"shareholders.*.role": "Director",
"shareholders.*.appointed_at": "2025-09-26",
"shareholders.*.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."
}
}
],
"shareholders.*.percentage": 60,
"shareholders.*.shares_owned": 20,
"shareholders.*.voting_rights": "Right to appoint or remove directors",
"incomes": [],
"incomes.*.name": "State Pension",
"incomes.*.type": "pension",
"incomes.*.amount": 20000,
"incomes.*.amount_type": "net",
"incomes.*.start_date": "2025-09-26",
"incomes.*.end_date": "2025-09-26",
"incomes.*.frequency": "monthly",
"incomes.*.is_taxable": false,
"business_details": [],
"business_details.status": "Insolvent",
"business_details.status_comments": "This was due to an accounting error",
"business_details.type": "Public Limited Company",
"business_details.type_comments": "They became a Public Limited Company after May 2025",
"business_details.incorporated_on": "2025-09-26",
"business_details.business_registered_address": [],
"business_details.business_registered_address.name": "Work Address",
"business_details.business_registered_address.address_1": "Suite E",
"business_details.business_registered_address.address_2": "5 The Briars",
"business_details.business_registered_address.address_3": "Waterberry Drive",
"business_details.business_registered_address.address_4": "The Innovative Centre",
"business_details.business_registered_address.town_city": "Waterlooville",
"business_details.business_registered_address.county": "Hampshire",
"business_details.business_registered_address.postcode": "PO7 7YH",
"business_details.business_registered_address.country": "United Kingdom",
"business_details.nature": "Construction",
"business_details.uk_sic_code": "12345",
"business_details.companies_house_number": "OC999999",
"business_details.year_end_day": 11,
"business_details.year_end_month": 7,
"business_details.firm_website": "www.google.com",
"business_details.employee_count": 30,
"business_details.self_employed_staff_count": 30,
"business_details.business_value": 45000000,
"business_details.is_registered_vat": false,
"business_details.vat_number": "12345",
"business_details.accountant_company": "Accurate Accounting",
"business_details.accountant_name": "Andy Accountant",
"business_details.business_accountant_address": [],
"business_details.business_accountant_address.name": "Work Address",
"business_details.business_accountant_address.address_1": "Suite E",
"business_details.business_accountant_address.address_2": "5 The Briars",
"business_details.business_accountant_address.address_3": "Waterberry Drive",
"business_details.business_accountant_address.address_4": "The Innovative Centre",
"business_details.business_accountant_address.town_city": "Waterlooville",
"business_details.business_accountant_address.county": "Hampshire",
"business_details.business_accountant_address.postcode": "PO7 7YH",
"business_details.business_accountant_address.country": "United Kingdom",
"business_details.legal_adviser_name": "Lenny Legal",
"business_details.business_legal_adviser_address": [],
"business_details.business_legal_adviser_address.name": "Work Address",
"business_details.business_legal_adviser_address.address_1": "Suite E",
"business_details.business_legal_adviser_address.address_2": "5 The Briars",
"business_details.business_legal_adviser_address.address_3": "Waterberry Drive",
"business_details.business_legal_adviser_address.address_4": "The Innovative Centre",
"business_details.business_legal_adviser_address.town_city": "Waterlooville",
"business_details.business_legal_adviser_address.county": "Hampshire",
"business_details.business_legal_adviser_address.postcode": "PO7 7YH",
"business_details.business_legal_adviser_address.country": "United Kingdom",
"business_details.auditor_name": "Andy Audit",
"business_details.business_auditor_address": [],
"business_details.business_auditor_address.name": "Work Address",
"business_details.business_auditor_address.address_1": "Suite E",
"business_details.business_auditor_address.address_2": "5 The Briars",
"business_details.business_auditor_address.address_3": "Waterberry Drive",
"business_details.business_auditor_address.address_4": "The Innovative Centre",
"business_details.business_auditor_address.town_city": "Waterlooville",
"business_details.business_auditor_address.county": "Hampshire",
"business_details.business_auditor_address.postcode": "PO7 7YH",
"business_details.business_auditor_address.country": "United Kingdom",
"business_details.data_protection_officer": "Dave Data",
"business_details.primary_contacts": [],
"business_details.primary_contacts.*.uuid": "8b42731c-d67f-4e58-b098-3ac944622ab1",
"business_details.primary_contacts.*.name": "Jane Doe",
"business_details.primary_contacts.*.email": "janedoe@primarycontact.com",
"business_details.primary_contacts.*.address": [],
"business_details.primary_contacts.*.address.name": "Work Address",
"business_details.primary_contacts.*.address.address_1": "Suite E",
"business_details.primary_contacts.*.address.address_2": "5 The Briars",
"business_details.primary_contacts.*.address.address_3": "Waterberry Drive",
"business_details.primary_contacts.*.address.address_4": "The Innovative Centre",
"business_details.primary_contacts.*.address.town_city": "Waterlooville",
"business_details.primary_contacts.*.address.county": "Hampshire",
"business_details.primary_contacts.*.address.postcode": "PO7 7YH",
"business_details.primary_contacts.*.address.country": "United Kingdom"
}
{
"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": "817124e0-58a2-4e18-ab86-cf9e04f46043",
"departments": [
"paraplanner",
"adviser"
],
"groups": [
"74f8695d-c380-4750-a7df-6643235fee60",
"b641e988-777f-400f-a127-d9c18e44564c"
],
"adviser_split_uuid": "00defadb-52d4-4c12-b763-2d28440112de",
"advice_type": "independent",
"next_review_date": "2025-10-26",
"previous_review_date": "2025-08-26",
"anniversary_review_date": "2025-09-26",
"meeting_booking_url": "https://calendly.com/gareth-codepotato",
"inactive_at": "2025-09-26"
}
{
"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": "c67c5639-882d-49e3-9d03-f7987a64f620",
"groups": [
"b2b4548a-68d1-4a34-95d9-7128e13a2135",
"40842fc6-3c24-49c7-b9da-0000f88c9705"
],
"charge_split_schema_uuid": "b86f5a22-c5a4-4432-acc0-0f021c26e129",
"next_review_date": "2025-10-26",
"previous_review_date": "2025-08-26",
"anniversary_review_date": "2025-09-26",
"inactive_at": "2025-09-26"
}
Response examples (200)
{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "1e9c0092-a8bf-4b84-bcd1-bb24d78ddfc3",
"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-09-26T13:23:31+01:00",
"updated_at": "2025-09-26T13:23:31+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": "transparent",
"portal_sidebar_user_select_border": "#EEEEEE",
"portal_sidebar_collapse_button_hover": "#B3B9C4",
"portal_sidebar_user_select_background": "transparent",
"portal_sidebar_user_select_text_hover": "#323B4B",
"portal_sidebar_user_select_border_hover": "#828994"
},
"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": "92e08a4d-20fa-4cb2-869e-e28d6239b73d",
"colour": "#ef4582",
"created_at": "2025-09-26T13:23:31+01:00",
"updated_at": "2025-09-26T13:23:31+01:00"
}
],
"type": "client",
"uuid": "f211461d-e8fc-4b30-bc9e-76f8a28f1cad",
"email": "gareth@codepotato.co.uk",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "2140c000-3619-4937-bfd0-d53aa03aa937",
"created_at": "2025-09-26T13:23:31+01:00",
"updated_at": "2025-09-26T13:23:31+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "72ed815c-2068-49a2-9e9c-34154fe2071c",
"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": "bdb40959-c965-4abe-8994-3b1cf7d032ec",
"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-09-26T13:23:31+01:00",
"first_name": "Gareth",
"updated_at": "2025-09-26T13:23:31+01:00",
"with_login": true,
"inactive_at": "2025-09-26",
"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-09-26T13:23:31+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-09-26T13:23:31+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-09-26T13:23:31+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-09-26T13:23:31+01:00"
}
],
"circles": [
{
"name": "Jones Family",
"uuid": "ef174444-52a0-4f5b-ba46-bfe8d9ddc0bd",
"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-09-26T13:23:31+01:00",
"updated_at": "2025-09-26T13:23:31+01:00",
"joint_account_uuid": "486e2d5e-bad8-4805-8b2f-f6dcd5cdeada",
"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": "2025-09-26T13:23:31+01:00",
"first_name": "Gareth",
"updated_at": "2025-09-26T13:23:31+01:00",
"with_login": true,
"inactive_at": "2025-09-26",
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "f1b10ed7-745c-43f2-9fe7-b48f6fd24f27",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-09-26T13:23:31+01:00",
"updated_at": "2025-09-26T13:23:31+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": "8a80bb1b-649f-4c7d-a98a-984963c23c0d",
"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-09-26T13:23:31+01:00",
"first_name": "Gareth",
"updated_at": "2025-09-26T13:23:31+01:00",
"with_login": true,
"inactive_at": "2025-09-26",
"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-09-26T13:23:31+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-09-26T13:23:31+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-09-26T13:23:31+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-09-26T13:23:31+01:00"
},
"primary_email": {
"name": "Work number",
"type": "phone_number",
"uuid": "dee7b2e7-a14d-4eee-ba12-32585d35235b",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-09-26T13:23:31+01:00",
"updated_at": "2025-09-26T13:23:31+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": "afac342a-db78-4cfe-8229-c86e8842aee6",
"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-09-26T13:23:31+01:00",
"first_name": "Gareth",
"updated_at": "2025-09-26T13:23:31+01:00",
"with_login": true,
"inactive_at": "2025-09-26",
"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-09-26T13:23:31+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-09-26T13:23:31+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-09-26T13:23:31+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-09-26T13:23:31+01:00"
},
"next_review_date": "2025-09-26T13:23:31+01:00",
"has_joint_account": true,
"current_time_entry": {
"name": "Research",
"uuid": "3976ec17-d1c0-4ea6-8e16-84da86b1a101",
"account": "App\\Http\\Resources\\MinimalAccountResource",
"end_date": "2025-09-26T13:01:31+01:00",
"is_active": true,
"trackable": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2025-09-26T13:23:31+01:00",
"start_date": "2025-09-26T12:33:31+01:00",
"updated_at": "2025-09-26T13:23:31+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-09-26T13:23:31+01:00",
"external_references": [
{
"uuid": "6d184f27-3c7e-4ea4-83bf-c4fdc89aab52",
"reference": "AB123456",
"created_at": "2025-09-26T13:23:31+01:00",
"updated_at": "2025-09-26T13:23:31+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": "27503ba9-9b66-4b42-8590-1ee3b84d82d4",
"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-09-26T13:23:31+01:00",
"first_name": "Gareth",
"updated_at": "2025-09-26T13:23:31+01:00",
"with_login": true,
"inactive_at": "2025-09-26",
"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-09-26T13:23:31+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-09-26T13:23:31+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-09-26T13:23:31+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-09-26T13:23:31+01:00"
},
"joint_account_circle": {
"name": "Jones Family",
"uuid": "09090f29-e1d7-42e6-86be-7e6a1a0cda95",
"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-09-26T13:23:31+01:00",
"updated_at": "2025-09-26T13:23:31+01:00",
"joint_account_uuid": "d88cfc7b-349d-4524-b923-ffe0c8944bca",
"login_access_level": "write",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"ownership_percentage": 100,
"previous_review_date": "2025-09-26T13:23:31+01:00",
"primary_phone_number": {
"name": "Work number",
"type": "phone_number",
"uuid": "b159ffb6-5b92-4aae-9c1a-9f88ae149d42",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-09-26T13:23:31+01:00",
"updated_at": "2025-09-26T13:23:31+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": "a0d2987b-ce81-4c36-89b5-060df9a8f3b1",
"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-09-26T13:23:31+01:00",
"first_name": "Gareth",
"updated_at": "2025-09-26T13:23:31+01:00",
"with_login": true,
"inactive_at": "2025-09-26",
"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-09-26T13:23:31+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-09-26T13:23:31+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-09-26T13:23:31+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-09-26T13:23:31+01:00"
},
"anniversary_review_date": "2025-09-26T13:23:31+01:00"
}