v356

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

Seat Metrics

List Seat balances by Customer

List Seat balances grouped by Customer and seat type.

get/seat-balances

Query parameters

excludeZeroQuantityboolean

Exclude customers with no seats usage. Defaults to false.

customerAliasesstring

Filter seat balances by customer alias

customerIdsstring

Filter seat balances by customer IDs. Max 25 IDs.

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version'2024-07-30'

Use this header to select an API version

Response

Example response

{
  "items": [
    {
      "id": "d82010a6-6835-41f8-9dd3-6f858f617f35",
      "sequenceAccountId": "806460ce-050d-45e4-8d22-b403a523b866",
      "legalName": "Acme Corp",
      "customerAliases": [
        "acme"
      ],
      "total": 10,
      "changeTimestamp": "2022-06-28T16:47:00Z",
      "balances": [
        {
          "seatType": "admin",
          "total": 10,
          "changeTimestamp": "2022-06-28T16:47:00Z"
        }
      ]
    }
  ],
  "pagination": {
    "after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
    "before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
    "totalResultSize": 10
  }
}