v6

latestOpenAPI 3.1.02026-07-311856741.1 MB
customer_portal
seats
public

List Seats

Scopes: customer_portal:read customer_portal:write

get/v1/customer-portal/seats

Query parameters

subscription_idstring uuid4 nullable

Subscription ID

Subscription ID

order_idstring uuid4 nullable

Order ID

Order ID

Response

Successful Response

available_seatsinteger required

Number of available seats

total_seatsinteger required

Total number of seats for the subscription

Example response

{
  "seats": [
    {
      "member": {
        "email": "member@example.com",
        "name": "Jane Doe",
        "external_id": "usr_1337"
      }
    }
  ]
}