Headers
-
Content-Type
string -
Accept
string
Body
-
Client
array[string] Client route
-
Employee
array[string] Employee route
-
Introducer
array[string] Introducer route
POST
/api/v1/account
curl \
--request POST 'https://api.plannrcrm.com/api/v1/account' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data '{"Client":[{"email":{"type":"string","example":"gareth@codepotato.co.uk","required":false,"description":"Email address"},"phone":{"type":"string","example":"443330509960","required":false,"description":"Phone number"},"title":{"type":"string","example":"Mr","required":false,"description":"Title"},"value":{"type":"integer","example":500000,"required":false,"description":"The value of the client in penny format. E.g £5,000 would be 500000."},"gender":{"type":"string","example":"Male","required":false,"description":"Gender. Possible values are: male, female, non-binary, transgender, intersex, other and unknown"},"groups":{"type":"array","example":["488b9e08-3877-4e31-9107-f1a72e159e86","e70ba8ca-c710-47ed-a093-71657cfee198"],"required":false,"description":"Group UUIDs to sync client to."},"height":{"type":"integer","example":186,"required":false,"description":"The height of the client in centimeters."},"weight":{"type":"integer","example":220,"required":false,"description":"The weight of the client in pounds."},"address":{"type":"array","example":{"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."}},"required":false,"description":"Address"},"has_will":{"type":"boolean","example":false,"required":false,"description":"Whether the client has a will or not."},"nickname":{"type":"string","example":"G","required":false,"description":"preferred nickname of the client"},"pronouns":{"type":"string","example":"he/him","required":false,"description":"Pronouns"},"last_name":{"type":"string","example":"Thompson","required":true,"description":"Last Name"},"ni_number":{"type":"string","example":"AB 12 34 56 C","required":false,"description":"National Insurance Number"},"first_name":{"type":"string","example":"Gareth","required":true,"description":"First Name"},"gift_notes":{"type":"string","example":"Notes on the gifts.","required":false,"description":"Notes on the gifts."},"will_notes":{"type":"string","example":"Notes on the client's will.","required":false,"description":"Notes on the client's will."},"deceased_at":{"type":"date","example":"2025-06-22","required":false,"description":"Date of death"},"inactive_at":{"type":"date","example":"2025-06-22","required":false,"description":"Inactive from date"},"is_deceased":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client is deceased"},"is_prospect":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client is a prospect or not."},"lead_source":{"type":"string","example":"LeadGen Company","required":false,"description":"Marks the lead source of the client"},"maiden_name":{"type":"string","example":"Thompson","required":false,"description":"Maiden Name"},"middle_name":{"type":"string","example":"Alex","required":false,"description":"Middle Name"},"status_uuid":{"type":"string","example":"ad85fe3d-7062-4aad-9323-6fe49d9e94db","required":false,"description":"The status of the client."},"do_not_visit":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client can be visited"},"health_notes":{"type":"string","example":"Notes on the client's health.","required":false,"description":"Notes on the client's health."},"smoker_since":{"type":"date","example":"2015-06-22","required":false,"description":"The date of when the client started smoking."},"date_of_birth":{"type":"date","example":"1975-06-22","required":false,"description":"Date of birth"},"do_not_market":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client can be marketed to"},"is_vulnerable":{"type":"string","example":"possibly","required":false,"description":"whether the client is vulnerable. Possible values are: \"yes\", \"no\", and \"possibly\""},"nationalities":{"type":"array","example":["British","Romanian"],"required":false,"description":"Nationalities of the client. You can use the api/v1/static/nationalities endpoint to get our list."},"pension_notes":{"type":"string","example":"","required":false,"description":"Notes on the pension"},"smoker_status":{"type":"string","example":"non-smoker","required":false,"description":"Smoker Status. Possible values are: smoker, non-smoker, vaper, ex-smoker, never-smoked, unknown"},"will_location":{"type":"string","example":"","required":false,"description":"Where is the will stored?"},"write_to_whom":{"type":"string","example":"Gareth","required":false,"description":"Marks the name of the client to write to"},"is_uk_domicile":{"type":"boolean","example":true,"required":false,"description":"Whether the client is a UK domicile or not."},"is_uk_resident":{"type":"boolean","example":true,"required":false,"description":"Whether the client is a UK resident or not."},"marital_status":{"type":"string","example":"married","required":false,"description":"Marital Status. Possible values are: single, cohabiting, married, divorced, civil-partnership, dissolved-civil-partnership, widowed, separated, engaged, in-relationship, other, unknown"},"will_executors":{"type":"string","example":"","required":false,"description":"Who are the executors?"},"passport_number":{"type":"string","example":"123456","required":false,"description":"The passport number of the client"},"cigarettes_daily":{"type":"integer","example":6,"required":false,"description":"The amount of cigarettes the client smokes a day."},"date_of_forecast":{"type":"date","example":"2025-06-22T11:45:30+01:00","required":false,"description":"What is the date of the obtained forecast"},"date_of_marriage":{"type":"date","example":"2025-06-22","required":false,"description":"Date of marriage"},"has_iht_planning":{"type":"boolean","example":true,"required":false,"description":"Whether the client has Inheritance Tax (IHT) planning or not."},"is_will_accurate":{"type":"boolean","example":true,"required":false,"description":"Does your current will reflect your wishes?"},"next_review_date":{"type":"date","example":"2025-07-22","required":false,"description":"Date of next review"},"will_poa_details":{"type":"string","example":"","required":false,"description":"Who are the Attorney’s?"},"has_gifted_family":{"type":"boolean","example":true,"required":false,"description":"Whether the client has gifted the family."},"client_preferences":{"type":"string","example":"Prefers telephone calls in the morning.","required":false,"description":"Any client preferences."},"external_reference":{"type":"array","example":{"reference":"AB123456","third_party":"nucleus"},"required":false,"description":"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, nucleus, parmenion, seccl, smartsearch, soderberg and transact_remuneration"},"first_contact_date":{"type":"date","example":"2025-05-22","required":false,"description":"The date of the first contact."},"iht_planning_notes":{"type":"string","example":"Notes on the client's Inheritance Tax (IHT) planning.","required":false,"description":"Notes on the client's Inheritance Tax (IHT) planning."},"introduced_by_uuid":{"type":"string","example":"714ebf80-01e5-4a3e-9e5e-08db36af32a8","required":false,"description":"The UUID of the introducer for this client"},"residential_status":{"type":"string","example":"settled","required":false,"description":"Residential status"},"send_welcome_email":{"type":"boolean","example":true,"required":false,"description":"Send an email on account creation and create a login"},"will_gifts_details":{"type":"string","example":"","required":false,"description":"Notes of gifts"},"will_last_reviewed":{"type":"date","example":"2025-06-21","required":false,"description":"The date of the last time the will's been reviewed."},"third_party_offered":{"type":"boolean","example":true,"required":false,"description":"Whether the client has been offered any third party."},"checked_sanctions_at":{"type":"date","example":"2025-06-22","required":false,"description":"Date the client was checked for sanctions"},"country_of_residence":{"type":"string","example":"United Kingdom","required":false,"description":"Country of residence"},"long_term_care_notes":{"type":"string","example":"Notes on the client's long term care.","required":false,"description":"Notes on the client's long term care."},"previous_review_date":{"type":"date","example":"2025-05-22","required":false,"description":"Date of previous review"},"procedure_adaptation":{"type":"boolean","example":true,"required":false,"description":"Whether any procedures need to be adapted to the client."},"state_retirement_age":{"type":"integer","example":60,"required":false,"description":"The state retirement age."},"will_bequests_detail":{"type":"string","example":"","required":false,"description":"Details of any Bequests"},"assigned_adviser_uuid":{"type":"string","example":"eba5b8b0-17b5-4c6c-b6f5-1596c88065a5","required":false,"description":"The UUID of the employee that the client directly reports to"},"has_power_of_attorney":{"type":"boolean","example":true,"required":false,"description":"Whether the client has power of attorney."},"is_married_to_partner":{"type":"boolean","example":true,"required":false,"description":"Denotes if the client is married to their partner"},"long_term_care_needed":{"type":"boolean","example":false,"required":false,"description":"Whether the client required long term care."},"prospect_converted_at":{"type":"date","example":"2025-06-22T11:45:30+01:00","required":false,"description":"The datetime when the prospect was converted into a client."},"target_retirement_age":{"type":"integer","example":60,"required":false,"description":"Targest retirement age."},"vulnerability_details":{"type":"string","example":"No vulnerabilities","required":false,"description":"Any details regarding the client's vulnerabilities."},"adaption_details_notes":{"type":"boolean","example":"Adaptation notes","required":false,"description":"Any notes regarding adaptations"},"do_not_contact_via_fax":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client can be contacted via fax"},"do_not_contact_via_sms":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client can be contacted via SMS"},"anniversary_review_date":{"type":"date","example":"2025-06-22","required":false,"description":"Anniversary review date"},"current_life_stage_uuid":{"type":"string","example":"3f9921f5-84cd-485b-ac61-c6adb7c6a68d","required":false,"description":"The clients current life stage for expenditure. Defaults to first available to firm if not provided."},"current_state_of_health":{"type":"string","example":"Fit and healthy","required":false,"description":"The client's current state of health."},"do_not_contact_via_mail":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client can be contacted via mail"},"expected_retirement_age":{"type":"integer","example":60,"required":false,"description":"The expected retirement age."},"has_obtained_a_forecast":{"type":"boolean","example":true,"required":false,"description":"Have you recently obtained a forecast"},"power_of_attorney_notes":{"type":"string","example":"Notes on the client's power of attorney.","required":false,"description":"Notes on the client's power of attorney."},"projected_state_pension":{"type":"integer","example":50000,"required":false,"description":"What is the projected State Pension"},"units_of_alcohol_weekly":{"type":"integer","example":28,"required":false,"description":"The units of alcohol digested weekly."},"do_not_contact_via_email":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client can be contacted via email"},"assigned_paraplanner_uuid":{"type":"string","example":"99ae260e-1339-4db7-beba-0a838ecc30a3","required":false,"description":"The UUID of the paraplanner employee that the client has been assigned"},"poa_attorney_appointed_at":{"type":"date","example":"2025-06-22T00:00:00+01:00","required":false,"description":"When were the Attorney’s appointed?"},"assigned_administrator_uuid":{"type":"string","example":"0a8ead17-6c7a-4efb-b8ff-498d4c7875e3","required":false,"description":"The UUID of the adviser employee that the client has been assigned"},"is_anticipating_inheritance":{"type":"boolean","example":true,"required":false,"description":"Whether the client is anticipating/ expecting any inheritance."},"state_of_health_explanation":{"type":"string","example":"Explanation of the current state of health.","required":false,"description":"Explanation of the current state of health."},"are_poa_documents_registered":{"type":"boolean","example":true,"required":false,"description":"Are the documents registered?"},"do_not_contact_via_telephone":{"type":"boolean","example":false,"required":false,"description":"Denotes if the client can be contacted via telephone"},"is_poa_registered_epa_or_lpa":{"type":"string","example":"epa","required":false,"description":"Is the Power of Attorney Registered as a EPA or LPA"},"anticipating_inheritance_notes":{"type":"string","example":"Notes on the client's inheritance anticipation/ expectations.","required":false,"description":"Notes on the client's inheritance anticipation/ expectations."},"last_used_nicotine_products_date":{"type":"date","example":"2024-06-22","required":false,"description":"The date of the last time the client used nicotine products."},"is_in_receipt_of_your_state_pension":{"type":"boolean","example":true,"required":false,"description":"Are you in receipt of your State Pension"},"are_poa_appointed_for_health_or_wealth":{"type":"string","example":"health","required":false,"description":"Are the Attorneys appointed for Health, Wealth or Both?"},"years_of_national_insurance_contributions":{"type":"integer","example":5,"required":false,"description":"How many years have you made Nation Insurance Contributions"}}],"Employee":[{"role":{"type":"string","example":"owner","required":true,"description":"The role of the employee."},"email":{"type":"string","example":"gareth@codepotato.co.uk","required":false,"description":"Email address"},"phone":{"type":"string","example":"443330509960","required":false,"description":"Phone number"},"groups":{"type":"array","example":["13d19e87-72d1-4799-b933-30b9ff767a9b","a4045919-6e93-4b87-8629-69a06b3d4cb0"],"required":false,"description":"Group uuids belonging to the firm."},"address":{"type":"array","example":{"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."}},"required":false,"description":"Address"},"last_name":{"type":"string","example":"Thompson","required":true,"description":"The last name of the employee."},"first_name":{"type":"string","example":"Gareth","required":true,"description":"The first name of the employee."},"advice_type":{"type":"string","example":"independent","required":false,"description":"Employee's RMAR advice type"},"departments":{"type":"array","example":["paraplanner","adviser"],"required":true,"description":"The departments the employee is part of"},"inactive_at":{"type":"date","example":"2025-06-22","required":false,"description":"Inactive from date"},"next_review_date":{"type":"date","example":"2025-07-22","required":false,"description":"Date of next review"},"adviser_split_uuid":{"type":"string","example":"8537a1a0-37ec-4616-810f-6d1652ee0471","required":false,"description":"The uuid of the the adviser split that will be applied when this adviser adds charges"},"send_welcome_email":{"type":"boolean","example":true,"required":true,"description":"Send an email on account creation and create a login"},"meeting_booking_url":{"type":"string","example":"https://calendly.com/gareth-codepotato","required":false,"description":"Employee's meeting booking URL"},"previous_review_date":{"type":"date","example":"2025-05-22","required":false,"description":"Date of previous review"},"assigned_adviser_uuid":{"type":"string","example":"2eaa465c-9704-4665-be99-d400f263b6ab","required":false,"description":"a532f96e-3ada-4fa2-a407-16102b163495"},"anniversary_review_date":{"type":"date","example":"2025-06-22","required":false,"description":"Anniversary review date"}}],"Introducer":[{"email":{"type":"string","example":"gareth@codepotato.co.uk","required":false,"description":"Email address"},"phone":{"type":"string","example":"443330509960","required":false,"description":"Phone number"},"title":{"type":"string","example":"Mr","required":false,"description":"Title"},"groups":{"type":"array","example":["3de13b54-faa4-448f-a94f-6af16e6628ec","3a3a1dbc-c47d-4bbe-83a7-677a840fc6b8"],"required":false,"description":"Group uuids belonging to the firm."},"address":{"type":"array","example":{"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."}},"required":false,"description":"Address"},"last_name":{"type":"string","example":"Stanton","required":true,"description":"Last name"},"first_name":{"type":"string","example":"Patrick","required":true,"description":"First name"},"entity_name":{"type":"string","example":"PatrickCo","required":true,"description":"Entity/business name"},"inactive_at":{"type":"date","example":"2025-06-22","required":false,"description":"Inactive from date"},"next_review_date":{"type":"date","example":"2025-07-22","required":false,"description":"Date of next review"},"send_welcome_email":{"type":"boolean","example":true,"required":false,"description":"Send an email on account creation and create a login"},"previous_review_date":{"type":"date","example":"2025-05-22","required":false,"description":"Date of previous review"},"assigned_adviser_uuid":{"type":"string","example":"fecc898b-e56c-455a-a171-93d0b759de68","required":false,"description":"UUID of the account that this account reports to"},"anniversary_review_date":{"type":"date","example":"2025-06-22","required":false,"description":"Anniversary review date"},"charge_split_schema_uuid":{"type":"string","example":"3cb384a2-79ba-40a3-a1f0-d87c07adfe7d","required":false,"description":"Charge split schema that is always used when adding a charge split for this introducer"}}]}'
Request examples
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
# Payload
{
"Client": [
{
"email": {
"type": "string",
"example": "gareth@codepotato.co.uk",
"required": false,
"description": "Email address"
},
"phone": {
"type": "string",
"example": "443330509960",
"required": false,
"description": "Phone number"
},
"title": {
"type": "string",
"example": "Mr",
"required": false,
"description": "Title"
},
"value": {
"type": "integer",
"example": 500000,
"required": false,
"description": "The value of the client in penny format. E.g £5,000 would be 500000."
},
"gender": {
"type": "string",
"example": "Male",
"required": false,
"description": "Gender. Possible values are: male, female, non-binary, transgender, intersex, other and unknown"
},
"groups": {
"type": "array",
"example": [
"488b9e08-3877-4e31-9107-f1a72e159e86",
"e70ba8ca-c710-47ed-a093-71657cfee198"
],
"required": false,
"description": "Group UUIDs to sync client to."
},
"height": {
"type": "integer",
"example": 186,
"required": false,
"description": "The height of the client in centimeters."
},
"weight": {
"type": "integer",
"example": 220,
"required": false,
"description": "The weight of the client in pounds."
},
"address": {
"type": "array",
"example": {
"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."
}
},
"required": false,
"description": "Address"
},
"has_will": {
"type": "boolean",
"example": false,
"required": false,
"description": "Whether the client has a will or not."
},
"nickname": {
"type": "string",
"example": "G",
"required": false,
"description": "preferred nickname of the client"
},
"pronouns": {
"type": "string",
"example": "he/him",
"required": false,
"description": "Pronouns"
},
"last_name": {
"type": "string",
"example": "Thompson",
"required": true,
"description": "Last Name"
},
"ni_number": {
"type": "string",
"example": "AB 12 34 56 C",
"required": false,
"description": "National Insurance Number"
},
"first_name": {
"type": "string",
"example": "Gareth",
"required": true,
"description": "First Name"
},
"gift_notes": {
"type": "string",
"example": "Notes on the gifts.",
"required": false,
"description": "Notes on the gifts."
},
"will_notes": {
"type": "string",
"example": "Notes on the client's will.",
"required": false,
"description": "Notes on the client's will."
},
"deceased_at": {
"type": "date",
"example": "2025-06-22",
"required": false,
"description": "Date of death"
},
"inactive_at": {
"type": "date",
"example": "2025-06-22",
"required": false,
"description": "Inactive from date"
},
"is_deceased": {
"type": "boolean",
"example": false,
"required": false,
"description": "Denotes if the client is deceased"
},
"is_prospect": {
"type": "boolean",
"example": false,
"required": false,
"description": "Denotes if the client is a prospect or not."
},
"lead_source": {
"type": "string",
"example": "LeadGen Company",
"required": false,
"description": "Marks the lead source of the client"
},
"maiden_name": {
"type": "string",
"example": "Thompson",
"required": false,
"description": "Maiden Name"
},
"middle_name": {
"type": "string",
"example": "Alex",
"required": false,
"description": "Middle Name"
},
"status_uuid": {
"type": "string",
"example": "ad85fe3d-7062-4aad-9323-6fe49d9e94db",
"required": false,
"description": "The status of the client."
},
"do_not_visit": {
"type": "boolean",
"example": false,
"required": false,
"description": "Denotes if the client can be visited"
},
"health_notes": {
"type": "string",
"example": "Notes on the client's health.",
"required": false,
"description": "Notes on the client's health."
},
"smoker_since": {
"type": "date",
"example": "2015-06-22",
"required": false,
"description": "The date of when the client started smoking."
},
"date_of_birth": {
"type": "date",
"example": "1975-06-22",
"required": false,
"description": "Date of birth"
},
"do_not_market": {
"type": "boolean",
"example": false,
"required": false,
"description": "Denotes if the client can be marketed to"
},
"is_vulnerable": {
"type": "string",
"example": "possibly",
"required": false,
"description": "whether the client is vulnerable. Possible values are: \"yes\", \"no\", and \"possibly\""
},
"nationalities": {
"type": "array",
"example": [
"British",
"Romanian"
],
"required": false,
"description": "Nationalities of the client. You can use the api/v1/static/nationalities endpoint to get our list."
},
"pension_notes": {
"type": "string",
"example": "",
"required": false,
"description": "Notes on the pension"
},
"smoker_status": {
"type": "string",
"example": "non-smoker",
"required": false,
"description": "Smoker Status. Possible values are: smoker, non-smoker, vaper, ex-smoker, never-smoked, unknown"
},
"will_location": {
"type": "string",
"example": "",
"required": false,
"description": "Where is the will stored?"
},
"write_to_whom": {
"type": "string",
"example": "Gareth",
"required": false,
"description": "Marks the name of the client to write to"
},
"is_uk_domicile": {
"type": "boolean",
"example": true,
"required": false,
"description": "Whether the client is a UK domicile or not."
},
"is_uk_resident": {
"type": "boolean",
"example": true,
"required": false,
"description": "Whether the client is a UK resident or not."
},
"marital_status": {
"type": "string",
"example": "married",
"required": false,
"description": "Marital Status. Possible values are: single, cohabiting, married, divorced, civil-partnership, dissolved-civil-partnership, widowed, separated, engaged, in-relationship, other, unknown"
},
"will_executors": {
"type": "string",
"example": "",
"required": false,
"description": "Who are the executors?"
},
"passport_number": {
"type": "string",
"example": "123456",
"required": false,
"description": "The passport number of the client"
},
"cigarettes_daily": {
"type": "integer",
"example": 6,
"required": false,
"description": "The amount of cigarettes the client smokes a day."
},
"date_of_forecast": {
"type": "date",
"example": "2025-06-22T11:45:30+01:00",
"required": false,
"description": "What is the date of the obtained forecast"
},
"date_of_marriage": {
"type": "date",
"example": "2025-06-22",
"required": false,
"description": "Date of marriage"
},
"has_iht_planning": {
"type": "boolean",
"example": true,
"required": false,
"description": "Whether the client has Inheritance Tax (IHT) planning or not."
},
"is_will_accurate": {
"type": "boolean",
"example": true,
"required": false,
"description": "Does your current will reflect your wishes?"
},
"next_review_date": {
"type": "date",
"example": "2025-07-22",
"required": false,
"description": "Date of next review"
},
"will_poa_details": {
"type": "string",
"example": "",
"required": false,
"description": "Who are the Attorney’s?"
},
"has_gifted_family": {
"type": "boolean",
"example": true,
"required": false,
"description": "Whether the client has gifted the family."
},
"client_preferences": {
"type": "string",
"example": "Prefers telephone calls in the morning.",
"required": false,
"description": "Any client preferences."
},
"external_reference": {
"type": "array",
"example": {
"reference": "AB123456",
"third_party": "nucleus"
},
"required": false,
"description": "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, nucleus, parmenion, seccl, smartsearch, soderberg and transact_remuneration"
},
"first_contact_date": {
"type": "date",
"example": "2025-05-22",
"required": false,
"description": "The date of the first contact."
},
"iht_planning_notes": {
"type": "string",
"example": "Notes on the client's Inheritance Tax (IHT) planning.",
"required": false,
"description": "Notes on the client's Inheritance Tax (IHT) planning."
},
"introduced_by_uuid": {
"type": "string",
"example": "714ebf80-01e5-4a3e-9e5e-08db36af32a8",
"required": false,
"description": "The UUID of the introducer for this client"
},
"residential_status": {
"type": "string",
"example": "settled",
"required": false,
"description": "Residential status"
},
"send_welcome_email": {
"type": "boolean",
"example": true,
"required": false,
"description": "Send an email on account creation and create a login"
},
"will_gifts_details": {
"type": "string",
"example": "",
"required": false,
"description": "Notes of gifts"
},
"will_last_reviewed": {
"type": "date",
"example": "2025-06-21",
"required": false,
"description": "The date of the last time the will's been reviewed."
},
"third_party_offered": {
"type": "boolean",
"example": true,
"required": false,
"description": "Whether the client has been offered any third party."
},
"checked_sanctions_at": {
"type": "date",
"example": "2025-06-22",
"required": false,
"description": "Date the client was checked for sanctions"
},
"country_of_residence": {
"type": "string",
"example": "United Kingdom",
"required": false,
"description": "Country of residence"
},
"long_term_care_notes": {
"type": "string",
"example": "Notes on the client's long term care.",
"required": false,
"description": "Notes on the client's long term care."
},
"previous_review_date": {
"type": "date",
"example": "2025-05-22",
"required": false,
"description": "Date of previous review"
},
"procedure_adaptation": {
"type": "boolean",
"example": true,
"required": false,
"description": "Whether any procedures need to be adapted to the client."
},
"state_retirement_age": {
"type": "integer",
"example": 60,
"required": false,
"description": "The state retirement age."
},
"will_bequests_detail": {
"type": "string",
"example": "",
"required": false,
"description": "Details of any Bequests"
},
"assigned_adviser_uuid": {
"type": "string",
"example": "eba5b8b0-17b5-4c6c-b6f5-1596c88065a5",
"required": false,
"description": "The UUID of the employee that the client directly reports to"
},
"has_power_of_attorney": {
"type": "boolean",
"example": true,
"required": false,
"description": "Whether the client has power of attorney."
},
"is_married_to_partner": {
"type": "boolean",
"example": true,
"required": false,
"description": "Denotes if the client is married to their partner"
},
"long_term_care_needed": {
"type": "boolean",
"example": false,
"required": false,
"description": "Whether the client required long term care."
},
"prospect_converted_at": {
"type": "date",
"example": "2025-06-22T11:45:30+01:00",
"required": false,
"description": "The datetime when the prospect was converted into a client."
},
"target_retirement_age": {
"type": "integer",
"example": 60,
"required": false,
"description": "Targest retirement age."
},
"vulnerability_details": {
"type": "string",
"example": "No vulnerabilities",
"required": false,
"description": "Any details regarding the client's vulnerabilities."
},
"adaption_details_notes": {
"type": "boolean",
"example": "Adaptation notes",
"required": false,
"description": "Any notes regarding adaptations"
},
"do_not_contact_via_fax": {
"type": "boolean",
"example": false,
"required": false,
"description": "Denotes if the client can be contacted via fax"
},
"do_not_contact_via_sms": {
"type": "boolean",
"example": false,
"required": false,
"description": "Denotes if the client can be contacted via SMS"
},
"anniversary_review_date": {
"type": "date",
"example": "2025-06-22",
"required": false,
"description": "Anniversary review date"
},
"current_life_stage_uuid": {
"type": "string",
"example": "3f9921f5-84cd-485b-ac61-c6adb7c6a68d",
"required": false,
"description": "The clients current life stage for expenditure. Defaults to first available to firm if not provided."
},
"current_state_of_health": {
"type": "string",
"example": "Fit and healthy",
"required": false,
"description": "The client's current state of health."
},
"do_not_contact_via_mail": {
"type": "boolean",
"example": false,
"required": false,
"description": "Denotes if the client can be contacted via mail"
},
"expected_retirement_age": {
"type": "integer",
"example": 60,
"required": false,
"description": "The expected retirement age."
},
"has_obtained_a_forecast": {
"type": "boolean",
"example": true,
"required": false,
"description": "Have you recently obtained a forecast"
},
"power_of_attorney_notes": {
"type": "string",
"example": "Notes on the client's power of attorney.",
"required": false,
"description": "Notes on the client's power of attorney."
},
"projected_state_pension": {
"type": "integer",
"example": 50000,
"required": false,
"description": "What is the projected State Pension"
},
"units_of_alcohol_weekly": {
"type": "integer",
"example": 28,
"required": false,
"description": "The units of alcohol digested weekly."
},
"do_not_contact_via_email": {
"type": "boolean",
"example": false,
"required": false,
"description": "Denotes if the client can be contacted via email"
},
"assigned_paraplanner_uuid": {
"type": "string",
"example": "99ae260e-1339-4db7-beba-0a838ecc30a3",
"required": false,
"description": "The UUID of the paraplanner employee that the client has been assigned"
},
"poa_attorney_appointed_at": {
"type": "date",
"example": "2025-06-22T00:00:00+01:00",
"required": false,
"description": "When were the Attorney’s appointed?"
},
"assigned_administrator_uuid": {
"type": "string",
"example": "0a8ead17-6c7a-4efb-b8ff-498d4c7875e3",
"required": false,
"description": "The UUID of the adviser employee that the client has been assigned"
},
"is_anticipating_inheritance": {
"type": "boolean",
"example": true,
"required": false,
"description": "Whether the client is anticipating/ expecting any inheritance."
},
"state_of_health_explanation": {
"type": "string",
"example": "Explanation of the current state of health.",
"required": false,
"description": "Explanation of the current state of health."
},
"are_poa_documents_registered": {
"type": "boolean",
"example": true,
"required": false,
"description": "Are the documents registered?"
},
"do_not_contact_via_telephone": {
"type": "boolean",
"example": false,
"required": false,
"description": "Denotes if the client can be contacted via telephone"
},
"is_poa_registered_epa_or_lpa": {
"type": "string",
"example": "epa",
"required": false,
"description": "Is the Power of Attorney Registered as a EPA or LPA"
},
"anticipating_inheritance_notes": {
"type": "string",
"example": "Notes on the client's inheritance anticipation/ expectations.",
"required": false,
"description": "Notes on the client's inheritance anticipation/ expectations."
},
"last_used_nicotine_products_date": {
"type": "date",
"example": "2024-06-22",
"required": false,
"description": "The date of the last time the client used nicotine products."
},
"is_in_receipt_of_your_state_pension": {
"type": "boolean",
"example": true,
"required": false,
"description": "Are you in receipt of your State Pension"
},
"are_poa_appointed_for_health_or_wealth": {
"type": "string",
"example": "health",
"required": false,
"description": "Are the Attorneys appointed for Health, Wealth or Both?"
},
"years_of_national_insurance_contributions": {
"type": "integer",
"example": 5,
"required": false,
"description": "How many years have you made Nation Insurance Contributions"
}
}
],
"Employee": [
{
"role": {
"type": "string",
"example": "owner",
"required": true,
"description": "The role of the employee."
},
"email": {
"type": "string",
"example": "gareth@codepotato.co.uk",
"required": false,
"description": "Email address"
},
"phone": {
"type": "string",
"example": "443330509960",
"required": false,
"description": "Phone number"
},
"groups": {
"type": "array",
"example": [
"13d19e87-72d1-4799-b933-30b9ff767a9b",
"a4045919-6e93-4b87-8629-69a06b3d4cb0"
],
"required": false,
"description": "Group uuids belonging to the firm."
},
"address": {
"type": "array",
"example": {
"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."
}
},
"required": false,
"description": "Address"
},
"last_name": {
"type": "string",
"example": "Thompson",
"required": true,
"description": "The last name of the employee."
},
"first_name": {
"type": "string",
"example": "Gareth",
"required": true,
"description": "The first name of the employee."
},
"advice_type": {
"type": "string",
"example": "independent",
"required": false,
"description": "Employee's RMAR advice type"
},
"departments": {
"type": "array",
"example": [
"paraplanner",
"adviser"
],
"required": true,
"description": "The departments the employee is part of"
},
"inactive_at": {
"type": "date",
"example": "2025-06-22",
"required": false,
"description": "Inactive from date"
},
"next_review_date": {
"type": "date",
"example": "2025-07-22",
"required": false,
"description": "Date of next review"
},
"adviser_split_uuid": {
"type": "string",
"example": "8537a1a0-37ec-4616-810f-6d1652ee0471",
"required": false,
"description": "The uuid of the the adviser split that will be applied when this adviser adds charges"
},
"send_welcome_email": {
"type": "boolean",
"example": true,
"required": true,
"description": "Send an email on account creation and create a login"
},
"meeting_booking_url": {
"type": "string",
"example": "https://calendly.com/gareth-codepotato",
"required": false,
"description": "Employee's meeting booking URL"
},
"previous_review_date": {
"type": "date",
"example": "2025-05-22",
"required": false,
"description": "Date of previous review"
},
"assigned_adviser_uuid": {
"type": "string",
"example": "2eaa465c-9704-4665-be99-d400f263b6ab",
"required": false,
"description": "a532f96e-3ada-4fa2-a407-16102b163495"
},
"anniversary_review_date": {
"type": "date",
"example": "2025-06-22",
"required": false,
"description": "Anniversary review date"
}
}
],
"Introducer": [
{
"email": {
"type": "string",
"example": "gareth@codepotato.co.uk",
"required": false,
"description": "Email address"
},
"phone": {
"type": "string",
"example": "443330509960",
"required": false,
"description": "Phone number"
},
"title": {
"type": "string",
"example": "Mr",
"required": false,
"description": "Title"
},
"groups": {
"type": "array",
"example": [
"3de13b54-faa4-448f-a94f-6af16e6628ec",
"3a3a1dbc-c47d-4bbe-83a7-677a840fc6b8"
],
"required": false,
"description": "Group uuids belonging to the firm."
},
"address": {
"type": "array",
"example": {
"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."
}
},
"required": false,
"description": "Address"
},
"last_name": {
"type": "string",
"example": "Stanton",
"required": true,
"description": "Last name"
},
"first_name": {
"type": "string",
"example": "Patrick",
"required": true,
"description": "First name"
},
"entity_name": {
"type": "string",
"example": "PatrickCo",
"required": true,
"description": "Entity/business name"
},
"inactive_at": {
"type": "date",
"example": "2025-06-22",
"required": false,
"description": "Inactive from date"
},
"next_review_date": {
"type": "date",
"example": "2025-07-22",
"required": false,
"description": "Date of next review"
},
"send_welcome_email": {
"type": "boolean",
"example": true,
"required": false,
"description": "Send an email on account creation and create a login"
},
"previous_review_date": {
"type": "date",
"example": "2025-05-22",
"required": false,
"description": "Date of previous review"
},
"assigned_adviser_uuid": {
"type": "string",
"example": "fecc898b-e56c-455a-a171-93d0b759de68",
"required": false,
"description": "UUID of the account that this account reports to"
},
"anniversary_review_date": {
"type": "date",
"example": "2025-06-22",
"required": false,
"description": "Anniversary review date"
},
"charge_split_schema_uuid": {
"type": "string",
"example": "3cb384a2-79ba-40a3-a1f0-d87c07adfe7d",
"required": false,
"description": "Charge split schema that is always used when adding a charge split for this introducer"
}
}
]
}
Response examples (200)
{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "7746cd0d-0e72-43f7-9f0c-9217dd28d2f8",
"county": "Hampshire",
"billing": {
"invoice_email": "gareth@codepotato.co.uk",
"invoice_county": "Hampshire",
"invoice_country": "United Kingdom",
"invoice_postcode": "PO7 7YH",
"invoice_address_1": "Suite E, 5 The Briars",
"invoice_address_2": "Waterberry Drive",
"invoice_town_city": "Waterlooville"
},
"country": "United Kingdom",
"postcode": "PO7 7YH",
"address_1": "Suite E, 5 The Briars",
"address_2": "Waterberry Drive",
"logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
"month_end": 25,
"town_city": "Waterlooville",
"created_at": "2025-06-22T11:45:30+01:00",
"updated_at": "2025-06-22T11:45:30+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": "a8c1551d-6b34-4f9a-8145-4539666a70d6",
"colour": "#ef4582",
"created_at": "2025-06-22T11:45:30+01:00",
"updated_at": "2025-06-22T11:45:30+01:00"
}
],
"type": "client",
"uuid": "c6d4ee43-1eb2-46ab-80a4-21ad6409e8b5",
"email": "gareth@codepotato.co.uk",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "6c35d4ff-d407-4e92-8c4b-f25e0c411d19",
"created_at": "2025-06-22T11:45:30+01:00",
"updated_at": "2025-06-22T11:45:30+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "40a29ec1-cac3-4bde-ab54-7ecdafbd2c7b",
"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": "1d1439d8-6fe2-470e-9dd4-83aefdc20230",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:30+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:30+01:00",
"with_login": true,
"inactive_at": "2025-06-22",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-06-22T11:45:30+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-22T11:45:30+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-06-22T11:45:30+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-22T11:45:30+01:00"
}
],
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:30+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:30+01:00",
"with_login": true,
"inactive_at": "2025-06-22",
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "dbd9767b-56a4-4139-a169-3eed1fcc9205",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-06-22T11:45:30+01:00",
"updated_at": "2025-06-22T11:45:30+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": "3f8ac58e-44a7-4486-b17a-0d478ee2640a",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:30+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:30+01:00",
"with_login": true,
"inactive_at": "2025-06-22",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-06-22T11:45:30+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-22T11:45:30+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-06-22T11:45:30+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-22T11:45:30+01:00"
},
"primary_email": {
"name": "Work number",
"type": "phone_number",
"uuid": "8a00f8c3-b7fd-4cff-9114-58576b219f29",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-06-22T11:45:30+01:00",
"updated_at": "2025-06-22T11:45:30+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": "06f3a36c-36f3-4e6d-aa24-41fd346d29d1",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:30+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:30+01:00",
"with_login": true,
"inactive_at": "2025-06-22",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-06-22T11:45:30+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-22T11:45:30+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-06-22T11:45:30+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-22T11:45:30+01:00"
},
"next_review_date": "2025-06-22T11:45:30+01:00",
"has_joint_account": true,
"current_time_entry": {
"name": "Research",
"uuid": "0750b9d9-361d-4d73-808e-113ab37f5f2c",
"account": "App\\Http\\Resources\\MinimalAccountResource",
"end_date": "2025-06-22T11:23:30+01:00",
"is_active": true,
"trackable": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2025-06-22T11:45:30+01:00",
"start_date": "2025-06-22T10:55:30+01:00",
"updated_at": "2025-06-22T11:45:30+01:00",
"description": "This is a description.",
"trackable_type": "Client",
"total_time_in_minutes": 28,
"computed_time_elapsed_in_seconds": 1680
},
"first_contact_date": "2025-06-22T11:45:30+01:00",
"external_references": [
{
"uuid": "162c7b9a-b264-4ed7-9967-87963ebdf545",
"reference": "AB123456",
"created_at": "2025-06-22T11:45:30+01:00",
"updated_at": "2025-06-22T11:45:30+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": "56a8d006-6aa9-4494-94ef-9cf2bbad2f52",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:30+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:30+01:00",
"with_login": true,
"inactive_at": "2025-06-22",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-06-22T11:45:30+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-22T11:45:30+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-06-22T11:45:30+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-22T11:45:30+01:00"
},
"joint_account_circle": {
"name": "Jones Family",
"uuid": "373763f7-3ace-4ee1-af81-3d8c63a7c4ce",
"groups": "App\\Http\\Resources\\GroupResource",
"accounts": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2025-06-22T11:45:30+01:00",
"updated_at": "2025-06-22T11:45:30+01:00",
"joint_account_uuid": "5a1b2844-8709-4fa9-b816-50113b5454f5"
},
"ownership_percentage": 100,
"previous_review_date": "2025-06-22T11:45:30+01:00",
"primary_phone_number": {
"name": "Work number",
"type": "phone_number",
"uuid": "d6487de9-ae33-4c70-8e58-8a2a42fb0526",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-06-22T11:45:30+01:00",
"updated_at": "2025-06-22T11:45:30+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": "8502bee0-b368-4937-b1c6-733d9a344105",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:30+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:30+01:00",
"with_login": true,
"inactive_at": "2025-06-22",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-06-22T11:45:30+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-22T11:45:30+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-06-22T11:45:30+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-22T11:45:30+01:00"
},
"anniversary_review_date": "2025-06-22T11:45:30+01:00"
}Update the configuration on an addon subscription
Headers
-
Content-Type
string -
Accept
string
Path parameters
-
addonSubscription_uuid
string Required
PUT
/api/v1/addon-subscriptions/{addonSubscription_uuid}
curl \
--request PUT 'https://api.plannrcrm.com/api/v1/addon-subscriptions/addonSubscription_uuid' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data '{"config":[{"api_key":"example-api-key"}]}'
Request examples
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
# Payload
{
"config": [
{
"api_key": "example-api-key"
}
]
}Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Path parameters
-
uuid
integer Required
Body
-
account_uuids
array[string] The UUIDs of the accounts who should own the address. These must only be client accounts.
-
primary_account_uuids
array[string] The UUIDs of the accounts who should have the address as their primary address.
-
name
string The friendly name for the address.
-
address_1
string The first line of the address.
-
address_2
string The second line of the address.
-
address_3
string The third line of the address.
-
address_4
string The fourth line of the address.
-
town_city
string The town or city.
-
county
string The county.
-
postcode
string The postcode.
-
country
string The country.
-
moved_in_month
integer The month the client moved into this address.
-
moved_in_year
integer The year the client moved into this address.
-
moved_out_month
integer The month the client moved out of this address.
-
moved_out_year
integer The year the client moved out of this address.
-
residential_status
string The client's residential status when living at the address.
-
residential_status_other
string The client's residential status if it is not provided in the residential_status options. Must only be provided if residential_status is other.
PUT
/api/v2/addresses/{uuid}
curl \
--request PUT 'https://api.plannrcrm.com/api/v2/addresses/uuid' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"account_uuids":["e0239f83-8596-4bb6-9f56-310c0be64b1c","50f6789f-b43e-4685-b0fe-a91ca12d8952"],"primary_account_uuids":["135af8cf-4e3a-4599-a646-2fd5835c13c4","553ad951-4238-4225-b36d-d88d48d883af"],"name":"Work Address","address_1":"Suite E, 5 The Briars","address_2":"Waterberry Drive","address_3":"The Innovative Centre","address_4":"Waterlooville","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom","moved_in_month":6,"moved_in_year":2022,"moved_out_month":1,"moved_out_year":2024,"residential_status":"homeowner","residential_status_other":"Non-tenant occupier"}'
Request examples
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"account_uuids": [
"e0239f83-8596-4bb6-9f56-310c0be64b1c",
"50f6789f-b43e-4685-b0fe-a91ca12d8952"
],
"primary_account_uuids": [
"135af8cf-4e3a-4599-a646-2fd5835c13c4",
"553ad951-4238-4225-b36d-d88d48d883af"
],
"name": "Work Address",
"address_1": "Suite E, 5 The Briars",
"address_2": "Waterberry Drive",
"address_3": "The Innovative Centre",
"address_4": "Waterlooville",
"town_city": "Waterlooville",
"county": "Hampshire",
"postcode": "PO7 7YH",
"country": "United Kingdom",
"moved_in_month": 6,
"moved_in_year": 2022,
"moved_out_month": 1,
"moved_out_year": 2024,
"residential_status": "homeowner",
"residential_status_other": "Non-tenant occupier"
}
Response examples (200)
{
"name": "Work Address",
"uuid": "a88b2fe6-3e41-46cc-a3d8-66fa893a72c2",
"county": "Hampshire",
"country": "United Kingdom",
"accounts": {
"name": "Gareth Thompson",
"role": "client",
"type": "client",
"uuid": "2b7c5086-5a00-4406-b883-b2b30d2bea4b",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-06-22T11:45:37+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:37+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"postcode": "PO7 7YH",
"address_1": "Suite E, 5 The Briars",
"address_2": "Waterberry Drive",
"address_3": "The Innovative Centre",
"address_4": "Waterlooville",
"town_city": "Waterlooville",
"created_at": "2025-06-22T11:45:37+01:00",
"updated_at": "2025-06-22T11:45:37+01:00",
"moved_in_year": 2022,
"moved_in_month": 6,
"moved_out_year": 2024,
"lived_in_months": 19,
"moved_out_month": 1,
"primary_accounts": {
"name": "Gareth Thompson",
"role": "client",
"type": "client",
"uuid": "2a8d8842-0a41-4e30-9226-c7e3a399d92e",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-06-22T11:45:37+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:37+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"residential_status": "homeowner",
"residential_status_other": "homeowner"
}Get all audits attached to a model
Headers
-
Content-Type
string -
Accept
string
Query parameters
-
filter[uuid]
string Filter by a comma separated list of UUIDs.
-
filter[circle_uuids]
string Filter by a comma separated list of UUIDs.
-
sort
string Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC. Defaults to '-created_at'.
-
per_page
integer the amount of audits per page (Default 15. Max 500).
GET
/api/v1/audits/{model}/{modelUuid}
curl \
--request GET 'https://api.plannrcrm.com/api/v1/audits/group/modelUuid' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
Response examples (200)
{
"data": [
{
"url": "https://plannr.co.uk",
"type": "Sub Account",
"uuid": "e5e82a8a-be28-429e-8bd3-d82eddc94141",
"event": "updated",
"account": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "4dfff979-a31f-4613-ba14-aaa6f72c3a50",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:34+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:34+01:00",
"with_login": true,
"inactive_at": "2025-06-22",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-06-22T11:45:34+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-22T11:45:34+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-06-22T11:45:34+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-22T11:45:34+01:00"
},
"created_at": "2025-06-22T11:45:34+01:00",
"ip_address": "127.0.0.1",
"new_values": {
"first_name": "johny"
},
"old_values": {
"first_name": "john"
},
"user_agent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0"
}
]
}Automation Blueprints
APIs for managing Automation Blueprints
Headers
-
Content-Type
string -
Accept
string
Query parameters
-
include
string Comma separated list of relationships to include in the response. Valid relationships are [account,steps,webhook_targets].
-
filter[uuid]
string Filter by a comma separated list of UUIDs.
-
filter[is_active]
boolean Filter automation blueprints by which are active or not.
-
filter[trigger]
string Filter automation blueprints by a certain trigger type.
-
filter[name]
string Filter automation blueprints by a partial match to the blueprint name.
-
sort
string Field to sort by. Valid fields are [created_at, updated_at, name]. Negative sign to denote DESC. Defaults to 'name'.
-
per_page
integer Number of results to return with pagination (Default 15. Max 500).
GET
/api/v1/automation-blueprints
curl \
--request GET 'https://api.plannrcrm.com/api/v1/automation-blueprints' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
Response examples (200)
{
"data": [
{
"name": "Add new client on webhook",
"uuid": "8385ba94-7350-4122-be22-fd977e164061",
"steps": [
{
"name": "create a new client",
"type": "client.create",
"uuid": "6ed6aec9-5a28-4fe8-9b5a-f5c5fddd2185",
"updated": "2025-06-22T11:45:35+01:00",
"created_at": "2025-06-22T11:45:35+01:00",
"configuration": {
"params": {
"account_uuid": {
"type": "ref",
"value": "trigger.account.uuid"
}
}
},
"condition_state": false,
"parent_step_uuid": "fc5568cd-bca9-4b89-9724-a45a5b46d62f"
}
],
"account": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "393de8b1-92b1-4af0-acb4-baa68544269a",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:35+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:35+01:00",
"with_login": true,
"inactive_at": "2025-06-22",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-06-22T11:45:35+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-22T11:45:35+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-06-22T11:45:35+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-22T11:45:35+01:00"
},
"trigger": "client.create",
"is_active": false,
"conditions": [],
"created_at": "2025-06-22T11:45:35+01:00",
"updated_at": "2025-06-22T11:45:35+01:00",
"steps_count": "1",
"configuration": [],
"webhook_targets": [
{
"url": "https://api.plannrcrm.com/api/v1/webhooks/01605357-9fba-4cab-b4f0-141476dfa4ea",
"uuid": "33e0487a-b54e-4023-965f-d495e61f5927",
"created_at": "2025-06-22T11:45:35+01:00",
"updated_at": "2025-06-22T11:45:35+01:00"
}
]
}
]
}Bulk Actions
APIs for managing bulk actions
Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Query parameters
-
include
string Comma separated list of relationships to include in the response. Valid relationships are [participants, participants_count, type, status, tags, plans, custom_fields].
-
filter[uuid]
string Filter by a comma separated list of UUIDs.
-
filter[completed]
boolean Filter cases by which have been completed
-
filter[in_progress]
boolean Filter cases by which are still in progress
-
filter[type]
string Comma separated string of types to filter by
-
filter[status]
string Comma separated string of statuses to filter by
-
filter[plan_uuid]
string Comma separated string of plan UUIDs to filter by.
-
filter[account_uuids]
string Comma separated string of account UUIDs to filter by.
-
filter[circle_uuids]
string Comma separated string of circle UUIDs to filter by.
-
Comma separated string of employee accounts UUIDs to filter by.
-
filter[completed_after]
string Filter cases which have a completed at date after. Example 2025-01-25
-
filter[completed_before]
string Filter cases which have a completed at date before. Example 2025-08-06
-
filter[review_at_after]
string Filter cases which have a review at date after. Example 2025-01-02
-
filter[review_at_before]
string Filter cases which have a review at date before. Example 2025-06-08
-
per_page
integer Number of results to return with pagination (Default 15. Max 500).
-
sort
string Field to sort by. Valid fields are [created_at, name, status_position, value, completed_at, review_at]. Negative sign to denote DESC. Defaults to 'name'.
GET
/api/v1/cases
curl \
--request GET 'https://api.plannrcrm.com/api/v1/cases' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"data": [
{
"name": "finance",
"slug": "finance",
"type": {
"name": "Mortgage Plan",
"uuid": "8f6d86a7-1b7a-4085-94ac-a9d145a311a3",
"created_at": "2025-06-22T11:45:32+01:00",
"updated_at": "2025-06-22T11:45:32+01:00"
},
"uuid": "3465d4fa-f932-477b-9a78-d4bc07d56540",
"plans": {
"name": "Johns ISA",
"tags": "App\\Http\\Resources\\TagResource",
"type": "cash_account",
"uuid": "e1af8f99-a56d-4a8a-b75c-df94913f73a7",
"wrap": "App\\Http\\Resources\\Plans\\PlanResource",
"cases": "App\\Http\\Resources\\CasesResource",
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
}
},
"claims": "App\\Http\\Resources\\Plans\\ClaimResource",
"client": "App\\Http\\Resources\\AccountResource",
"covers": "App\\Http\\Resources\\Plans\\CoverResource",
"seller": "App\\Http\\Resources\\AccountResource",
"status": "inactive",
"accounts": "App\\Http\\Resources\\AccountResource",
"on_panel": true,
"provider": "App\\Http\\Resources\\Plans\\ProviderResource",
"sub_type": "lifetime isa",
"opened_at": "2025-06-22T11:45:32+01:00",
"valued_at": "2025-06-22T11:45:32+01:00",
"created_at": "2025-06-22T11:45:32+01:00",
"statistics": {
"recent_growth": 100
},
"updated_at": "2025-06-22T11:45:32+01:00",
"advice_area": "non_investment_insurance",
"inactive_at": "2025-06-22T11:45:32+01:00",
"review_date": "2024-06-22",
"linked_plans": "App\\Http\\Resources\\Plans\\PlanResource",
"main_account": "App\\Http\\Resources\\Plans\\SubAccountResource",
"sub_accounts": "App\\Http\\Resources\\Plans\\SubAccountResource",
"under_advice": true,
"abstract_type": "asset",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"is_wrap_child": false,
"linked_owners": "App\\Http\\Resources\\AccountResource",
"policy_number": "AVIVA-123",
"show_on_joint": true,
"wrap_children": "App\\Http\\Resources\\Plans\\PlanResource",
"can_be_deleted": "false",
"total_benefits": {
"critical_illness": {
"amount": {
"example": "15000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£150,000.00",
"description": "Money amount formatted with currency"
}
},
"family_income_benefit": {
"amount": {
"example": "10000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£100,000.00",
"description": "Money amount formatted with currency"
}
}
},
"inactive_reason": "claimed",
"is_group_scheme": false,
"is_wrap_product": false,
"latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
"original_valued_at": "2025-06-21T11:45:32+01:00",
"proposal_reference": "AB123456",
"agency_in_your_name": true,
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"is_sub_group_scheme": false,
"total_benefit_amount": {
"amount": {
"example": "25000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£250,000.00",
"description": "Money amount formatted with currency"
}
},
"is_group_scheme_member": false,
"originally_sold_by_firm": true,
"agency_in_your_name_from": "2024-06-22",
"contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
"visible_on_client_portal": true,
"include_in_client_valuation": true
},
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
}
},
"status": {
"name": "To Be Reviewed",
"uuid": "69da1f99-edee-4ead-a8cc-4a8eeb999a18",
"colour": "#23852B",
"position": 5,
"created_at": "2025-06-22T11:45:32+01:00",
"updated_at": "2025-06-22T11:45:32+01:00",
"is_type_completed": false
},
"review_at": "2025-06-22T11:45:32+01:00",
"created_at": "2025-06-22T11:45:32+01:00",
"updated_at": "2025-06-22T11:45:32+01:00",
"group_uuids": [
"977cb02b-a196-4db6-a58e-d416812aac30"
],
"completed_at": "2025-06-22T11:45:32+01:00",
"participants": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "8cda929f-8102-470e-896f-331717ca305f",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:32+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:32+01:00",
"with_login": true,
"inactive_at": "2025-06-22",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-06-22T11:45:32+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-22T11:45:32+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-06-22T11:45:32+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-22T11:45:32+01:00"
},
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "4f1d969b-a04b-425a-bb46-d54dc3921f79",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-06-22T11:45:32+01:00",
"updated_at": "2025-06-22T11:45:32+01:00",
"is_required": false,
"selection_options": [
"Coffee",
"Tea",
"Water"
]
}
],
"status_position": 4,
"task_board_uuid": "8127adca-3508-4a80-836a-6399eace9431",
"assigned_to_uuids": [
"40c0c608-ed10-4333-bd94-ae372d5242ad"
],
"participants_count": 4
}
]
}Get all linked clients for clients of a circle
Headers
-
Content-Type
string -
Accept
string
Path parameters
-
circle_uuid
integer Required
GET
/api/v1/circles/{circle_uuid}/linked-clients
curl \
--request GET 'https://api.plannrcrm.com/api/v1/circles/circle_uuid/linked-clients' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
Response examples (200)
{
"data": [
{
"name": "Gareth Thompson",
"uuid": "e6ac0547-2aef-4e1b-b490-0636b1188756",
"email": "gareth@codepotato.co.uk",
"created_at": "2025-06-22T11:45:31+01:00",
"updated_at": "2025-06-22T11:45:31+01:00",
"linked_clients": [
{
"name": "Gareth",
"uuid": "53c75988-3ad8-4a93-ba69-561e6136002b",
"relationship": "Father"
}
]
}
]
}Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Body
-
claim_amount
integer Claim amount in pennies.
-
claim_start_date
date Claim start date
-
claim_end_date
date Claim end date
-
claim_notes
date Claim notes
PUT
/api/v1/plans/{plan_uuid}/claim/{uuid}
curl \
--request PUT 'https://api.plannrcrm.com/api/v1/plans/plan_uuid/claim/uuid' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"claim_amount":892176,"claim_start_date":"2024-06-22 11:45:34","claim_end_date":"2030-06-22 11:45:34","claim_notes":"Claim notes"}'
Request examples
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"claim_amount": 892176,
"claim_start_date": "2024-06-22 11:45:34",
"claim_end_date": "2030-06-22 11:45:34",
"claim_notes": "Claim notes"
}
Response examples (200)
{
"uuid": "2b62b2fc-2dd6-4764-8f1b-6d960acfce1a",
"client": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "784a05dd-901e-418b-8ceb-c7e6ffffbf42",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:34+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:34+01:00",
"with_login": true,
"inactive_at": "2025-06-22",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-06-22T11:45:34+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-22T11:45:34+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-06-22T11:45:34+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-22T11:45:34+01:00"
},
"created_at": "2025-06-22T11:45:34+01:00",
"updated_at": "2025-06-22T11:45:34+01:00",
"claim_notes": "Claim notes",
"claim_amount": {
"amount": {
"example": "25000000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£250,000.00",
"description": "Money amount formatted with currency"
}
},
"claim_end_date": "2030-06-22",
"claim_start_date": "2024-06-22"
}Get all circle conversations
Get all conversations where the circle accounts are participants.
Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Path parameters
-
circle_uuid
integer Required
Query parameters
-
include
string Comma separated list of relationships to include in the response. Valid relationships are [participants, participants_count, latest_message, messages_count, files_count, case, tags].
-
filter[uuid]
string Filter by a comma separated list of UUIDs.
-
filter[archived]
string Return with or only archived conversations for current user. Valid options are [with, only, false]. Default is set to false.
-
sort
string Field to sort by. Valid fields are [created_at, latest_message, pinned_conversations]. Negative sign to denote DESC. Defaults to 'latest_message'.
-
per_page
integer Number of results to return with pagination (Default 15. Max 500).
GET
/api/v1/circles/{circle_uuid}/conversations
curl \
--request GET 'https://api.plannrcrm.com/api/v1/circles/circle_uuid/conversations' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"data": [
{
"case": {
"name": "finance",
"slug": "finance",
"type": "App\\Http\\Resources\\CasesTypeResource",
"uuid": "96588c16-7e15-4a43-aee0-2565306b27ea",
"plans": "App\\Http\\Resources\\Plans\\PlanResource",
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
}
},
"status": "App\\Http\\Resources\\CasesStatusResource",
"review_at": "2025-06-22T11:45:31+01:00",
"created_at": "2025-06-22T11:45:31+01:00",
"updated_at": "2025-06-22T11:45:31+01:00",
"group_uuids": [
"3c880fa5-215d-484d-a53d-08279c01e10a"
],
"completed_at": "2025-06-22T11:45:31+01:00",
"participants": "App\\Http\\Resources\\AccountResource",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"status_position": 4,
"task_board_uuid": "7fea9db4-b731-4907-8fe7-2d7a2e78539f",
"assigned_to_uuids": [
"99cb4935-4064-4591-a0bd-1493ebb0ecbc"
],
"participants_count": 4
},
"name": "Welcome to Plannr",
"slug": "welcome-to-plannr",
"tags": [
{
"name": "Mortgage",
"slug": "mortgage",
"uuid": "fa4f76dd-961f-4099-b066-eb6837d64273",
"colour": "#ef4582",
"created_at": "2025-06-22T11:45:31+01:00",
"updated_at": "2025-06-22T11:45:31+01:00"
}
],
"uuid": "6ee60230-81fd-4cb5-9c7e-ca683e4ada9f",
"pinned": true,
"is_admin": false,
"created_at": "2025-06-22T11:45:31+01:00",
"updated_at": "2025-06-22T11:45:31+01:00",
"files_count": 2,
"participants": [
{
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "0fe85678-7480-458a-b0a5-e22f18fc4a93",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:31+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:31+01:00",
"with_login": true,
"inactive_at": "2025-06-22",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-06-22T11:45:31+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-22T11:45: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-06-22T11:45:31+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-22T11:45:31+01:00"
}
],
"latest_message": {
"user": "App\\Http\\Resources\\UserResource",
"uuid": "808880dd-c8f8-4b52-93b4-a0ba9b636f7d",
"files": "App\\Http\\Resources\\FileResource",
"author": "App\\Http\\Resources\\AccountResource",
"edited": true,
"contents": "Welcome to Plannr!",
"reactions": "App\\Http\\Resources\\ReactionResource",
"created_at": "2025-06-22T11:45:31+01:00",
"deleted_at": "2025-06-22T11:45:31+01:00",
"updated_at": "2025-06-22T11:45:31+01:00"
},
"messages_count": 30,
"belongs_to_case": true,
"participants_count": 3
}
]
}Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Path parameters
-
uuid
integer Required
PUT
/api/v1/conversation/{uuid}
curl \
--request PUT 'https://api.plannrcrm.com/api/v1/conversation/uuid' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"name":"Annual Review"}'
Request examples
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"name": "Annual Review"
}
Response examples (200)
{
"case": {
"name": "finance",
"slug": "finance",
"type": "App\\Http\\Resources\\CasesTypeResource",
"uuid": "aff19a41-a2b2-4366-84c5-b6b6afa286a3",
"plans": "App\\Http\\Resources\\Plans\\PlanResource",
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
}
},
"status": "App\\Http\\Resources\\CasesStatusResource",
"review_at": "2025-06-22T11:45:32+01:00",
"created_at": "2025-06-22T11:45:32+01:00",
"updated_at": "2025-06-22T11:45:32+01:00",
"group_uuids": [
"9eb42e98-b10f-4025-859c-ea35b316fdad"
],
"completed_at": "2025-06-22T11:45:32+01:00",
"participants": "App\\Http\\Resources\\AccountResource",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"status_position": 4,
"task_board_uuid": "2f113210-f6d4-4e8f-b756-6966c287e4ad",
"assigned_to_uuids": [
"0c445850-7d58-4d97-8199-1a5c69bbe7ca"
],
"participants_count": 4
},
"name": "Welcome to Plannr",
"slug": "welcome-to-plannr",
"tags": [
{
"name": "Mortgage",
"slug": "mortgage",
"uuid": "5300f386-d2fa-49c5-98ab-31b11417fd8f",
"colour": "#ef4582",
"created_at": "2025-06-22T11:45:32+01:00",
"updated_at": "2025-06-22T11:45:32+01:00"
}
],
"uuid": "b4cfb403-e639-4849-b804-1b2d676acc9f",
"pinned": true,
"is_admin": false,
"created_at": "2025-06-22T11:45:32+01:00",
"updated_at": "2025-06-22T11:45:32+01:00",
"files_count": 2,
"participants": [
{
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "58706a13-f8ee-4cc5-8106-c87ad1f45da8",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:32+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:32+01:00",
"with_login": true,
"inactive_at": "2025-06-22",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-06-22T11:45:32+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-22T11:45:32+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-06-22T11:45:32+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-22T11:45:32+01:00"
}
],
"latest_message": {
"user": "App\\Http\\Resources\\UserResource",
"uuid": "a6a6e2d8-0e7c-4324-ac7d-b72c44f07d59",
"files": "App\\Http\\Resources\\FileResource",
"author": "App\\Http\\Resources\\AccountResource",
"edited": true,
"contents": "Welcome to Plannr!",
"reactions": "App\\Http\\Resources\\ReactionResource",
"created_at": "2025-06-22T11:45:32+01:00",
"deleted_at": "2025-06-22T11:45:32+01:00",
"updated_at": "2025-06-22T11:45:32+01:00"
},
"messages_count": 30,
"belongs_to_case": true,
"participants_count": 3
}Delete a custom field
Headers
-
Content-Type
string -
Accept
string
Path parameters
-
customField_uuid
string Required -
customField
string Required UUID The UUID of the custom field
DELETE
/api/v1/custom-field/{customField_uuid}
curl \
--request DELETE 'https://api.plannrcrm.com/api/v1/custom-field/customField_uuid' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"Get an employee [DEPRECATED: Use get an account route]
Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Path parameters
-
uuid
string Required
GET
/api/v1/employee/{uuid}
curl \
--request GET 'https://api.plannrcrm.com/api/v1/employee/uuid' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "6bfbb5f4-06b7-471a-935f-89a3d74aef13",
"county": "Hampshire",
"billing": {
"invoice_email": "gareth@codepotato.co.uk",
"invoice_county": "Hampshire",
"invoice_country": "United Kingdom",
"invoice_postcode": "PO7 7YH",
"invoice_address_1": "Suite E, 5 The Briars",
"invoice_address_2": "Waterberry Drive",
"invoice_town_city": "Waterlooville"
},
"country": "United Kingdom",
"postcode": "PO7 7YH",
"address_1": "Suite E, 5 The Briars",
"address_2": "Waterberry Drive",
"logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
"month_end": 25,
"town_city": "Waterlooville",
"created_at": "2025-06-22T11:45:31+01:00",
"updated_at": "2025-06-22T11:45: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_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": "242113ed-8958-4fb6-8fa3-6174ec9f7547",
"colour": "#ef4582",
"created_at": "2025-06-22T11:45:31+01:00",
"updated_at": "2025-06-22T11:45:31+01:00"
}
],
"type": "client",
"uuid": "20f854ae-70c3-434f-b747-2422b403c068",
"email": "gareth@codepotato.co.uk",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "069c5d13-4ad8-4ad3-9bfa-9c8408157b50",
"created_at": "2025-06-22T11:45:31+01:00",
"updated_at": "2025-06-22T11:45:31+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "21084f02-14a9-4b7e-8a78-db80a39efafb",
"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": "3345c97a-13eb-4f4b-b3cc-2b6ee0467d5f",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:31+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:31+01:00",
"with_login": true,
"inactive_at": "2025-06-22",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-06-22T11:45:31+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-22T11:45: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-06-22T11:45:31+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-22T11:45:31+01:00"
}
],
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:31+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:31+01:00",
"with_login": true,
"inactive_at": "2025-06-22",
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "4e1abf3c-13ec-4bce-b129-40b857b6b4d7",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-06-22T11:45:31+01:00",
"updated_at": "2025-06-22T11:45: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": "6988e5af-1b3b-4a2a-8877-b91a71f57111",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:31+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:31+01:00",
"with_login": true,
"inactive_at": "2025-06-22",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-06-22T11:45:31+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-22T11:45: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-06-22T11:45:31+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-22T11:45:31+01:00"
},
"primary_email": {
"name": "Work number",
"type": "phone_number",
"uuid": "20567128-2244-4803-885f-d748afc1ce53",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-06-22T11:45:31+01:00",
"updated_at": "2025-06-22T11:45: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": "05727d17-5988-46eb-b7af-7c3a7fd2d4c6",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:31+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:31+01:00",
"with_login": true,
"inactive_at": "2025-06-22",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-06-22T11:45:31+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-22T11:45: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-06-22T11:45:31+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-22T11:45:31+01:00"
},
"next_review_date": "2025-06-22T11:45:31+01:00",
"has_joint_account": true,
"current_time_entry": {
"name": "Research",
"uuid": "b802d3ae-164c-4ea8-b9c3-ba7f6cb30ed3",
"account": "App\\Http\\Resources\\MinimalAccountResource",
"end_date": "2025-06-22T11:23:31+01:00",
"is_active": true,
"trackable": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2025-06-22T11:45:31+01:00",
"start_date": "2025-06-22T10:55:31+01:00",
"updated_at": "2025-06-22T11:45: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-06-22T11:45:31+01:00",
"external_references": [
{
"uuid": "068ecaa5-8975-4037-90a8-2ac998fb1ac1",
"reference": "AB123456",
"created_at": "2025-06-22T11:45:31+01:00",
"updated_at": "2025-06-22T11:45: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": "e25ba785-5f16-4c2b-a766-ba60da4127da",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:31+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:31+01:00",
"with_login": true,
"inactive_at": "2025-06-22",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-06-22T11:45:31+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-22T11:45: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-06-22T11:45:31+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-22T11:45:31+01:00"
},
"joint_account_circle": {
"name": "Jones Family",
"uuid": "8ab60206-d2a3-4c46-9a1d-7e72963cd8c1",
"groups": "App\\Http\\Resources\\GroupResource",
"accounts": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2025-06-22T11:45:31+01:00",
"updated_at": "2025-06-22T11:45:31+01:00",
"joint_account_uuid": "d86a1100-5146-477a-8cca-4a52438b0d84"
},
"ownership_percentage": 100,
"previous_review_date": "2025-06-22T11:45:31+01:00",
"primary_phone_number": {
"name": "Work number",
"type": "phone_number",
"uuid": "3fc1f12e-48b2-48b9-812c-0a47f31abf3e",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-06-22T11:45:31+01:00",
"updated_at": "2025-06-22T11:45: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": "ad9dff08-a2fc-4332-a990-a196eb986423",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:31+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:31+01:00",
"with_login": true,
"inactive_at": "2025-06-22",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-06-22T11:45:31+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-22T11:45: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-06-22T11:45:31+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-22T11:45:31+01:00"
},
"anniversary_review_date": "2025-06-22T11:45:31+01:00"
}Delete a fact-find schema
Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Path parameters
-
factFindSchema_uuid
string Required
DELETE
/api/v1/fact-find/schema/{factFindSchema_uuid}
curl \
--request DELETE 'https://api.plannrcrm.com/api/v1/fact-find/schema/factFindSchema_uuid' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"Get all files on a documentable model
Provide a documentable model as a string ('account', 'case', 'firm', or 'plan') and the UUID for the model. This index will get all files within the folder tree starting from the root folder of the provided model.
Headers
-
Content-Type
string -
Accept
string
Query parameters
-
include
string Comma separated list of relationships to include in the response. Valid relationships are [documentable, folder, account, tags].
-
filter[uuid]
string Filter by a comma separated list of UUIDs.
-
filter[name]
string File name to filter by.
-
filter[date_from]
string File uploaded_at date to filter from a specific date, can be used with date_to for a range.
-
filter[date_to]
string File uploaded_at date to filter to a specific date, can be used with date_from for a range.
-
filter[extension]
string File extension to filter by.
-
filter[uploaded_by_uuid]
string Filter by a comma separated list of account UUIDs of who uploaded the file.
-
filter[uploaded_by]
integer [DEPRECATED] Use uploaded_by_uuid instead. The account the uploaded the file to filter by. Takes a UUID.
-
filter[size]
string The size of the file to filter by. Can take two values to filter in a range or one value to get files lesser than or equal to value. Unit of file size is in kilobytes.
-
filter[last_modified_from]
string File last_modified date to filter to from a specific date, can be used with last_modified_to for a range.
-
filter[last_modified_to]
string File last_modified date to filter to a specific date, can be used with last_modified_from for a range.
-
File original_created_at date to filter from a specific date, can be used with original_created_to for a range.
-
filter[original_created_to]
string File original_created_at date to filter to a specific date, can be used with original_created_from for a range.
-
sort
string Field to sort by. Valid fields are [uploaded_at, created_at, updated_at, name]. Negative sign to denote DESC. Defaults to 'name'.
GET
/api/v1/files/{model}/{modelUuid}
curl \
--request GET 'https://api.plannrcrm.com/api/v1/files/model/modelUuid' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
Response examples (200)
{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "6c2f0665-4cec-4400-a3cf-61630d468cec",
"county": "Hampshire",
"billing": {
"invoice_email": "gareth@codepotato.co.uk",
"invoice_county": "Hampshire",
"invoice_country": "United Kingdom",
"invoice_postcode": "PO7 7YH",
"invoice_address_1": "Suite E, 5 The Briars",
"invoice_address_2": "Waterberry Drive",
"invoice_town_city": "Waterlooville"
},
"country": "United Kingdom",
"postcode": "PO7 7YH",
"address_1": "Suite E, 5 The Briars",
"address_2": "Waterberry Drive",
"logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
"month_end": 25,
"town_city": "Waterlooville",
"created_at": "2025-06-22T11:45:34+01:00",
"updated_at": "2025-06-22T11:45:34+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": "Welcome to Plannr",
"path": "Gareth Thompson/Subfolder/Welcome to Plannr.pdf",
"size": "21691783",
"tags": [
{
"name": "Mortgage",
"slug": "mortgage",
"uuid": "25483fe2-a19b-42cc-96b1-0fc7a78fb765",
"colour": "#ef4582",
"created_at": "2025-06-22T11:45:34+01:00",
"updated_at": "2025-06-22T11:45:34+01:00"
}
],
"type": "type",
"uuid": "f8e8b54a-3f37-42af-9cde-bd7f3502f159",
"folder": {
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "dd4be96e-119e-4833-8e99-2be27f3142b5",
"depth": 5,
"files": "App\\Http\\Resources\\FileResource",
"owned": false,
"folders": "App\\Http\\Resources\\FolderResource",
"parents": "App\\Http\\Resources\\FolderResource",
"children": "App\\Http\\Resources\\FolderResource",
"ancestors": "App\\Http\\Resources\\FolderResource",
"created_at": "2025-06-22T11:45:34+01:00",
"updated_at": "2025-06-22T11:45:34+01:00",
"files_count": 8,
"clients_read": true,
"documentable": "Object",
"participants": "App\\Http\\Resources\\FolderParticipantResource",
"clients_write": true,
"folders_count": 5,
"is_root_folder": true,
"is_pseudo_folder": true,
"is_system_folder": true,
"documentable_type": "account",
"documentable_uuid": "account",
"participants_count": 3,
"show_client_permissions": true
},
"status": "uploaded",
"account": {
"name": "Gareth Thompson",
"role": "client",
"type": "client",
"uuid": "965d3173-5c39-4903-b6dd-c22bd3bea9e7",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-06-22T11:45:34+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:34+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"filename": "Welcome to Plannr.pdf",
"progress": "100",
"extension": "pdf",
"navigator": {
"model_type": "account",
"model_uuid": "f718a6fb-6f84-4374-9ca4-9ec5c6acc6d5"
},
"created_at": "2025-06-22T11:45:34+01:00",
"updated_at": "2025-06-22T11:45:34+01:00",
"folder_name": "folder 2",
"uploaded_at": "2025-06-22T11:45:34+01:00",
"documentable": "Object",
"download_url": "https://plannr.valet/file/846eadf4-f0e0-4c28-974e-9f2e0a974cfc/download",
"last_modified": "2025-06-22T11:45:34+01:00",
"documentable_type": "account",
"original_created_at": "2025-06-22T11:45:34+01:00"
}Create a question for a section
Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Path parameters
-
form_uuid
integer Required
Body
Required
-
type
string Required The type of the question
-
required
boolean Required Whether the question is required or not
-
title
string Required The title of the question
-
help_text
string Input placeholder
-
caption
string User friendly description of what should be input
-
position
integer Required The position of the question in the section.
-
selection_options
array[string] Required The selection options for the question IF the question is of type selection.
-
section_uuid
string Required The uuid of the section to move the question to.
-
target_field
string The field to update if the question is filled in
-
linked_question_field
string Create a question from a linked field, with this, the type and selection options can be ignored
-
linked_primary
boolean If this is a contact detail or address field, should it be made primary?
POST
/api/v1/form/{form_uuid}/question
curl \
--request POST 'https://api.plannrcrm.com/api/v1/form/form_uuid/question' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"type":"string","required":"true","title":"What is your name?","help_text":"Gareth","caption":"Enter your full legal name","position":0,"selection_options":["apple","orange"],"section_uuid":"7670b278-b7b9-476d-a4eb-f8d0e8ac944f","target_field":"client.first_name","linked_question_field":"first_name","linked_primary":false}'
Request examples
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"type": "string",
"required": "true",
"title": "What is your name?",
"help_text": "Gareth",
"caption": "Enter your full legal name",
"position": 0,
"selection_options": [
"apple",
"orange"
],
"section_uuid": "7670b278-b7b9-476d-a4eb-f8d0e8ac944f",
"target_field": "client.first_name",
"linked_question_field": "first_name",
"linked_primary": false
}
Response examples (200)
{
"key": "what_is_your_name",
"type": "string",
"uuid": "534bb84f-e9a8-4733-98db-cc81523acda5",
"title": "What is your name?",
"caption": "Your full legal name",
"section": {
"form": "App\\Http\\Resources\\FormResource",
"uuid": "f1feb5cc-c410-4ba8-a5aa-e59e5c1bdda6",
"title": "Personal Details",
"position": 1,
"questions": "App\\Http\\Resources\\FormQuestionResource",
"created_at": "2025-06-22T11:45:33+01:00",
"updated_at": "2025-06-22T11:45:33+01:00"
},
"position": 1,
"required": true,
"help_text": "Gareth",
"created_at": "2025-06-22T11:45:33+01:00",
"updated_at": "2025-06-22T11:45:33+01:00",
"target_field": "name",
"linked_primary": true,
"linked_question": {
"type": "selection",
"field": "gender",
"label": "Gender",
"caption": "Your drink preference",
"forced_required": false,
"formatted_field": "Gender",
"is_custom_field": false,
"selection_options": [
"male",
"female",
"non-binary",
"transgender",
"intersex",
"other",
"unknown"
]
},
"selection_options": [
"option 1",
"option 2"
]
}Make a login the primary for the account
Headers
-
Content-Type
string -
Accept
string
Path parameters
-
account_uuid
integer Required -
login_uuid
integer Required -
account
string Required The uuid of the account which the login belongs to.
-
login
string Required The uuid of the login to display.
POST
/api/v1/account/{account_uuid}/login/{login_uuid}/make-primary
curl \
--request POST 'https://api.plannrcrm.com/api/v1/account/account_uuid/login/login_uuid/make-primary' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
Response examples (200)
{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "dfa3a718-76a0-40a3-a7d9-f01f93f2125b",
"county": "Hampshire",
"billing": {
"invoice_email": "gareth@codepotato.co.uk",
"invoice_county": "Hampshire",
"invoice_country": "United Kingdom",
"invoice_postcode": "PO7 7YH",
"invoice_address_1": "Suite E, 5 The Briars",
"invoice_address_2": "Waterberry Drive",
"invoice_town_city": "Waterlooville"
},
"country": "United Kingdom",
"postcode": "PO7 7YH",
"address_1": "Suite E, 5 The Briars",
"address_2": "Waterberry Drive",
"logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
"month_end": 25,
"town_city": "Waterlooville",
"created_at": "2025-06-22T11:45:30+01:00",
"updated_at": "2025-06-22T11:45:30+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
},
"uuid": "d2378e00-6d19-4a6b-baff-20766e1caad9",
"email": "gareth@plannrcrm.com",
"account": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "d1b3c577-0681-42fd-bc05-2ca4dafaf8ed",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:30+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:30+01:00",
"with_login": true,
"inactive_at": "2025-06-22",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-06-22T11:45:30+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-22T11:45:30+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-06-22T11:45:30+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-22T11:45:30+01:00"
},
"primary": false,
"last_name": "Thompson",
"created_at": "2025-06-22T11:45:30+01:00",
"expires_at": "2025-09-30T11:45:30+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-22T11:45:30+01:00",
"goals_enabled": true,
"tasks_enabled": true,
"wealth_enabled": true,
"is_impersonated": false,
"welcome_enabled": true,
"factfind_enabled": true,
"has_write_permission": false,
"has_delete_permission": false,
"receives_unread_notifications_email": true
}Lookups
APIs for managing lookups