GET/conversations/{conversation_id}/variables

List Conversation Variables

Available for: Chatflow, Chatbot, Legacy Agent apps.

Lists the variables stored in a conversation.

5 parameters
conversation_idstringrequired
ID of the conversation whose variables to list. Get conversation IDs from [List Conversations](/en/api-reference/conversations/list-conversations).
userstringoptional
End-user identifier, defined by your app and unique within it. See [End User Identity](/en/api-reference/guides/end-user-identity).
last_idstringoptional
Pagination cursor: the `id` of the last variable on the current page. Omit to fetch the first page.
limitintegeroptional
Number of records to return.
Default:20
variable_namestringoptional
Filter variables by a specific name.

3 status codes
200Successfully retrieved conversation variables.
dataarray<object>optional
List of conversation variables.
has_morebooleanoptional
Whether there is a next page.
limitintegeroptional
Number of items per page.
400- `not_chat_app` : App mode does not match the API route. - `invalid_param` : The `last_id` does not match any variable in this conversation.

2 documented failures

  • invalid_param

    invalid_param

  • not_chat_app

    Please check if your app mode matches the right API route.

    not_chat_app

404`not_found` : Conversation does not exist.

One documented failure

  • not_found

    Conversation Not Exists.

    not_found

Error handling

A 400 is returned: - not_chat_app : App mode does not match the API route.

  • invalid_param : The last_id does not match any variable in this conversation. A 404 is returned: not_found : Conversation does not exist.