Developers
Questions10

Retrieve a question

GET/products/{product_id}/questions/{question_id}

Retrieves a question by its public ID.

The response includes an ETag representing the current revision. Send this value in the If-Match header when updating the question to avoid overwriting a newer version.

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

product_id*string

Public ID of the product, prefixed with prd_.

question_id*string

Public ID of the question, prefixed with qst_.

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

curl -X GET "https://example.com/products/string/questions/string"
{  "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"    }  }}

List questions for a product GET

Returns the questions users have asked in the lessons of a product. Results are paginated with a cursor and can be filtered by lesson, user, answered state, and search text. The `has_draft` field is included only when the credentials also have the `questions.read_private` permission.

Update a question PATCH

Reopens a question or changes whether it is pinned. The question text belongs to the user and cannot be changed. Setting `status` to `open` returns the question to the queue of questions awaiting a reply and requires the `questions.reopen` permission. Any published reply remains visible. Changing `pinned` requires the `questions.pin` permission. Send the `ETag` returned by the retrieve operation in the `If-Match` header to avoid overwriting a newer version.