APIGroups

List groups

List groups in the organization.

GET/groups

List groups in the organization.

Query Parameters

offset?integer

Number of items to skip before returning results.

Formatint32
Range0 <= value
Default0
limit?integer

Maximum number of items to return per page.

Formatint32
Range0 <= value <= 20
Default10
search?string

Free-text search term to filter results by name.

Lengthlength <= 255
sort_by?string
Default"created_at"

Value in

  • "created_at"
  • "name"
sort_order?string
Default"desc"

Value in

  • "asc"
  • "desc"

Response Body

application/json

application/json

curl -X GET "https://example.com/groups"
{  "items": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "created_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "total": 0,    "offset": 0,    "limit": 0  }}
{  "code": "bad_request",  "message": "string",  "validation_errors": [    {      "field": "string",      "message": "string",      "rule": "string"    }  ]}