Get all account groups
Get all the groups where the account is participating in.
Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
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).
GET /api/v1/account/{account_uuid}/groups
curl \
-X GET https://api.plannrcrm.com/api/v1/account/account_uuid/groups \
-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": [
{
"name": "finance",
"slug": "finance",
"uuid": "dbe73504-7b38-47c1-828e-199808b1c662",
"created_at": "2024-11-20T13:23:59+00:00",
"updated_at": "2024-11-20T13:23:59+00:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "34946bb2-cc37-4dd8-a9d1-0b3cea88b437",
"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"
}
]
}