Developers
Questions10

List questions across all products

GET/support/questions

Returns the support queue of questions across all products in the account that are accessible with the current credentials. Results are paginated with a cursor.

By default, only questions awaiting a reply (status=open) are returned. Use status=answered to list answered questions instead.

This collection never includes reply drafts or the has_draft field, even when the credentials have the questions.read_private permission.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Query Parameters

limit?integer

Maximum number of items to return, from 1 to 200.

Range1 <= value <= 200
cursor?string

Cursor for the next page, taken from page.next_cursor of the previous response.

sort?string

Sort order. A leading - sorts in descending order.

Value in

  • "id"
  • "-id"
status?string

Only questions with this status.

Value in

  • "open"
  • "answered"

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/support/questions"
{  "data": [    {      "body": {        "blocks": [          {}        ]      },      "created_at": "2019-08-24T14:15:22Z",      "has_draft": true,      "id": "string",      "lesson_id": "string",      "object": "question",      "pinned": true,      "product_id": "string",      "replies_count": 0,      "revision": "string",      "status": "open",      "updated_at": "2019-08-24T14:15:22Z",      "user": {        "id": "string",        "name": "string"      }    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Delete a reply DELETE

Deletes a published support reply or discards the question's draft reply. To discard the draft, use the reply ID `qrp_draft_<question_id>`. Deleting a published reply removes it from the user's view, and the question returns to the `open` status when no other support reply remains. Only support replies can be deleted; replies written by users are rejected with `403`, the `permission_denied` error code, and `details[].field` set to `author.kind`.

Certificates8

Next Page