v356

OpenAPI 3.0.3raw.githubusercontent.com2026-08-031733562.1 MB
Seat Metrics

List all seat metrics

Retrieve a paginated list of all your seat metrics.

get/seat-metrics

Query parameters

limitinteger

Maximum number of objects to return per-page. Must be between 1 and 100 (inclusive).

afterstring

Pagination offset. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.

beforestring

Pagination offset. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.next or pagination.previous to retrieve each page.

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version'2024-07-30'

Use this header to select an API version

Response

OK

Example response

{
  "items": [
    {
      "id": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
      "seatType": "admin",
      "createdBy": "4ffd439e-32e5-4046-bb40-3cb81f40e5da",
      "label": "Administrator",
      "description": "Allows user to make admin changes over whole account",
      "createdAt": "2022-06-28T16:47:00Z",
      "updatedAt": "2022-06-28T16:47:00Z"
    }
  ],
  "pagination": {
    "after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
    "before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
    "totalResultSize": 10
  }
}