Get a group

GET /api/v1/group/{uuid}

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

{
  "name": "finance",
  "slug": "finance",
  "uuid": "749a484c-67f1-483e-96b2-6023a60de5b2",
  "created_at": "2024-10-16T11:10:14+01:00",
  "updated_at": "2024-10-16T11:10:14+01:00",
  "participants": {
    "name": {
      "example": "Gareth Thompson",
      "description": "Name of the account"
    },
    "role": {
      "example": "client",
      "description": "Role of the account"
    },
    "uuid": {
      "example": "d6c3badf-832e-4866-a9e3-9327f6483f26",
      "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"
}