Get an account Run in API Explorer
Ask AI
GET
/api/v1/account/{uuid}
curl \
--request GET 'https://api.plannrcrm.com/api/v1/account/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
--header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
"uuid": "7bb54235-1ce5-44e0-a7ac-dd55dcaef2d3",
"created_at": "2026-06-08T16:08:02+01:00",
"updated_at": "2026-06-08T16:08:02+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"firm": {
"uuid": "7754c0b0-de76-4891-ad9a-639f625bd57f",
"created_at": "2026-06-08T16:08:02+01:00",
"updated_at": "2026-06-08T16:08:02+01:00",
"name": "Codepotato",
"slug": "codepotato",
"address_1": "Suite E, 5 The Briars",
"address_2": "Waterberry Drive",
"town_city": "Waterlooville",
"county": "Hampshire",
"postcode": "PO7 7YH",
"country": "United Kingdom",
"regulatory_text": "Regulatory text",
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
"brand_colours": {
"sidebar_background": "#0E0E56",
"sidebar_accent": "#36367E",
"sidebar_text": "#FFFFFF",
"sidebar_hover": "#0A0A42",
"sidebar_active": "#53DBB8",
"sidebar_title_background": "#36367E",
"sidebar_title_primary": "#FFC634",
"sidebar_title_secondary": "#FFFFFF",
"sidebar_title_secondary_hover": "#FFFFFF",
"email_background": "#0E0E56",
"email_logo_background_panel": "#36367E",
"email_sub_text": "#FFFFFF",
"email_button_background": "#36367E",
"email_button_text": "#FFFFFF",
"portal_sidebar_button_background": "#F6F6F6",
"portal_sidebar_button_hover": "#FFFFFF",
"portal_sidebar_button_active": "#FFFFFF",
"portal_brand_title": "#323B4B",
"portal_brand_sub_title": "#828994",
"portal_sidebar_title": "#11151D",
"portal_sidebar_text": "#323B4B",
"portal_sidebar_text_hover": "#323B4B",
"portal_sidebar_text_active": "#323B4B",
"portal_sidebar_icon": "#828994",
"portal_sidebar_icon_hover": "#828994",
"portal_sidebar_icon_active": "#828994",
"portal_background": "#F6F6F6",
"portal_sidebar_account_title": "#11151D",
"portal_sidebar_account_email": "#828994",
"portal_sidebar_divider": "#E3E5E9",
"portal_dashboard_bg_one": "#EF4583",
"portal_dashboard_bg_two": "#FFC634",
"portal_sidebar_collapse_button": "#828994",
"portal_sidebar_collapse_button_hover": "#B3B9C4",
"portal_sidebar_user_select_background": "#F6F6F6",
"portal_sidebar_user_select_hover": "#F6F6F6",
"portal_sidebar_user_select_text": "#323B4B",
"portal_sidebar_user_select_text_hover": "#323B4B",
"portal_sidebar_user_select_border": "#EEEEEE",
"portal_sidebar_user_select_border_hover": "#828994"
},
"is_subscribed": true,
"addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
"keep_deleted_files_for": 30,
"tax": 17.5,
"month_end": 25,
"statement_frequency": "monthly",
"billing": {
"invoice_address_1": "Suite E, 5 The Briars",
"invoice_address_2": "Waterberry Drive",
"invoice_town_city": "Waterlooville",
"invoice_county": "Hampshire",
"invoice_postcode": "PO7 7YH",
"invoice_country": "United Kingdom",
"invoice_email": "gareth@codepotato.co.uk"
},
"task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
"ip_whitelist": [
"192.168.0.1",
"127.0.0.1"
],
"welcome_paragraph_html": "<h1>Welcome.</h1>",
"email_welcome_paragraph_html": "Welcome to Plannr!",
"show_fact_find_illustrations": true,
"cc_email_addresses": [
"jack@example.com",
"jill@example.com"
],
"bcc_email_addresses": [
"jack@example.com",
"jill@example.com"
],
"reply_to_email_address": "jack@example.com",
"mobile_app_support_number": "01234 567890",
"mobile_app_support_email": "support@example.com"
},
"primary_phone_number": {
"uuid": "24665280-25ff-4a17-a461-a86db5d0cf3f",
"created_at": "2026-06-08T16:08:02+01:00",
"updated_at": "2026-06-08T16:08:02+01:00",
"type": "phone_number",
"name": "Work number",
"value": "+443330903630",
"phone_number_meta": {
"country": "GB",
"formatted": "0333 090 3630"
},
"accounts": "App\\Http\\Resources\\AccountResource"
},
"primary_email": {
"uuid": "374153b8-601c-49bc-aa02-a4361275e109",
"created_at": "2026-06-08T16:08:02+01:00",
"updated_at": "2026-06-08T16:08:02+01:00",
"type": "phone_number",
"name": "Work number",
"value": "+443330903630",
"phone_number_meta": {
"country": "GB",
"formatted": "0333 090 3630"
},
"accounts": "App\\Http\\Resources\\AccountResource"
},
"current_time_entry": {
"uuid": "c6d16036-5d0b-4d50-a2c4-a7ba59e78128",
"created_at": "2026-06-08T16:08:02+01:00",
"updated_at": "2026-06-08T16:08:02+01:00",
"name": "Research",
"description": "This is a description.",
"trackable_type": "Client",
"trackable": "App\\Http\\Resources\\MinimalAccountResource",
"start_date": "2026-06-08T15:18:02+01:00",
"end_date": "2026-06-08T15:46:02+01:00",
"is_active": true,
"total_time_in_minutes": 28,
"computed_time_elapsed_in_seconds": 1680,
"account": "App\\Http\\Resources\\MinimalAccountResource"
},
"assigned_adviser": {
"uuid": "329023c1-5cf1-4085-b484-6d5195c3f15c",
"created_at": "2026-06-08T16:08:02+01:00",
"updated_at": "2026-06-08T16:08:02+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"firm": "App\\Http\\Resources\\FirmResource",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"business_unit": "App\\Http\\Resources\\BusinessUnitResource",
"groups": "App\\Http\\Resources\\GroupResource",
"tags": "App\\Http\\Resources\\TagResource",
"owners": "App\\Http\\Resources\\AccountResource",
"first_contact_date": "2026-06-08T16:08:02+01:00",
"next_review_date": "2026-06-08T16:08:02+01:00",
"previous_review_date": "2026-06-08T16:08:02+01:00",
"anniversary_review_date": "2026-06-08T16:08:02+01:00",
"terms_of_business_at": "2026-06-08T16:08:02+01:00",
"client_agreement_at": "2026-06-08T16:08:02+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"circles": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"inactive_at": "2026-06-08",
"last_interaction_at": "2026-06-08 16:08:02",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"assigned_administrator": {
"uuid": "69e136d3-688e-4146-a71a-d9c0d12aab95",
"created_at": "2026-06-08T16:08:02+01:00",
"updated_at": "2026-06-08T16:08:02+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"firm": "App\\Http\\Resources\\FirmResource",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"business_unit": "App\\Http\\Resources\\BusinessUnitResource",
"groups": "App\\Http\\Resources\\GroupResource",
"tags": "App\\Http\\Resources\\TagResource",
"owners": "App\\Http\\Resources\\AccountResource",
"first_contact_date": "2026-06-08T16:08:02+01:00",
"next_review_date": "2026-06-08T16:08:02+01:00",
"previous_review_date": "2026-06-08T16:08:02+01:00",
"anniversary_review_date": "2026-06-08T16:08:02+01:00",
"terms_of_business_at": "2026-06-08T16:08:02+01:00",
"client_agreement_at": "2026-06-08T16:08:02+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"circles": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"inactive_at": "2026-06-08",
"last_interaction_at": "2026-06-08 16:08:02",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"assigned_paraplanner": {
"uuid": "3436dc88-2e12-4d8d-8c8b-70fda7974573",
"created_at": "2026-06-08T16:08:02+01:00",
"updated_at": "2026-06-08T16:08:02+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"firm": "App\\Http\\Resources\\FirmResource",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"business_unit": "App\\Http\\Resources\\BusinessUnitResource",
"groups": "App\\Http\\Resources\\GroupResource",
"tags": "App\\Http\\Resources\\TagResource",
"owners": "App\\Http\\Resources\\AccountResource",
"first_contact_date": "2026-06-08T16:08:02+01:00",
"next_review_date": "2026-06-08T16:08:02+01:00",
"previous_review_date": "2026-06-08T16:08:02+01:00",
"anniversary_review_date": "2026-06-08T16:08:02+01:00",
"terms_of_business_at": "2026-06-08T16:08:02+01:00",
"client_agreement_at": "2026-06-08T16:08:02+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"circles": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"inactive_at": "2026-06-08",
"last_interaction_at": "2026-06-08 16:08:02",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"introduced_by": {
"uuid": "64c0dc1c-0f31-485c-83bf-4c1c44ded60b",
"created_at": "2026-06-08T16:08:02+01:00",
"updated_at": "2026-06-08T16:08:02+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"firm": "App\\Http\\Resources\\FirmResource",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"business_unit": "App\\Http\\Resources\\BusinessUnitResource",
"groups": "App\\Http\\Resources\\GroupResource",
"tags": "App\\Http\\Resources\\TagResource",
"owners": "App\\Http\\Resources\\AccountResource",
"first_contact_date": "2026-06-08T16:08:02+01:00",
"next_review_date": "2026-06-08T16:08:02+01:00",
"previous_review_date": "2026-06-08T16:08:02+01:00",
"anniversary_review_date": "2026-06-08T16:08:02+01:00",
"terms_of_business_at": "2026-06-08T16:08:02+01:00",
"client_agreement_at": "2026-06-08T16:08:02+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"circles": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"inactive_at": "2026-06-08",
"last_interaction_at": "2026-06-08 16:08:02",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"business_unit": {
"uuid": "97cdec89-9806-45e0-aa6f-b9d737b4b861",
"name": "Wealth Management",
"has_alternative_branding": false,
"brand_colours": [],
"members_count": 3,
"members": "App\\Http\\Resources\\AccountResource",
"groups_count": 2,
"groups": "App\\Http\\Resources\\GroupResource",
"firm": "App\\Http\\Resources\\FirmResource",
"created_at": "2026-06-08T16:08:02+01:00",
"updated_at": "2026-06-08T16:08:02+01:00"
},
"groups": [
{
"uuid": "d1f9bdd0-7ef0-464a-ae8f-51f4a8bced43",
"name": "finance",
"slug": "finance",
"participants_count": "3",
"participants": {
"uuid": {
"example": "3dbe4ff5-32c4-476b-8c5e-43bc139abbd6",
"description": "UUID of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"first_name": {
"example": "Gareth",
"description": "First name of the account"
},
"last_name": {
"example": "Thompson",
"description": "Last name of the account"
},
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"email": {
"example": "gareth@codepotato.co.uk",
"description": "Email of the account"
}
},
"created_at": "2026-06-08T16:08:02+01:00",
"updated_at": "2026-06-08T16:08:02+01:00"
}
],
"tags": [
{
"uuid": "bc5b82e6-8f1d-4f30-9712-4ba764d67755",
"created_at": "2026-06-08T16:08:02+01:00",
"updated_at": "2026-06-08T16:08:02+01:00",
"name": "Mortgage",
"slug": "mortgage",
"colour": "#ef4582"
}
],
"owners": [
{
"uuid": "f97d4e66-afc2-4ef6-aa39-2e431ad90cde",
"created_at": "2026-06-08T16:08:02+01:00",
"updated_at": "2026-06-08T16:08:02+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"firm": "App\\Http\\Resources\\FirmResource",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"business_unit": "App\\Http\\Resources\\BusinessUnitResource",
"groups": "App\\Http\\Resources\\GroupResource",
"tags": "App\\Http\\Resources\\TagResource",
"owners": "App\\Http\\Resources\\AccountResource",
"first_contact_date": "2026-06-08T16:08:02+01:00",
"next_review_date": "2026-06-08T16:08:02+01:00",
"previous_review_date": "2026-06-08T16:08:02+01:00",
"anniversary_review_date": "2026-06-08T16:08:02+01:00",
"terms_of_business_at": "2026-06-08T16:08:02+01:00",
"client_agreement_at": "2026-06-08T16:08:02+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"circles": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"inactive_at": "2026-06-08",
"last_interaction_at": "2026-06-08 16:08:02",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
}
],
"first_contact_date": "2026-06-08T16:08:02+01:00",
"next_review_date": "2026-06-08T16:08:02+01:00",
"previous_review_date": "2026-06-08T16:08:02+01:00",
"anniversary_review_date": "2026-06-08T16:08:02+01:00",
"terms_of_business_at": "2026-06-08T16:08:02+01:00",
"client_agreement_at": "2026-06-08T16:08:02+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"joint_account_circle": {
"uuid": "a8ea61e0-e1da-44a2-a5a0-c4787c677b9a",
"created_at": "2026-06-08T16:08:02+01:00",
"updated_at": "2026-06-08T16:08:02+01:00",
"name": "Jones Family",
"photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
"bg_colour": "#35f4e1",
"accounts": "App\\Http\\Resources\\AccountResource",
"groups": "App\\Http\\Resources\\GroupResource",
"joint_account_uuid": "50515763-7e68-4b31-b62c-13b8b73920f1",
"login_access_level": "write",
"current_life_stage_uuid": "837bbcb4-9b2e-4437-b0ad-5132225e6426",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"circles": [
{
"uuid": "ab9fd006-e52a-4ce6-abed-f69e2e804b93",
"created_at": "2026-06-08T16:08:02+01:00",
"updated_at": "2026-06-08T16:08:02+01:00",
"name": "Jones Family",
"photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
"bg_colour": "#35f4e1",
"accounts": "App\\Http\\Resources\\AccountResource",
"groups": "App\\Http\\Resources\\GroupResource",
"joint_account_uuid": "049e3a8a-3289-444c-b4eb-93ac869f8709",
"login_access_level": "write",
"current_life_stage_uuid": "b1034006-d685-4613-8554-e36a0c866cd0",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
}
],
"ownership_percentage": 100,
"inactive_at": "2026-06-08",
"last_interaction_at": "2026-06-08 16:08:02",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": [
{
"uuid": "9351decd-fcb8-4e2f-aa51-cb716512e0a8",
"created_at": "2026-06-08T16:08:02+01:00",
"updated_at": "2026-06-08T16:08:02+01:00",
"type": "string",
"name": "Favourite Drink",
"reference": "favourite_drink",
"is_required": false,
"value": "Coffee",
"selection_options": [
"Coffee",
"Tea",
"Water"
],
"help_text": "This is the client's favourite drink."
}
],
"external_references": [
{
"uuid": "bd70c5df-4e5d-4e8b-a525-fdad23a06f6d",
"created_at": "2026-06-08T16:08:02+01:00",
"updated_at": "2026-06-08T16:08:02+01:00",
"third_party": "nucleus",
"reference": "AB123456"
}
]
}