Query parameters
-
Comma separated list of relationships to include in the response. Valid relationships are [primary_phone_number,primary_email, assigned_adviser, charge_split_schema, tags, groups].
-
Filter by a comma separated list of UUIDs.
-
Filter employees by name. This is a partial match against first_name, last_name, and entity_name together.
-
Filter employees that have an email with a partial match.
-
Comma separated string to filter by different employee types. Valid types are [owner, admin, member].
-
Date to filter when the client was created after.
-
Date to filter when the client was created before.
-
Comma separated list of partial groups names or group UUIDs.
-
Provide a group UUID (or multiple as a comma-separated string) to filter introducers within the provided groups out from the response.
-
Field to sort by. Valid fields are [created_at, updated_at, first_name, last_name, email]. Negative sign to denote DESC. Defaults to 'first_name'.
-
Number of results to return with pagination (Default 15. Max 500).
curl \
--request GET 'https://api.plannrcrm.com/api/v1/introducer' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
{
"data": [
{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "d07ba015-70d1-4f8b-9b30-0da9b2c574f6",
"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-07-17T16:23:20+01:00",
"updated_at": "2025-07-17T16:23:20+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": "89879c16-bef9-48d5-bd95-e68ea3272eba",
"colour": "#ef4582",
"created_at": "2025-07-17T16:23:20+01:00",
"updated_at": "2025-07-17T16:23:20+01:00"
}
],
"type": "client",
"uuid": "6390a93b-d2be-4260-852f-2370f89f5486",
"email": "gareth@codepotato.co.uk",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "918f520f-4653-421b-9932-3cd156c46373",
"created_at": "2025-07-17T16:23:20+01:00",
"updated_at": "2025-07-17T16:23:20+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "a8437459-4e6e-4a67-bbe2-d24d204f0444",
"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": "99369678-6634-46b7-8267-20b9aa6a4d2b",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-07-17T16:23:20+01:00",
"first_name": "Gareth",
"updated_at": "2025-07-17T16:23:20+01:00",
"with_login": true,
"inactive_at": "2025-07-17",
"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-07-17T16:23:20+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-07-17T16:23:20+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-07-17T16:23:20+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-07-17T16:23:20+01:00"
}
],
"last_name": "Thompson",
"created_at": "2025-07-17T16:23:20+01:00",
"first_name": "Gareth",
"updated_at": "2025-07-17T16:23:20+01:00",
"with_login": true,
"inactive_at": "2025-07-17",
"custom_fields": [
{
"name": "Favourite Drink",
"type": "string",
"uuid": "6a223f6c-9e5d-4d1b-aae5-6b88a0fe7c11",
"value": "Coffee",
"help_text": "This is the client's favourite drink.",
"reference": "favourite_drink",
"created_at": "2025-07-17T16:23:20+01:00",
"updated_at": "2025-07-17T16:23:20+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": "5445a924-4ecb-46fb-975e-8da465b5c90c",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-07-17T16:23:20+01:00",
"first_name": "Gareth",
"updated_at": "2025-07-17T16:23:20+01:00",
"with_login": true,
"inactive_at": "2025-07-17",
"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-07-17T16:23:20+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-07-17T16:23:20+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-07-17T16:23:20+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-07-17T16:23:20+01:00"
},
"primary_email": {
"name": "Work number",
"type": "phone_number",
"uuid": "e19d33b9-41a8-4ffc-bc0b-567b29a5b342",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-07-17T16:23:20+01:00",
"updated_at": "2025-07-17T16:23:20+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": "407ca306-3ccc-41fa-b8c0-7207d35c57c2",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-07-17T16:23:20+01:00",
"first_name": "Gareth",
"updated_at": "2025-07-17T16:23:20+01:00",
"with_login": true,
"inactive_at": "2025-07-17",
"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-07-17T16:23:20+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-07-17T16:23:20+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-07-17T16:23:20+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-07-17T16:23:20+01:00"
},
"next_review_date": "2025-07-17T16:23:20+01:00",
"has_joint_account": true,
"current_time_entry": {
"name": "Research",
"uuid": "2f39cd92-31a7-4134-868a-cf8c9d2b00c9",
"account": "App\\Http\\Resources\\MinimalAccountResource",
"end_date": "2025-07-17T16:01:20+01:00",
"is_active": true,
"trackable": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2025-07-17T16:23:20+01:00",
"start_date": "2025-07-17T15:33:20+01:00",
"updated_at": "2025-07-17T16:23:20+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-07-17T16:23:20+01:00",
"external_references": [
{
"uuid": "d1a9cdfa-bac7-4e62-8d3b-9d2ca6d06a6d",
"reference": "AB123456",
"created_at": "2025-07-17T16:23:20+01:00",
"updated_at": "2025-07-17T16:23:20+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": "cecd07e5-926e-49a7-97b4-e21bdd2a9c46",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-07-17T16:23:20+01:00",
"first_name": "Gareth",
"updated_at": "2025-07-17T16:23:20+01:00",
"with_login": true,
"inactive_at": "2025-07-17",
"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-07-17T16:23:20+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-07-17T16:23:20+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-07-17T16:23:20+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-07-17T16:23:20+01:00"
},
"joint_account_circle": {
"name": "Jones Family",
"uuid": "65345abf-11ec-4ca9-8210-8fd2bca3f947",
"groups": "App\\Http\\Resources\\GroupResource",
"accounts": "App\\Http\\Resources\\MinimalAccountResource",
"created_at": "2025-07-17T16:23:20+01:00",
"updated_at": "2025-07-17T16:23:20+01:00",
"joint_account_uuid": "a71cf961-ecb0-4b40-a008-fbcb4f022e05",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"ownership_percentage": 100,
"previous_review_date": "2025-07-17T16:23:20+01:00",
"primary_phone_number": {
"name": "Work number",
"type": "phone_number",
"uuid": "b3bdb393-e38e-4420-8ff5-2a1600bc2e99",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-07-17T16:23:20+01:00",
"updated_at": "2025-07-17T16:23:20+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": "d4b4d28c-9652-442e-b7df-eb7e398edcec",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-07-17T16:23:20+01:00",
"first_name": "Gareth",
"updated_at": "2025-07-17T16:23:20+01:00",
"with_login": true,
"inactive_at": "2025-07-17",
"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-07-17T16:23:20+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-07-17T16:23:20+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-07-17T16:23:20+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-07-17T16:23:20+01:00"
},
"anniversary_review_date": "2025-07-17T16:23:20+01:00"
}
]
}