curl --request POST \
--url https://app.textql.com/v1/playbooks/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"memberOnly": true,
"limit": 50,
"offset": 1,
"searchTerm": "<string>",
"statusFilter": "STATUS_UNKNOWN",
"creatorMemberId": "<string>",
"sortBy": "SORT_FIELD_UNKNOWN",
"sortDirection": "SORT_DIRECTION_UNKNOWN",
"subscribedFirst": true
}
'{
"playbooks": [
{
"id": "<string>",
"orgId": "<string>",
"memberId": "<string>",
"connectorId": 123,
"name": "<string>",
"prompt": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"status": "STATUS_UNKNOWN",
"triggerType": "TRIGGER_TYPE_UNKNOWN",
"cronString": "<string>",
"datasetIds": [
"<string>"
],
"referenceReportId": "<string>",
"latestChatId": "<string>",
"emailAddresses": [
"<string>"
],
"slackChannelId": "<string>",
"taggedSlackUserIds": [
"<string>"
],
"llmModel": "MODEL_UNKNOWN",
"paradigmOptions": {
"basic": {}
},
"paradigmType": "TYPE_UNKNOWN",
"isRunning": true,
"owner": {
"memberId": "<string>",
"memberEmail": "<string>",
"memberName": "<string>",
"memberPictureUrl": "<string>"
},
"hasWritePermission": true,
"isSubscribed": true,
"reportOutputStyle": "REPORT_STYLE_UNKNOWN",
"templateHeaderId": "<string>",
"selectedTemplateDataIds": [
"<string>"
],
"maxConcurrentTemplates": 123,
"autoOptimizeConcurrency": true,
"connectorIds": [
123
]
}
],
"totalCount": 123
}Get all playbooks
curl --request POST \
--url https://app.textql.com/v1/playbooks/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"memberOnly": true,
"limit": 50,
"offset": 1,
"searchTerm": "<string>",
"statusFilter": "STATUS_UNKNOWN",
"creatorMemberId": "<string>",
"sortBy": "SORT_FIELD_UNKNOWN",
"sortDirection": "SORT_DIRECTION_UNKNOWN",
"subscribedFirst": true
}
'{
"playbooks": [
{
"id": "<string>",
"orgId": "<string>",
"memberId": "<string>",
"connectorId": 123,
"name": "<string>",
"prompt": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"status": "STATUS_UNKNOWN",
"triggerType": "TRIGGER_TYPE_UNKNOWN",
"cronString": "<string>",
"datasetIds": [
"<string>"
],
"referenceReportId": "<string>",
"latestChatId": "<string>",
"emailAddresses": [
"<string>"
],
"slackChannelId": "<string>",
"taggedSlackUserIds": [
"<string>"
],
"llmModel": "MODEL_UNKNOWN",
"paradigmOptions": {
"basic": {}
},
"paradigmType": "TYPE_UNKNOWN",
"isRunning": true,
"owner": {
"memberId": "<string>",
"memberEmail": "<string>",
"memberName": "<string>",
"memberPictureUrl": "<string>"
},
"hasWritePermission": true,
"isSubscribed": true,
"reportOutputStyle": "REPORT_STYLE_UNKNOWN",
"templateHeaderId": "<string>",
"selectedTemplateDataIds": [
"<string>"
],
"maxConcurrentTemplates": 123,
"autoOptimizeConcurrency": true,
"connectorIds": [
123
]
}
],
"totalCount": 123
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
0 <= x <= 100x >= 0STATUS_UNKNOWN, STATUS_ACTIVE, STATUS_INACTIVE, STATUS_EMPTY SORT_FIELD_UNKNOWN, SORT_FIELD_NAME, SORT_FIELD_CREATED_AT, SORT_FIELD_UPDATED_AT SORT_DIRECTION_UNKNOWN, SORT_DIRECTION_ASC, SORT_DIRECTION_DESC Success
Show child attributes
UUID
Deprecated: use connector_ids instead
RFC 3339 timestamp format (e.g., "2024-12-25T12:00:00Z")
RFC 3339 timestamp format (e.g., "2024-12-25T12:00:00Z")
STATUS_UNKNOWN, STATUS_ACTIVE, STATUS_INACTIVE, STATUS_EMPTY TRIGGER_TYPE_UNKNOWN, TRIGGER_TYPE_CRON, TRIGGER_TYPE_WEBHOOK List of UUIDs
MODEL_UNKNOWN, MODEL_DEFAULT_SMALL, MODEL_DEFAULT, MODEL_DEFAULT_LARGE, MODEL_DEFAULT_REASONING, MODEL_HAIKU_3, MODEL_HAIKU_3_5, MODEL_SONNET_3_5, MODEL_SONNET_3_6, MODEL_SONNET_3_7, MODEL_SONNET_4, MODEL_OPUS_4, MODEL_SONNET_4_5, MODEL_HAIKU_4_5, MODEL_GPT_4, MODEL_GPT_4_TURBO, MODEL_GPT_4O, MODEL_GPT_4_1, MODEL_GPT_4_1_MINI, MODEL_GPT_4_1_NANO, MODEL_O_1, MODEL_O_1_MINI, MODEL_O_3, MODEL_O_3_MINI, MODEL_O_4_MINI, MODEL_GPT_5, MODEL_KIMI_K2_INSTRUCT, MODEL_QWEN3_CODER, MODEL_QWEN3_CODER_SMALL, MODEL_GPT_OSS, MODEL_GPT_OSS_SMALL, MODEL_GLM_4_5, MODEL_GLM_4_6, MODEL_KIMI_K2_THINKING Show child attributes
This is a placeholder for future basic options. Currently, it does not contain any fields.
TYPE_UNKNOWN, TYPE_SQL, TYPE_RESEARCH, TYPE_ONTOLOGY, TYPE_BASIC, TYPE_TABLEAU, TYPE_EXPERIMENTAL, TYPE_UNIVERSAL Show child attributes
Report output length
REPORT_STYLE_UNKNOWN, EXECUTIVE_REPORT, VERBOSE, CONCISE UUID reference to PlaybookTemplateHeader
List of UUIDs for selected template data rows
Maximum number of templates to run concurrently
Auto-optimize concurrency based on runtime