Skip to main content
POST
List canned responses
Required scopes: ,

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
group_ids
integer[]

The group IDs to filter by. If omitted, the API uses groups you have access to.

include_private
boolean
default:false

If set to true: includes private canned responses.

include_all_private
boolean
default:false

If set to true: includes all private canned responses. Requires the canned_responses--all:ro scope.

limit
integer
default:100

The number of results per page.

Required range: 1 <= x <= 100000
page_id
string

The page ID for pagination.

Response

200 - application/json

A paginated list of canned responses.

canned_responses
object[]

An array of canned response objects.

found_canned_responses
integer

The total number of canned responses found.

next_page_id
string

The page ID for the next page, if it exists.