View an introducer [Deprecated: Use get an account route] Run in API Explorer
Ask AI
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)
{
"uuid": "d61df90b-a21b-44a7-b3f8-f494b4453f77",
"created_at": "2026-05-21T13:23:45+01:00",
"updated_at": "2026-05-21T13:23:45+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": "74a42f1f-b41b-4dec-aae5-8116243647df",
"created_at": "2026-05-21T13:23:45+01:00",
"updated_at": "2026-05-21T13:23:45+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": "125d567a-9c90-44d4-a4a9-b17b03048408",
"created_at": "2026-05-21T13:23:45+01:00",
"updated_at": "2026-05-21T13:23:45+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": "78afb69d-9f8e-41b7-be84-bee8be0487db",
"created_at": "2026-05-21T13:23:45+01:00",
"updated_at": "2026-05-21T13:23:45+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": "43c93b59-4df9-4425-b126-7431ff668d56",
"created_at": "2026-05-21T13:23:45+01:00",
"updated_at": "2026-05-21T13:23:45+01:00",
"name": "Research",
"description": "This is a description.",
"trackable_type": "Client",
"trackable": "App\\Http\\Resources\\MinimalAccountResource",
"start_date": "2026-05-21T12:33:45+01:00",
"end_date": "2026-05-21T13:01:45+01:00",
"is_active": true,
"total_time_in_minutes": 28,
"computed_time_elapsed_in_seconds": 1680,
"account": "App\\Http\\Resources\\MinimalAccountResource"
},
"assigned_adviser": {
"uuid": "20b2a76b-95bf-4300-a2f1-b880481b9157",
"created_at": "2026-05-21T13:23:45+01:00",
"updated_at": "2026-05-21T13:23:45+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-05-21T13:23:45+01:00",
"next_review_date": "2026-05-21T13:23:45+01:00",
"previous_review_date": "2026-05-21T13:23:45+01:00",
"anniversary_review_date": "2026-05-21T13:23:45+01:00",
"terms_of_business_at": "2026-05-21T13:23:45+01:00",
"client_agreement_at": "2026-05-21T13:23:45+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-05-21",
"last_interaction_at": "2026-05-21 13:23:45",
"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": "7979c028-781a-439d-ace0-4a44f694e05f",
"created_at": "2026-05-21T13:23:45+01:00",
"updated_at": "2026-05-21T13:23:45+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-05-21T13:23:45+01:00",
"next_review_date": "2026-05-21T13:23:45+01:00",
"previous_review_date": "2026-05-21T13:23:45+01:00",
"anniversary_review_date": "2026-05-21T13:23:45+01:00",
"terms_of_business_at": "2026-05-21T13:23:45+01:00",
"client_agreement_at": "2026-05-21T13:23:45+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-05-21",
"last_interaction_at": "2026-05-21 13:23:45",
"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": "3ad64f73-231a-4444-99e6-4a62e9150f22",
"created_at": "2026-05-21T13:23:45+01:00",
"updated_at": "2026-05-21T13:23:45+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-05-21T13:23:45+01:00",
"next_review_date": "2026-05-21T13:23:45+01:00",
"previous_review_date": "2026-05-21T13:23:45+01:00",
"anniversary_review_date": "2026-05-21T13:23:45+01:00",
"terms_of_business_at": "2026-05-21T13:23:45+01:00",
"client_agreement_at": "2026-05-21T13:23:45+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-05-21",
"last_interaction_at": "2026-05-21 13:23:45",
"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": "c6658374-4757-473d-bbf2-38125025cd2a",
"created_at": "2026-05-21T13:23:45+01:00",
"updated_at": "2026-05-21T13:23:45+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-05-21T13:23:45+01:00",
"next_review_date": "2026-05-21T13:23:45+01:00",
"previous_review_date": "2026-05-21T13:23:45+01:00",
"anniversary_review_date": "2026-05-21T13:23:45+01:00",
"terms_of_business_at": "2026-05-21T13:23:45+01:00",
"client_agreement_at": "2026-05-21T13:23:45+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-05-21",
"last_interaction_at": "2026-05-21 13:23:45",
"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": "951bfa48-8251-409c-a573-fd10f82c8e87",
"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-05-21T13:23:45+01:00",
"updated_at": "2026-05-21T13:23:45+01:00"
},
"groups": [
{
"uuid": "d770f8a1-4615-4c18-b6d3-9db9fa175ab9",
"name": "finance",
"slug": "finance",
"participants_count": "3",
"participants": {
"uuid": {
"example": "b39365d3-f73c-4c97-9c5f-3428486163de",
"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-05-21T13:23:45+01:00",
"updated_at": "2026-05-21T13:23:45+01:00"
}
],
"tags": [
{
"uuid": "ed2ee8bc-600e-4072-90ad-39e0db90ef8f",
"created_at": "2026-05-21T13:23:45+01:00",
"updated_at": "2026-05-21T13:23:45+01:00",
"name": "Mortgage",
"slug": "mortgage",
"colour": "#ef4582"
}
],
"owners": [
{
"uuid": "fdf1c6d8-d87e-4fe9-92dd-0fb91eba7016",
"created_at": "2026-05-21T13:23:45+01:00",
"updated_at": "2026-05-21T13:23:45+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-05-21T13:23:45+01:00",
"next_review_date": "2026-05-21T13:23:45+01:00",
"previous_review_date": "2026-05-21T13:23:45+01:00",
"anniversary_review_date": "2026-05-21T13:23:45+01:00",
"terms_of_business_at": "2026-05-21T13:23:45+01:00",
"client_agreement_at": "2026-05-21T13:23:45+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-05-21",
"last_interaction_at": "2026-05-21 13:23:45",
"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-05-21T13:23:45+01:00",
"next_review_date": "2026-05-21T13:23:45+01:00",
"previous_review_date": "2026-05-21T13:23:45+01:00",
"anniversary_review_date": "2026-05-21T13:23:45+01:00",
"terms_of_business_at": "2026-05-21T13:23:45+01:00",
"client_agreement_at": "2026-05-21T13:23:45+01:00",
"with_login": true,
"has_joint_account": true,
"can_be_deleted": "false",
"joint_account_circle": {
"uuid": "697e4a04-fa6a-496d-9ee6-ed19c3a44789",
"created_at": "2026-05-21T13:23:45+01:00",
"updated_at": "2026-05-21T13:23:45+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": "444ce571-2344-4f2a-a852-1083311ebe3a",
"login_access_level": "write",
"current_life_stage_uuid": "e710f207-0d4a-4162-b968-a7fb206ca37d",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"circles": [
{
"uuid": "3497534f-b22e-4f1d-a15a-efd9a45e7a2c",
"created_at": "2026-05-21T13:23:45+01:00",
"updated_at": "2026-05-21T13:23:45+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": "edb5cb2c-6e40-468a-a764-90f15048ab48",
"login_access_level": "write",
"current_life_stage_uuid": "72e95f86-9b63-4d7d-ab10-58745fc940cb",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
}
],
"ownership_percentage": 100,
"inactive_at": "2026-05-21",
"last_interaction_at": "2026-05-21 13:23:45",
"referral_code": "ABC12345",
"permissions": {
"firm:read": [
"firm"
],
"network:read": [
"network:uuid"
]
},
"custom_fields": [
{
"uuid": "ce1526a8-3b6a-4152-9450-5466e8ad5fef",
"created_at": "2026-05-21T13:23:45+01:00",
"updated_at": "2026-05-21T13:23:45+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": "8bcab6b1-1d4a-4dba-a1db-efb489163da8",
"created_at": "2026-05-21T13:23:45+01:00",
"updated_at": "2026-05-21T13:23:45+01:00",
"third_party": "nucleus",
"reference": "AB123456"
}
]
}