List submissions

4 parameters

limitintegeroptional

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

Default:20

offsetintegeroptional

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

Default:0

statusstringoptional

Filter submissions by status: backlog, open, planned, in_progress, or done.

Allowed:backlogopenplannedin_progressdone

typestringoptional

Filter submissions by type: bug or feature.

Allowed:bugfeature

2 status codes

200Returns a paginated response containing a `data` array of submissions and pagination metadata.

dataarray<object>optional

paginationobjectoptional

401Returned when the request is not authenticated.

errorobjectoptional

Error handling

A 401 is returned when the request is not authenticated. limit must be between 1 and 100, offset must be 0 or greater, status must be one of backlog, open, planned, in_progress, or done, and type must be bug or feature.

import { Client } from "supdesk-sdk";

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

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

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

Request

Response

Errors