Skip to main content
GET
List membership seats
This endpoint is in beta: its request and response contract can still change while it’s being developed.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page[size]
number | null

How many results to return per page, from 1 to 500. Defaults to 100.

Required range: 1 <= x <= 500
Example:

100

page[after]
string | null

Pass page.next from the previous response to get the next page.

page[before]
string | null

Pass page.prev from the previous response to get the previous page.

sort[updatedAt]
enum<string> | null

Sort by update date. 1 for ascending, -1 for descending.

Available options:
1,
-1,
null
Example:

"1"

sort[createdAt]
enum<string> | null

Sort by creation date. 1 for ascending, -1 for descending.

Available options:
1,
-1,
null
Example:

"1"

createdAt[after]
string<date-time> | null

Only return entries created after this date.

Example:

"2020-01-01T20:15:00.000Z"

createdAt[before]
string<date-time> | null

Only return entries created before this date.

Example:

"2020-01-01T20:15:00.000Z"

updatedAt[after]
string<date-time> | null

Only return entries updated after this date.

Example:

"2020-01-01T20:15:00.000Z"

updatedAt[before]
string<date-time> | null

Only return entries updated before this date.

Example:

"2020-01-01T20:15:00.000Z"

emailAddress
string<email>

Find one member's seats by the address they are held under. Send this or list, not both.

Maximum string length: 320
list
enum<string>

Send all to list every seat, on every page. Send this or emailAddress, not both.

Available options:
all

Response

A page of seats, or every seat held under the email address.

data
MembershipSeat · object[]
required
page
PageCursor · object
required

Where you are in a paginated list.

Pass next as page[after] to get the next page, or prev as page[before] to get the previous one. An empty cursor means there are no more pages in that direction. Treat cursors as opaque strings.

Example: