v1

latestOpenAPI 3.1.02026-07-2489171167.4 KB
Groups

Get list of groups

Retrieves a paginated list of groups.

get/groups

Query parameters

limitinteger

The number of records to return per page, up to 500.

offsetinteger

The offset for pagination. Calculated as (page - 1) * limit (page starts at 1).

Response

Returns a paginated list of groups.

limitinteger

The number of items that are returned per page

offsetinteger

The offset used for pagination.

totalinteger

The total number of elements across all pages.

Example response

{
  "limit": 20,
  "total": 50,
  "data": [
    {
      "name": "IT Support",
      "supportLevel": 3,
      "companyId": 1001,
      "email": "support@example.com",
      "receiveAutomaticSrEmailNotifications": true,
      "canBeAssignedToServiceRecord": true,
      "id": 123
    }
  ]
}