cURL
curl --request GET \ --url https://api.botpress.cloud/v1/chat/states/{type}/{id}/{name}
{ "state": { "id": "<string>", "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z", "botId": "<string>", "conversationId": "<string>", "userId": "<string>", "name": "<string>", "type": "conversation", "payload": {} }, "meta": { "cached": true } }
Retrieves the State object for a valid identifiers.
State type
conversation
user
bot
integration
task
workflow
State id
State name
Returns the State object if a valid identifiers were provided. Returns an error otherwise
The response is of type object.
object
Was this page helpful?