Skip to content
Convor
Convor Docs
API ReferenceCanned Responses

List canned responses resolved for a locale

Returns a paginated list of canned responses resolved for the requested locale.

GET/api/canned-responses

Returns a paginated list of canned responses resolved for the requested locale. Filter by category, text, shortcut, active state, or locale, then paginate with either page or offset. Missing translations follow the documented locale fallback rules.

Endpoint requirements

Credentials
Use either Bearer API key or X-API-Key header.
Required scope
canned-responses:read
Module
Automation & API module (api_access)
Organization and site scope
Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
Retry behavior
Safe read: You can safely retry this read-only request after a transport failure. It does not change resource state.

Query Parameters

limit?integer

Maximum number of resources to return.

Range1 <= value <= 100
Default20
page?integer

One-based page number.

Range1 <= value <= 9007199254740991
offset?integer

Zero-based number of resources to skip.

Range0 <= value <= 9007199254740991
Default0
locale?string

Query parameter. BCP 47 locale or language tag used for localized content.

Length1 <= length <= 35
categoryId?string

Query parameter. Unique identifier of the related category.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
search?string

Query parameter. Search text.

Lengthlength <= 500
shortcut?string

Query parameter. Shortcut used to insert this content.

Lengthlength <= 50
includeInactive?boolean

Query parameter. Whether to include inactive.

Defaultfalse
activity?string

Query parameter. Activity. Allowed values: all, active, inactive.

Value in

  • "all"
  • "active"
  • "inactive"

Header Parameters

X-Project-Id?|

DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

{  "data": [    {      "id": "998ea84d-22c1-43aa-bfd5-9e110cb36c01",      "orgId": "8ea0b557-d794-41ce-b86e-44f4780da2b5",      "key": "refund-approved",      "categoryId": "b8ec53aa-0ca2-49bb-b8f6-7458ab50260c",      "category": "Billing",      "locale": "en",      "title": "Refund approved",      "content": "Your refund has been approved and will be processed shortly.",      "shortcut": "/refund-approved",      "fallbackUsed": false,      "active": true,      "tags": [        "billing",        "refund"      ],      "usageCount": 0,      "lastUsedAt": null,      "sortOrder": 10,      "projectScope": "all",      "projectIds": [        "11111111-1111-4111-8111-111111111111"      ],      "translations": [        {          "id": "7ff62fc6-c0ac-49e9-8419-f68b6d845aa0",          "locale": "en",          "status": "published",          "sourceLocale": null,          "machineTranslatedAt": null,          "reviewedAt": null,          "reviewedBy": null,          "title": "Refund approved",          "content": "Your refund has been approved and will be processed shortly.",          "createdAt": "2026-08-03T18:00:00.000Z",          "updatedAt": "2026-08-03T18:00:00.000Z"        }      ],      "shortcuts": [        {          "id": "b58be6ea-6f19-409e-a9a6-985c5c399ee0",          "locale": "en",          "shortcut": "/refund-approved",          "createdAt": "2026-08-03T18:00:00.000Z",          "updatedAt": "2026-08-03T18:00:00.000Z"        }      ],      "createdAt": "2026-08-03T18:00:00.000Z",      "updatedAt": "2026-08-03T18:00:00.000Z"    }  ],  "pagination": {    "totalItems": 1,    "page": 1,    "pageSize": 20,    "hasNextPage": false,    "hasPrevPage": false  }}

Request examples

curl

curl --request GET \
  'https://api.convor.io/api/canned-responses' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...'

JavaScript

const response = await fetch("https://api.convor.io/api/canned-responses", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer convor_sk_..."
  },
});

const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
  ? null
  : contentType.includes("json")
    ? await response.json()
    : contentType.startsWith("text/")
      ? await response.text()
      : await response.blob();

if (!response.ok) {
  const message = typeof data === "object" && data !== null
    && "error" in data && typeof data.error === "object"
    && data.error !== null && "message" in data.error
      ? String(data.error.message)
      : "Convor API request failed (" + response.status + ")";
  throw new Error(message);
}

console.log(data);

Was this page helpful?

Delete a canned response category

Permanently deletes a canned-response category.

List localized canned response categories

Returns every canned-response category in the authenticated organization, resolved for the requested locale and ordered by sort position.

On this page

Request examplescurlJavaScript