GET
/api/v1/introducer/{uuid}
curl \
--request GET 'https://api.plannrcrm.com/api/v1/introducer/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--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": "c00a35e3-3265-4712-b115-88b8820204b9",
"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-08-07T13:41:40+01:00",
"updated_at": "2025-08-07T13:41:40+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": "90d41813-ed39-499d-a9c9-1298ee90d991",
"colour": "#ef4582",
"created_at": "2025-08-07T13:41:40+01:00",
"updated_at": "2025-08-07T13:41:40+01:00"
}
],
"type": "client",
"uuid": "b2c02125-c1e9-48db-8627-9e659906ce05",
"email": "gareth@codepotato.co.uk",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "bc79388a-1c16-458b-aca8-f0c17a246c01",
"created_at": "2025-08-07T13:41:40+01:00",
"updated_at": "2025-08-07T13:41:40+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "76c84a5c-991d-43cb-ba11-454c976110fd",
"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": "6f669747-29d2-434b-9ac8-3e387b7d3218",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"circles": "App\\Http\\Resources\\CircleResource",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-08-07T13:41:40+01:00",
"first_name": "Gareth",
"updated_at": "2025-08-07T13:41:40+01:00",
"with_login": true,
"inactive_at": "2025-08-07",
"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-08-07T13:41:40+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-08-07T13:41:40+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-08-07T13:41:40+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-08-07T13:41:40+01:00"
}
],
"circles": [
{
"name": "Jones Family",
"uuid": "79621022-4c59-46a6-9c49-8fc8bd3bac2f",
"groups": "App\\Http\\Resources\\GroupResource",
"accounts": "App\\Http\\Resources\\MinimalAccountResource",
"bg_colour": "#35f4e1",
"photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
"created_at": "2025-08-07T13:41:40+01:00",
"updated_at": "2025-08-07T13:41:40+01:00",
"joint_account_uuid": "fccd1f78-dc77-4311-a4cf-b9f095cf2ebd",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
}
],
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-08-07T13:41:40+01:00",
"first_name": "Gareth",
"updated_at": "2025-08-07T13:41:40+01:00",
"with_login": true,
"inactive_at": "2025-08-07",
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "7eccee15-de54-4a4f-9f64-160949455df8",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-08-07T13:41:40+01:00",
"updated_at": "2025-08-07T13:41:40+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": "3444fee2-2969-45fe-a3d0-834727d6df30",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"circles": "App\\Http\\Resources\\CircleResource",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-08-07T13:41:40+01:00",
"first_name": "Gareth",
"updated_at": "2025-08-07T13:41:40+01:00",
"with_login": true,
"inactive_at": "2025-08-07",
"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-08-07T13:41:40+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-08-07T13:41:40+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-08-07T13:41:40+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-08-07T13:41:40+01:00"
},
"primary_email": {
"name": "Work number",
"type": "phone_number",
"uuid": "071069c7-f0c8-475d-84db-516655ae8851",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-08-07T13:41:40+01:00",
"updated_at": "2025-08-07T13:41:40+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": "7c667df2-8b79-40c6-b624-a566ee0dea49",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"circles": "App\\Http\\Resources\\CircleResource",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-08-07T13:41:40+01:00",
"first_name": "Gareth",
"updated_at": "2025-08-07T13:41:40+01:00",
"with_login": true,
"inactive_at": "2025-08-07",
"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-08-07T13:41:40+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-08-07T13:41:40+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-08-07T13:41:40+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-08-07T13:41:40+01:00"
},
"next_review_date": "2025-08-07T13:41:40+01:00",
"has_joint_account": true,
"current_time_entry": {
"name": "Research",
"uuid": "06b530af-05ef-4cad-86b6-ea2771f7942d",
"account": "App\\Http\\Resources\\MinimalAccountResource",
"end_date": "2025-08-07T13:19:40+01:00",
"is_active": true,
"trackable": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2025-08-07T13:41:40+01:00",
"start_date": "2025-08-07T12:51:40+01:00",
"updated_at": "2025-08-07T13:41:40+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-08-07T13:41:40+01:00",
"external_references": [
{
"uuid": "b700d019-71e6-4c2b-97b2-f1fddca6abc7",
"reference": "AB123456",
"created_at": "2025-08-07T13:41:40+01:00",
"updated_at": "2025-08-07T13:41:40+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": "042885d7-eab8-4a08-9c71-e985920e05c7",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"circles": "App\\Http\\Resources\\CircleResource",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-08-07T13:41:40+01:00",
"first_name": "Gareth",
"updated_at": "2025-08-07T13:41:40+01:00",
"with_login": true,
"inactive_at": "2025-08-07",
"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-08-07T13:41:40+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-08-07T13:41:40+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-08-07T13:41:40+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-08-07T13:41:40+01:00"
},
"joint_account_circle": {
"name": "Jones Family",
"uuid": "cbcc9bd3-41bf-483c-bc47-de59f003d38e",
"groups": "App\\Http\\Resources\\GroupResource",
"accounts": "App\\Http\\Resources\\MinimalAccountResource",
"bg_colour": "#35f4e1",
"photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
"created_at": "2025-08-07T13:41:40+01:00",
"updated_at": "2025-08-07T13:41:40+01:00",
"joint_account_uuid": "02aec7e1-1727-40f9-928b-16175ac1bccb",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"ownership_percentage": 100,
"previous_review_date": "2025-08-07T13:41:40+01:00",
"primary_phone_number": {
"name": "Work number",
"type": "phone_number",
"uuid": "3292cec8-f887-49e6-bb41-c2414d4d7235",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-08-07T13:41:40+01:00",
"updated_at": "2025-08-07T13:41:40+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": "6d36507a-2071-4666-a66c-2a5c49a14a7e",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"circles": "App\\Http\\Resources\\CircleResource",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-08-07T13:41:40+01:00",
"first_name": "Gareth",
"updated_at": "2025-08-07T13:41:40+01:00",
"with_login": true,
"inactive_at": "2025-08-07",
"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-08-07T13:41:40+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-08-07T13:41:40+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-08-07T13:41:40+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-08-07T13:41:40+01:00"
},
"anniversary_review_date": "2025-08-07T13:41:40+01:00"
}