Developers
FAQs

List FAQ entries

GET/support/faqs

Lists the FAQ entries of the current account. The collection can be filtered by group and status.

Entries are sorted by group name, with ungrouped entries last, and then by position within each group. All matching entries are returned in a single response.

Collection items do not include the answer. Use the retrieve operation to obtain it.

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

group?string
status?string

Value in

  • "draft"
  • "published"

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

curl -X GET "https://example.com/support/faqs"
{  "data": [    {      "answer": {        "blocks": [          {}        ]      },      "created_at": "2019-08-24T14:15:22Z",      "group": "string",      "id": "string",      "object": "faq",      "position": 0,      "question": "string",      "revision": "string",      "status": "draft",      "updated_at": "2019-08-24T14:15:22Z"    }  ]}

FAQs

FAQs in API v3: list faq entries, create an faq entry, reorder faq entries, retrieve an faq entry, update an faq entry, delete an faq entry.

Create an FAQ entry POST

Creates an FAQ entry with a question and its answer. Entries are created as drafts unless `status` is set to `published`. Creating a published entry also requires the `faqs.publish` permission. Groups are labels: a group exists as soon as an entry is assigned to it, so there is no separate operation to create one.