Get all Workflow Responses

GET

/api/v2/workflows/{workflow_id}/responses

Handle GET requests to retrieve all workflow responses by workflow ID.

Path Parameters:

workflow_id (int): The ID of the workflow whose responses to retrieve.

Query Parameters:

voted: To filter responses based on "upvote" or "downvote".

query: To filter responses based on some query/search words.

query_source: Filter by source(s) using OR condition (e.g., "?query_source=web&query_source=mobile").

items_per_page (int): Number of items per page (default: 50)

page (int): Page number (default: 1)

Request Headers:

X-Authorization-Consistency-Token (string, optional): Authorization consistency token for read-after-write consistency. Pass the token received from a previous write operation to ensure this read reflects that write.

Returns:

A JSON response containing paginated workflow responses or an error message.

Current Version:

2.0.0

Request

Path Params

Query Params

Header Params

Responses

🟢200OK

application/json

Workflow responses fetched successfully

Bodyapplication/json

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/workflows//responses?items_per_page=&page=&query=&query_source=&voted=' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "property1": "string",
        "property2": "string"
    }
}

Create a Workflow Chat Thread

Create a Workflow Chat Response