Get a group's participants

GET /api/v1/group/{group_uuid}/participants

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[name] string

    Name to filter by

  • filter[type] string

    Account type to filter by. Valid fields are [employee, client, external].

  • filter[role] string

    Account role to filter by. Valid fields are [owner, admin, member, individual, trust, business, joint, introducer].

  • sort string

    Field to sort by. Valid fields are [created_at, first_name, last_name, updated_at, type]. Negative sign to denote DESC. Defaults to 'name'.

  • per_page integer

    the amount of addon subscriptions per page (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/group/{group_uuid}/participants 
curl \
 -X GET https://api.plannrcrm.com/api/v1/group/group_uuid/participants \
 -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": "18f40e7c-51aa-4cbe-8008-4e40eccf4abd",
        "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-01-17T11:18:29+00:00",
        "updated_at": "2025-01-17T11:18:29+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": "bf18b952-fed5-408a-a428-a66bd0021160",
          "colour": "#ef4582",
          "created_at": "2025-01-17T11:18:29+00:00",
          "updated_at": "2025-01-17T11:18:29+00:00"
        }
      ],
      "type": "client",
      "uuid": "33b234d5-7c03-4e5e-b79d-6e536a176228",
      "email": "gareth@codepotato.co.uk",
      "groups": [
        {
          "name": "finance",
          "slug": "finance",
          "uuid": "425e9d83-9c8e-4c5a-9440-6b76a426533f",
          "created_at": "2025-01-17T11:18:29+00:00",
          "updated_at": "2025-01-17T11:18:29+00:00",
          "participants": {
            "name": {
              "example": "Gareth Thompson",
              "description": "Name of the account"
            },
            "role": {
              "example": "client",
              "description": "Role of the account"
            },
            "uuid": {
              "example": "086bb9f5-bbf3-47f6-bd62-59860176de7f",
              "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": "73b6c025-eedb-4a3d-9409-eb3dea57ad6b",
          "email": "gareth@codepotato.co.uk",
          "groups": "App\\Http\\Resources\\GroupResource",
          "owners": "App\\Http\\Resources\\AccountResource",
          "last_name": "Thompson",
          "created_at": "2025-01-17T11:18:29+00:00",
          "first_name": "Gareth",
          "updated_at": "2025-01-17T11:18:29+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": "2025-01-17T11:18:29+00:00",
          "has_joint_account": true,
          "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
          "first_contact_date": "2025-01-17T11:18:29+00:00",
          "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
          "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
          "previous_review_date": "2025-01-17T11:18:29+00:00",
          "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
          "assigned_administrator": "App\\Http\\Resources\\AccountResource",
          "anniversary_review_date": "2025-01-17T11:18:29+00:00"
        }
      ],
      "last_name": "Thompson",
      "created_at": "2025-01-17T11:18:29+00:00",
      "first_name": "Gareth",
      "updated_at": "2025-01-17T11:18:29+00:00",
      "with_login": true,
      "custom_fields": [
        {
          "name": "Favourite Drink",
          "type": "string",
          "uuid": "6806376d-a034-4174-a1a2-e9e94803ca03",
          "value": "Coffee",
          "help_text": "This is the client's favourite drink.",
          "reference": "favourite_drink",
          "created_at": "2025-01-17T11:18:29+00:00",
          "updated_at": "2025-01-17T11:18:29+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": "892c8f24-c098-4e13-b636-8a599ebdbe62",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2025-01-17T11:18:29+00:00",
        "first_name": "Gareth",
        "updated_at": "2025-01-17T11:18:29+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": "2025-01-17T11:18:29+00:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-01-17T11:18:29+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2025-01-17T11:18:29+00:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-01-17T11:18:29+00:00"
      },
      "primary_email": {
        "name": "Work number",
        "type": "phone_number",
        "uuid": "7f332d19-7039-440d-9df5-9a3c25bb5605",
        "value": "+443330903630",
        "accounts": "App\\Http\\Resources\\AccountResource",
        "created_at": "2025-01-17T11:18:29+00:00",
        "updated_at": "2025-01-17T11:18:29+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": "037160f1-1574-4e1b-86df-dff4c7c1b3be",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2025-01-17T11:18:29+00:00",
        "first_name": "Gareth",
        "updated_at": "2025-01-17T11:18:29+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": "2025-01-17T11:18:29+00:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-01-17T11:18:29+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2025-01-17T11:18:29+00:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-01-17T11:18:29+00:00"
      },
      "next_review_date": "2025-01-17T11:18:29+00:00",
      "has_joint_account": true,
      "current_time_entry": {
        "name": "Research",
        "uuid": "3b7bee83-a488-4e87-92a7-da56e1ae8ab2",
        "account": "App\\Http\\Resources\\MinimalAccountResource",
        "end_date": "2025-01-17T10:56:29+00:00",
        "is_active": true,
        "trackable": "App\\Http\\Resources\\MinimalAccountResource",
        "created_at": "2025-01-17T11:18:29+00:00",
        "start_date": "2025-01-17T10:28:29+00:00",
        "updated_at": "2025-01-17T11:18:29+00:00",
        "description": "This is a description.",
        "trackable_type": "Client",
        "total_time_in_minutes": 28,
        "computed_time_elapsed_in_seconds": 1680
      },
      "first_contact_date": "2025-01-17T11:18:29+00:00",
      "external_references": [
        {
          "uuid": "a1f5ea3f-ba26-4415-8b39-be35e5c0f083",
          "reference": "AB123456",
          "created_at": "2025-01-17T11:18:29+00:00",
          "updated_at": "2025-01-17T11:18:29+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": "59e5c282-68bf-4a1a-88e6-d5d4c789f034",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2025-01-17T11:18:29+00:00",
        "first_name": "Gareth",
        "updated_at": "2025-01-17T11:18:29+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": "2025-01-17T11:18:29+00:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-01-17T11:18:29+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2025-01-17T11:18:29+00:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-01-17T11:18:29+00:00"
      },
      "previous_review_date": "2025-01-17T11:18:29+00:00",
      "primary_phone_number": {
        "name": "Work number",
        "type": "phone_number",
        "uuid": "fb898247-5bc9-4827-bceb-1820c5ebc369",
        "value": "+443330903630",
        "accounts": "App\\Http\\Resources\\AccountResource",
        "created_at": "2025-01-17T11:18:29+00:00",
        "updated_at": "2025-01-17T11:18:29+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": "84d1c242-84c7-4fb7-afbc-19e24016b512",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2025-01-17T11:18:29+00:00",
        "first_name": "Gareth",
        "updated_at": "2025-01-17T11:18:29+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": "2025-01-17T11:18:29+00:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-01-17T11:18:29+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2025-01-17T11:18:29+00:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-01-17T11:18:29+00:00"
      },
      "anniversary_review_date": "2025-01-17T11:18:29+00:00"
    }
  ]
}