List beta programs

3 parameters

limitintegeroptional

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

Default:20

offsetintegeroptional

Number of beta programs to skip; must be 0 or greater. Defaults to 0 when omitted.

Default:0

statusstringoptional

Filter beta programs by status: draft, active, or closed.

Allowed:draftactiveclosed

2 status codes

200Returns a paginated list of beta program objects in `data`, with pagination details including the limit, offset, and whether more results are available.

dataarray<object>optional

paginationobjectoptional

401Returned when authentication is missing or invalid.

errorobjectoptional

Error handling

A 401 is returned when authentication is missing or invalid. limit must be between 1 and 100, offset must be 0 or greater, and status must be draft, active, or closed.

import { Client } from "supdesk-sdk";

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

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

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

Request

Response

Errors