Developers
Questions10

List questions for a product

GET/products/{product_id}/questions

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.

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_.

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"
lesson_id?string

Only questions asked in the lesson with this public ID.

user_id?string

Only questions asked by the user with this public ID.

answered?string

When true, only answered questions; when false, only questions without an answer.

Value in

  • "true"
  • "false"
q?string

Text search term.

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

application/json

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

Questions10

Questions in API v3: list questions for a product, retrieve a question, update a question, delete a question, list replies to a question, create a reply, retrieve a reply, update a reply, delete a reply, list questions across all products.

Retrieve a question GET

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.