List membership seats

curl --request GET \
  --url https://api.letsdothis.com/v0/membership-seats \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.letsdothis.com/v0/membership-seats', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "<string>",
      "policyId": "<string>",
      "offeringId": "<string>",
      "memberType": "PRIMARY",
      "planType": "<string>",
      "tier": {
        "id": "<string>",
        "title": "<string>"
      },
      "plan": {
        "id": "<string>",
        "title": "<string>"
      },
      "status": "ACTIVE",
      "entitled": true,
      "emailAddress": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "expiresAt": "<string>",
      "renewalDate": "<string>"
    }
  ],
  "page": {
    "totalResults": 506,
    "first": "eyJpZCI6IjYzOTljMjAwMTVkNjBhZTNmZjI4ZjI0YyIsInVwZGF0ZWRBdCI6IjIwMjItMTItMTRUMTI6MzA6NTkuMjE3WiJ9",
    "last": "eyJpZCI6IjY1NGNkZDIxZDlhMTU3ODdiNzFkMTM0YSIsInVwZGF0ZWRBdCI6IjIwMjMtMTEtMTNUMTU6MTE6MTIuNzI0WiJ9",
    "prev": "",
    "next": "eyJpZCI6IjY0NzBkNTkwM2RjOWE5OWJhMTA0Y2ZhYiIsInVwZGF0ZWRBdCI6IjIwMjMtMTEtMTNUMTU6MTE6MTIuNjE4WiJ9"
  }
}

{
  "code": "MEMBERSHIP_RESOURCE_NOT_FOUND",
  "statusCode": 123,
  "message": "<string>",
  "reasons": [
    "<string>"
  ]
}

Memberships

List membership seats

Returns the membership seats of the organizer associated with your key. A seat is one person’s place on a membership policy: the primary member, or a secondary member on a plan that covers more than one person.

Send exactly one of these; a request with neither, or with both, is refused with 400:

list=all returns every seat, whatever its status, a page at a time.
emailAddress returns the primary and secondary seats held under that address, matched case-insensitively.

Listing every seat. Send list=all with every page, set page[size] up to 500, and pass page.next as page[after] until it comes back empty. Seats come in seat id order, or by sort[createdAt] or sort[updatedAt] (1 ascending, -1 descending, one at a time). A page cursor only works under the sort it came from. Removed seats aren’t listed.

Only what changed. createdAt[after], createdAt[before], updatedAt[after] and updatedAt[before] narrow the list. Bounds are exclusive, and a createdAt filter together with an updatedAt filter returns seats matching either.

Keeping status current. updatedAt moves when a seat’s details, tier or plan, holder or place on the policy change. status, entitled, expiresAt and renewalDate are worked out when you ask and don’t move it, so a membership that has since ended or frozen won’t show up in an updatedAt filter: read the whole list again to refresh them. Use entitled to decide whether a member has access.

The date filters and sorts work only with list=all, and are refused with emailAddress. Any other query parameter is refused with 400, so a misspelt one is never silently ignored.

GET

membership-seats

List membership seats

curl --request GET \
  --url https://api.letsdothis.com/v0/membership-seats \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.letsdothis.com/v0/membership-seats', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "<string>",
      "policyId": "<string>",
      "offeringId": "<string>",
      "memberType": "PRIMARY",
      "planType": "<string>",
      "tier": {
        "id": "<string>",
        "title": "<string>"
      },
      "plan": {
        "id": "<string>",
        "title": "<string>"
      },
      "status": "ACTIVE",
      "entitled": true,
      "emailAddress": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "expiresAt": "<string>",
      "renewalDate": "<string>"
    }
  ],
  "page": {
    "totalResults": 506,
    "first": "eyJpZCI6IjYzOTljMjAwMTVkNjBhZTNmZjI4ZjI0YyIsInVwZGF0ZWRBdCI6IjIwMjItMTItMTRUMTI6MzA6NTkuMjE3WiJ9",
    "last": "eyJpZCI6IjY1NGNkZDIxZDlhMTU3ODdiNzFkMTM0YSIsInVwZGF0ZWRBdCI6IjIwMjMtMTEtMTNUMTU6MTE6MTIuNzI0WiJ9",
    "prev": "",
    "next": "eyJpZCI6IjY0NzBkNTkwM2RjOWE5OWJhMTA0Y2ZhYiIsInVwZGF0ZWRBdCI6IjIwMjMtMTEtMTNUMTU6MTE6MTIuNjE4WiJ9"
  }
}

{
  "code": "MEMBERSHIP_RESOURCE_NOT_FOUND",
  "statusCode": 123,
  "message": "<string>",
  "reasons": [
    "<string>"
  ]
}

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

The number of entries to return per page. Range between 1 - 500, defaults to 100

Required range: 1 <= x <= 500

Example:

100

page[after]

string | null

Accepts an existing page cursor. For more details see the definition of PageCursor in the response.

page[before]

string | null

Accepts an existing page cursor. For more details see the definition of PageCursor in the response.

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

Default Response

data

MembershipSeat · object[]

required

Show child attributes

page

PageCursor · object

required

Cursor details for pagination.

In scenarios with large amounts of data, it's common to return only a subset of data in a single request, known as a "page".
Most API responses include two objects: a 'data' object with the query results, and a 'PageCursor' object detailing the current page.
Cursors can be used to navigate to earlier or later pages in the set of results. For instance, passing the 'next' cursor from 'PageCursor' fetches the next set of results.
Cursors are base64 encoded strings.

Show child attributes

Example:

{
  "totalResults": 506,
  "first": "eyJpZCI6IjYzOTljMjAwMTVkNjBhZTNmZjI4ZjI0YyIsInVwZGF0ZWRBdCI6IjIwMjItMTItMTRUMTI6MzA6NTkuMjE3WiJ9",
  "last": "eyJpZCI6IjY1NGNkZDIxZDlhMTU3ODdiNzFkMTM0YSIsInVwZGF0ZWRBdCI6IjIwMjMtMTEtMTNUMTU6MTE6MTIuNzI0WiJ9",
  "prev": "",
  "next": "eyJpZCI6IjY0NzBkNTkwM2RjOWE5OWJhMTA0Y2ZhYiIsInVwZGF0ZWRBdCI6IjIwMjMtMTEtMTNUMTU6MTE6MTIuNjE4WiJ9"
}

Get started

Endpoints

List membership seats

Authorizations

Query Parameters

Response