Get a group

GET /api/v1/group/{uuid}

Personal access token & O auth2

Headers

Path parameters

uuid integer Required

Responses

200 application/json
Hide response attributes Show response 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
- created_at string
  
  Timestamp of when the group was created
- updated_at string
  
  Timestamp of when the group was updated

GET /api/v1/group/{uuid}

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/group/uuid' \
 --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)

{
  "name": "finance",
  "slug": "finance",
  "uuid": "7d1a7b3b-c02c-47f6-b91f-c81f7435387a",
  "created_at": "2025-05-14T18:27:12+01:00",
  "updated_at": "2025-05-14T18:27:12+01:00",
  "participants": {
    "name": {
      "example": "Gareth Thompson",
      "description": "Name of the account"
    },
    "role": {
      "example": "client",
      "description": "Role of the account"
    },
    "uuid": {
      "example": "8446b138-1fbd-48ed-8431-d8df5ea4caf4",
      "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"
}