| Resource URL | /v1/question-list/all/ |
|---|
| Response Format | JSON |
| Requires Authentication | Yes |
| Rate Limited | No |
| HTTPS | Yes |
Retrieve all question lists without pagination.
curl -X 'GET' \
'https://braegen.ai/v1/question-list/all/' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>'
{
"description": "Successful Response"
}
| HTTP Code | Message |
|---|
| 200 | Successful Response |
Get Question Lists Filtered Endpoint GET /v1/question-list/all_filtered/
| Resource URL | /v1/question-list/all_filtered/ |
|---|
| Response Format | JSON |
| Requires Authentication | Yes |
| Rate Limited | No |
| HTTPS | Yes |
Get question lists with optional filters and search.
| Parameter | Description | Required | Type | Default Value |
|---|
| page | Page number | No | Integer | 1 |
| page_size | Number of items per page | No | Integer | 10 |
| type | Filter by question type | No | String | N/A |
| status | Filter by status (active/inactive) | No | String | N/A |
| created_user | Filter by created user | No | String | N/A |
| search_query | Text to search in list name | No | String | N/A |
curl -X 'GET' \
'https://braegen.ai/v1/question-list/all_filtered/?page=1&page_size=10&status=active' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>'
{
"description": "Successful Response"
}
| HTTP Code | Message |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
Get By Id Endpoint GET /v1/question-list/{question_list_id}
| Resource URL | /v1/question-list/{question_list_id} |
|---|
| Response Format | JSON |
| Requires Authentication | Yes |
| Rate Limited | No |
| HTTPS | Yes |
Retrieve a question list by its ID.
| Parameter | Description | Required | Type | Default Value |
|---|
| question_list_id | Question list ID | Yes | Integer | N/A |
curl -X 'GET' \
'https://braegen.ai/v1/question-list/1' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>'
{
"description": "Successful Response"
}
| HTTP Code | Message |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
Update Endpoint PUT /v1/question-list/{question_list_id}
| Resource URL | /v1/question-list/{question_list_id} |
|---|
| Response Format | JSON |
| Requires Authentication | Yes |
| Rate Limited | No |
| HTTPS | Yes |
Update an existing question list by its ID. Status is an enum with values: active and inactive.
| Parameter | Description | Required | Type | Default Value |
|---|
| question_list_id | Question list ID | Yes | Integer | N/A |
| Parameter | Description | Required | Type | Default Value |
|---|
| question_list_name | Question list name | No | String | null |
| type | Question list type | No | String | null |
| question_list_description | Description | No | String | null |
| updated_user | User who updated it | No | String | null |
| client_id | Client ID | No | String | null |
| status | Status (active/inactive) | No | String | active |
curl -X 'PUT' \
'https://braegen.ai/v1/question-list/1' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
"question_list_name": "Updated List",
"status": "active"
}'
{
"description": "Successful Response"
}
| HTTP Code | Message |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
Create Endpoint POST /v1/question-list/
| Resource URL | /v1/question-list/ |
|---|
| Response Format | JSON |
| Requires Authentication | Yes |
| Rate Limited | No |
| HTTPS | Yes |
Create a new question list. Status is an enum with values: active and inactive.
| Parameter | Description | Required | Type | Default Value |
|---|
| question_list_name | Question list name | No | String | null |
| type | Question list type | No | String | null |
| question_list_description | Description | No | String | null |
| created_user | User who created it | No | String | null |
| client_id | Client ID | No | String | null |
| status | Status (active/inactive) | No | String | active |
curl -X 'POST' \
'https://braegen.ai/v1/question-list/' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
"question_list_name": "Sample List",
"status": "active"
}'
{
"description": "Successful Response"
}
| HTTP Code | Message |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
Delete Endpoint DELETE /v1/question-list/multiple/
| Resource URL | /v1/question-list/multiple/ |
|---|
| Response Format | JSON |
| Requires Authentication | Yes |
| Rate Limited | No |
| HTTPS | Yes |
Delete multiple question lists by their IDs.
| Parameter | Description | Required | Type | Default Value |
|---|
| user_id | User ID | No | String | N/A |
| Parameter | Description | Required | Type | Default Value |
|---|
| ids | List of question list IDs | Yes | Array | N/A |
curl -X 'DELETE' \
'https://braegen.ai/v1/question-list/multiple/?user_id=user_123' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '[1, 2, 3]'
{
"description": "Successful Response"
}
| HTTP Code | Message |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
