Faqs / List
Lists FAQs with pagination. Filter by status, cluster_id and/or cluster_label_id. Pass include_conflicts=true to include each FAQ's conflicting counterpart inline.
Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/faqs
Method: GET
Authorisation: Minimum role: USER
Response object
Response status: 200 (OK)
Response type: DTO_faq[]
Wrapper: DTO_response_wrap_get_many
Other response statuses: 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_faq_filter
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| status | faq_status (nullable) | Status | |
| cluster_id | Int32 (nullable) | Filter by the cluster that generated these FAQs (local/decoupled int ID) | |
| cluster_label_id | Int32 (nullable) | Filter by cluster label (local/decoupled int ID) | |
| include_conflicts | Boolean | When true, each FAQ with a conflict will include the conflicting FAQ data in the response | |
| only_conflicts | Boolean | When true, only return FAQs that have at least one conflict | |
| search | String | Search | |
| sort_order | ENUM sort_order | Sort order | |
| take | Int32 | Take | |
| page | Int32 | Page |
DTO_faq
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| cluster | DTO_reference | Cluster | |
| cluster_label | DTO_reference | Cluster label | |
| conflicting_faq_ids | Int32[] | Conflicting faq ids | |
| conflicting_faqs | DTO_faq[] | Conflicting faqs | |
| id | Int32 | Id | |
| status | ENUM faq_status | Status | |
| question | String | Question | |
| answer | String | Answer | |
| embeddings_status_enum_id | Int32 | Embeddings status enum id |
DTO_reference
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| id | Int32 | The id of the reference | |
| label | Object | ReadOnly | Name/Label from referenced object. |
DTO_faq
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| cluster | DTO_reference | Cluster | |
| cluster_label | DTO_reference | Cluster label | |
| conflicting_faq_ids | Int32[] | Conflicting faq ids | |
| conflicting_faqs | DTO_faq[] | Conflicting faqs | |
| id | Int32 | Id | |
| status | ENUM faq_status | Status | |
| question | String | Question | |
| answer | String | Answer | |
| embeddings_status_enum_id | Int32 | Embeddings status enum id |
ENUM faq_status
| Value | Name | Description |
|---|---|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | SUGGESTED | SUGGESTED |
| 11 | MANUALLY_CREATED | MANUALLY_CREATED |
| 21 | APPROVED_AS_IS | APPROVED_AS_IS |
| 22 | APPROVED_WITH_EDITS | APPROVED_WITH_EDITS |
| 31 | DECLINED | DECLINED |
| 32 | DUPLICATED_IGNORE | DUPLICATED_IGNORE |
| 41 | REMOVED | REMOVED |
ENUM sort_order
| Value | Name | Description |
|---|---|---|
| 0 | ASC | ASC |
| 1 | DESC | DESC |
