Get all account groups

GET /api/v1/account/{account_uuid}/groups
Personal access token & O auth2

Get all the groups where the account is participating in.

Query parameters

  • include string

    Comma separated list of relationships to include in the response. Valid relationships are [participants, participants_count].

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[name] string

    Name to filter by

  • 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
GET /api/v1/account/{account_uuid}/groups 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/account/account_uuid/groups' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "name": "finance",
      "slug": "finance",
      "uuid": "8430f347-46f8-49be-9184-7506a588c295",
      "created_at": "2025-04-02T13:27:54+01:00",
      "updated_at": "2025-04-02T13:27:54+01:00",
      "participants": {
        "name": {
          "example": "Gareth Thompson",
          "description": "Name of the account"
        },
        "role": {
          "example": "client",
          "description": "Role of the account"
        },
        "uuid": {
          "example": "6f801625-f397-4a84-8a58-a29ae41601fa",
          "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"
    }
  ]
}