GET /api/v1/group
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[name] string

    Name to filter by

  • filter[business_unit] string

    Filter by a business unit UUID.

  • include string

    Comma separated list of relationships to include. Valid relationships are [business_unit, participants].

  • sort string

    Field to sort by. Valid fields are [created_at, name, updated_at]. Negative sign to denote DESC. Defaults to '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]
      Hide data attributes Show data attributes object
      • uuid string

        UUID of the group

      • name string

        Name of the group

      • slug string

        Slug of the group

      • participants_count string

        Number of participants in the group

      • participants object

        Participants in this group

        Hide participants attributes Show participants attributes object
        • uuid object
          Hide uuid attributes Show uuid attributes object
          • example string
          • description string
        • role object
          Hide role attributes Show role attributes object
          • example string
          • description string
        • first_name object
          Hide first_name attributes Show first_name attributes object
          • example string
          • description string
        • last_name object
          Hide last_name attributes Show last_name attributes object
          • example string
          • description string
        • name object
          Hide name attributes Show name attributes object
          • example string
          • description string
        • email object
          Hide email attributes Show email attributes object
          • example string
          • description string
      • created_at string

        Timestamp of when the group was created

      • updated_at string

        Timestamp of when the group was updated
GET /api/v1/group 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/group' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "uuid": "b972462b-8404-4c75-9042-18c9910ae6c8",
      "name": "finance",
      "slug": "finance",
      "participants_count": "3",
      "participants": {
        "uuid": {
          "example": "daf2a042-541c-42c6-93dd-59e77b53c9c7",
          "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-04-29T12:52:59+01:00",
      "updated_at": "2026-04-29T12:52:59+01:00"
    }
  ]
}