v1

latestOpenAPI 3.0.22026-08-045831103.6 KB

Groups

List groups

Retrieve a paginated list of groups

get/v1/groups

Query parameters

limitinteger

Max number of rows returned

offsetinteger

Number of rows skipped of the result

pageinteger

Select the page of the result

Headers

api-tokenstring required

API Token

Response

A list of groups

statusinteger

Response status

totalCountinteger

Total items based on current filters

pageinteger

Current page

totalPagesinteger

Total pages based on current filters

hasNextboolean

Indicates that has next page

hasPreviousboolean

Indicates that has previous page

Example response

{
  "data": [
    {
      "id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
      "name": "Group name",
      "archived_at": "2020-01-01T14:15:00.000000+00:00",
      "archived_by": "8feade82-d77b-4e8b-9d35-fd43e972b5c8"
    }
  ]
}