GET

List Questions


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves up to 100 question entries, given the provided filtering, paging, and sorting. Use the fieldSet parameter to set whether sharing links are included in the response.

Permissions
Manage FAQ
Read FAQ
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/faq/v1/question-entries

Query Params
categoryIdstring

Category ID.


questionIdsArray <string>

List of question IDs.


questionLabelstring

Question label.


paging.limitintegerminimum 0maximum 100format int32

Number of items to load.


paging.cursorstring

Pointer to the next or previous page in the list of results.

You can get the relevant cursor token from the pagingMetadata object in the previous call's response. Not relevant for the first request.


contentFormatstring

Text output format.


fieldSetArray <string>
Response Object
questionsArray <QuestionEntry>

List of question entries.


pagingMetadataPagingMetadata

Metadata for the paginated results.

Request
cURL
curl --request GET \ --url 'https://www.wixapis.com/faq/v1/questions?CategoryId="d2c57684-c957-4d3b-b555-1157b1684616' \ --header 'Authorization: <AUTH>' \ --header 'Content-Type: application/json'
Response
JSON
{ "questions": [ { "id": "c166ddb4-a9b4-444b-8ef0-5960d2ca1a1c", "question": "What is the question?", "answer": { "draftjs": "{text: \"This is the answer\"}" }, "labels": [ { "title": "testlabel", "sortOrder": 10 }, { "title": "differentlabel", "sortOrder": 10 } ], "sortOrder": 10, "status": "VISIBLE", "category_id": "d2c57684-c957-4d3b-b555-1157b1684616", "slug": "what-is-the-question", "share_link": null } ], "paging_metadata": { "count": 1, "offset": null, "total": null, "too_many_to_count": null, "cursors": null } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?