Search help center articles

2 parameters

qstringrequired

The search query used to find help center articles.

limitintegeroptional

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

Default:20

2 status codes

200Returns an array of matching article objects in the `data` field.

dataarray<object>optional

401Returned when the request lacks valid authentication credentials.

errorobjectoptional

Error handling

A 401 is returned when the request lacks valid authentication credentials. The q query parameter is required, and limit must be between 1 and 100 when provided.

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

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

const result = await client.search.list({
  q: "keyword",
  limit: 20,
});

{
  "data": [
    {}
  ]
}

Request

Response

Errors