GET
/
v1
/
chat
/
states
/
{type}
/
{id}
/
{name}
cURL
curl --request GET \
  --url https://api.botpress.cloud/v1/chat/states/{type}/{id}/{name} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-bot-id: <api-key>'
{
  "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
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

​
x-bot-id
string
header
required

Your bot ID.

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 object if a valid identifiers were provided. Returns an error otherwise

The response is of type object.