Skip to main content
GET
/
seat-balances
List Seat balances by Customer
curl --request GET \
  --url https://dev.seqhq.io/api/seat-balances \
  --header 'Authorization: <authorization>'
{
  "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
  }
}

Headers

​
Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

​
Sequence-Version
enum<string>

Use this header to select an API version

Available options:
2024-07-30

Query Parameters

​
excludeZeroQuantity
boolean

Exclude customers with no seats usage. Defaults to false.

​
customerAliases
string

Filter seat balances by customer alias

​
customerIds
string

Filter seat balances by customer IDs. Max 100 IDs.

Response

OK

​
items
object[]
required

Seat balances

Example:
[
  {
    "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
object
required

Results pagination

Example:
{
  "after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
  "before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
  "totalResultSize": 10
}