GET
/
v1
/
chat
/
states
/
{type}
/
{id}
/
{name}
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
  }
}

Path Parameters

​
type
enum<string>
required

State type

Available options:
conversation,
user,
bot,
integration,
task,
workflow
​
id
string
required

State id

​
name
string
required

State name

Response

200
application/json
Returns the [State](#schema_state) object if a valid identifiers were provided. Returns [an error](#errors) otherwise
​
state
object
required

The state object represents the current payload. A state is always linked to either a bot, a conversation or a user.

​
meta
object
required

Was this page helpful?

Suggest editsRaise issue