Get all introducers

GET /api/v1/introducer

Query parameters

  • include string

    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[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[name] string

    Filter employees by name. This is a partial match against first_name, last_name, and entity_name together.

  • filter[email] string

    Filter employees that have an email with a partial match.

  • filter[type] string

    Comma separated string to filter by different employee types. Valid types are [owner, admin, member].

  • filter[created_after] string

    Date to filter when the client was created after. Example 2022-04-05

  • filter[created_before] string

    Date to filter when the client was created before. Example 2022-05-31

  • filter[tags] string

    Comma separated list of tag names or tag UUIDs.

  • filter[groups] string

    Comma separated list of partial groups names or group UUIDs.

  • filter[exclude_groups] string

    Provide a group UUID (or multiple as a comma-separated string) to filter introducers within the provided groups out from the response.

  • sort string

    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'.

  • per_page integer

    Number of results to return with pagination (Default 15. Max 500).

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]

      Additional properties are allowed.
GET /api/v1/introducer 
curl \
 -X GET https://api.plannrcrm.com/api/v1/introducer \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "firm": {
        "tax": 17.5,
        "logo": "https://api.plannrcrm.com/images/plannr.jpg",
        "name": "Codepotato",
        "slug": "codepotato",
        "uuid": "3a860877-b29e-4e5f-b7a6-8d7200b5cbbb",
        "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": "2024-11-20T13:24:01+00:00",
        "updated_at": "2024-11-20T13:24:01+00: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",
          "sidebar_background": "#0E0E56",
          "sidebar_title_primary": "#FFC634",
          "email_button_background": "#36367E",
          "sidebar_title_secondary": "#ffffff",
          "sidebar_title_background": "#36367E",
          "email_logo_background_panel": "#36367E",
          "sidebar_title_secondary_hover": "#ffffff"
        },
        "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!"
      },
      "name": "Gareth Thompson",
      "role": "client",
      "tags": [
        {
          "name": "Mortgage",
          "slug": "mortgage",
          "uuid": "5ee07c2b-de95-45ec-8c69-5e7eca7f7c14",
          "colour": "#ef4582",
          "created_at": "2024-11-20T13:24:01+00:00",
          "updated_at": "2024-11-20T13:24:01+00:00"
        }
      ],
      "type": "client",
      "uuid": "1b6709f8-bf76-4243-bece-908270d06766",
      "email": "gareth@codepotato.co.uk",
      "groups": [
        {
          "name": "finance",
          "slug": "finance",
          "uuid": "f93f92b6-e9e9-4409-b438-8faeef26afc9",
          "created_at": "2024-11-20T13:24:01+00:00",
          "updated_at": "2024-11-20T13:24:01+00:00",
          "participants": {
            "name": {
              "example": "Gareth Thompson",
              "description": "Name of the account"
            },
            "role": {
              "example": "client",
              "description": "Role of the account"
            },
            "uuid": {
              "example": "b1c573b8-6a5d-465f-8c74-4880770e44a8",
              "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": "7a2d6f5d-2ad3-47c9-9fe0-40872738f336",
          "email": "gareth@codepotato.co.uk",
          "groups": "App\\Http\\Resources\\GroupResource",
          "owners": "App\\Http\\Resources\\AccountResource",
          "last_name": "Thompson",
          "created_at": "2024-11-20T13:24:01+00:00",
          "first_name": "Gareth",
          "updated_at": "2024-11-20T13:24:01+00:00",
          "with_login": true,
          "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": "2024-11-20T13:24:01+00:00",
          "has_joint_account": true,
          "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
          "first_contact_date": "2024-11-20T13:24:01+00:00",
          "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
          "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
          "previous_review_date": "2024-11-20T13:24:01+00:00",
          "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
          "assigned_administrator": "App\\Http\\Resources\\AccountResource",
          "anniversary_review_date": "2024-11-20T13:24:01+00:00"
        }
      ],
      "last_name": "Thompson",
      "created_at": "2024-11-20T13:24:01+00:00",
      "first_name": "Gareth",
      "updated_at": "2024-11-20T13:24:01+00:00",
      "with_login": true,
      "custom_fields": [
        {
          "name": "Favourite Drink",
          "type": "string",
          "uuid": "aecf9e3e-6b75-4d4d-9b6f-07c8c3f6eded",
          "value": "Coffee",
          "help_text": "This is the client's favourite drink.",
          "reference": "favourite_drink",
          "created_at": "2024-11-20T13:24:01+00:00",
          "updated_at": "2024-11-20T13:24:01+00: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": "169e9b1d-8039-4517-a36d-6750896a8011",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2024-11-20T13:24:01+00:00",
        "first_name": "Gareth",
        "updated_at": "2024-11-20T13:24:01+00:00",
        "with_login": true,
        "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": "2024-11-20T13:24:01+00:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2024-11-20T13:24:01+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2024-11-20T13:24:01+00:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2024-11-20T13:24:01+00:00"
      },
      "primary_email": {
        "name": "Work number",
        "type": "phone_number",
        "uuid": "9353b2c9-656b-4654-8df9-bdf3cec2467f",
        "value": "+443330903630",
        "accounts": "App\\Http\\Resources\\AccountResource",
        "created_at": "2024-11-20T13:24:01+00:00",
        "updated_at": "2024-11-20T13:24:01+00: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": "80b1652f-de26-4104-8c53-1b4636cad9ef",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2024-11-20T13:24:01+00:00",
        "first_name": "Gareth",
        "updated_at": "2024-11-20T13:24:01+00:00",
        "with_login": true,
        "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": "2024-11-20T13:24:01+00:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2024-11-20T13:24:01+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2024-11-20T13:24:01+00:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2024-11-20T13:24:01+00:00"
      },
      "next_review_date": "2024-11-20T13:24:01+00:00",
      "has_joint_account": true,
      "current_time_entry": {
        "name": "Research",
        "uuid": "82d9c43d-c4e7-4676-b5fd-6b6140400909",
        "end_date": "2024-11-20T13:24:01+00:00",
        "is_active": "1",
        "trackable": "Client",
        "start_date": "2024-11-20T13:24:01+00:00"
      },
      "first_contact_date": "2024-11-20T13:24:01+00:00",
      "external_references": [
        {
          "uuid": "64b04784-c2af-4e24-ad22-28fe32626454",
          "reference": "AB123456",
          "created_at": "2024-11-20T13:24:01+00:00",
          "updated_at": "2024-11-20T13:24:01+00:00",
          "third_party": "nucleus"
        }
      ],
      "assigned_paraplanner": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "f279d164-dd53-4a3b-8dff-2abf6d38278f",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2024-11-20T13:24:01+00:00",
        "first_name": "Gareth",
        "updated_at": "2024-11-20T13:24:01+00:00",
        "with_login": true,
        "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": "2024-11-20T13:24:01+00:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2024-11-20T13:24:01+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2024-11-20T13:24:01+00:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2024-11-20T13:24:01+00:00"
      },
      "previous_review_date": "2024-11-20T13:24:01+00:00",
      "primary_phone_number": {
        "name": "Work number",
        "type": "phone_number",
        "uuid": "0ddb07c5-ea79-417b-89aa-c01a7bffa326",
        "value": "+443330903630",
        "accounts": "App\\Http\\Resources\\AccountResource",
        "created_at": "2024-11-20T13:24:01+00:00",
        "updated_at": "2024-11-20T13:24:01+00: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": "466714b9-f5da-4e5f-bf5b-0ee7242b17a8",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2024-11-20T13:24:01+00:00",
        "first_name": "Gareth",
        "updated_at": "2024-11-20T13:24:01+00:00",
        "with_login": true,
        "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": "2024-11-20T13:24:01+00:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2024-11-20T13:24:01+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2024-11-20T13:24:01+00:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2024-11-20T13:24:01+00:00"
      },
      "anniversary_review_date": "2024-11-20T13:24:01+00:00"
    }
  ]
}