List canned responses
Every canned response on the account, paginated. Add search to filter, sort to order.
Authorizations
The id_token from POST /auth/v1/signin, sent as Authorization: Bearer <id_token>. Not the access_token — that one does not carry the identity Cloud Chat authorizes on.
Headers
Your Cloud Chat instance ID — an integer, fixed for your company, told at onboarding. The API overview explains how instances work, how to find yours, and the errors a wrong or missing value produces.
1
Path Parameters
Your Cloud Chat account. It has to be an account your token grants membership on, and it has to live on the instance in the cloudchat-instance header — the two travel together. Account numbers are only unique within an instance, so the same number is a different company on another instance. Usually a mismatched pair fails closed with a 401, because your user does not exist on the other instance — but if your identity happens to exist on both, the call succeeds against the other company's data, silently. Read it and you are looking at the wrong help center; write it and you have stored into the wrong account. Send the two values that were given to you together, and never try a number to see what answers.
1
Query Parameters
Case-insensitive substring match against both short_code and content. A response matches if either field contains it. % and _ are matched literally, not as wildcards.
With search and no explicit sort, results come back by relevance: a short code that starts with the term first, then a short code that contains it, then a match in the content only. Sending sort alongside search overrides that.
"refund"
1-based page number. Anything below 1 — including a non-numeric value — is read as 1.
x >= 11
Results per page. Clamped, never rejected: above 100 you get 100, below 1 you get the default 25.
1 <= x <= 10025
Ordering. An unrecognized value is not an error — it falls back to short_code_asc.
short_code_asc, short_code_desc, newest, oldest