GET/v1/definitions/{key}/groups

List a page's record groups

The named record groups on one page — the collections a person makes and files records into — each with its description, colour, status-group filing, position and how many records it holds. Groups are row DATA, so any seat may read and make them, unlike the page's status vocabulary. A group is not a status: a record can be in several of them, or in none.

Access class: def:read.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

keypath · stringrequired

bodyquery · nulloptional

paramsquery · objectoptional

:keystringoptional

queryquery · objectoptional

Responses

200application/json

the action's answer

{
  "data": [
    "string"
  ]
}

dataarray<object>required

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired