List waitlist signups

4 parameters

limitintegeroptional

Maximum number of signups to return, from 1 to 100. Defaults to 20 when omitted.

Default:20

offsetintegeroptional

Number of signups to skip. Must be zero or greater. Defaults to 0 when omitted.

Default:0

statusstringoptional

Filter signups by status: `waiting`, `invited`, or `joined`.

Allowed:waitinginvitedjoined

searchstringoptional

Search signups by email.

2 status codes

200Returns a paginated response containing an array of waitlist signups in `data` and pagination metadata, including `limit`, `offset`, and `has_more`.

dataarray<object>optional

paginationobjectoptional

401Returned when the request is unauthenticated.

errorobjectoptional

Error handling

A 401 is returned when the request is unauthenticated. limit must be between 1 and 100, and offset must be zero or greater. status must be waiting, invited, or joined when provided.

import { Client } from "supdesk-api-sdk";

const client = new Client({
  baseUrl: "https://api.supdesk.app",
});

const result = await client.signups.list({
  limit: 20,
  offset: 0,
  status: "example",
  search: "keyword",
});

{
  "data": [
    {}
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "has_more": true
  }
}

Request

Response

Errors