getUser

Retrieves the User object for a valid identifier.

GET/v1/chat/users/{id}

Authorization

AuthorizationBearer

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

Header parameters

x-bp-authenticated-principalstring

Authenticated principal. Injected by the authentication middleware.

x-bot-idstring

Bot id

x-integration-id?string

Integration id

x-integration-alias?string

Integration alias

Path parameters

idstring

User ID

Response

Returns a User object if a valid identifier was provided. Returns an Error otherwise

userobject

The user object represents someone interacting with the bot within a specific integration. The same person interacting with a bot in slack and messenger will be represented with two different users.

Request

curl --request GET \ \
  --url https://api.botpress.cloud/v1/chat/users/{id} \
  --header 'x-bp-authenticated-principal: <x-bp-authenticated-principal>' \
  --header 'x-bot-id: <x-bot-id>' \
  --header 'Authorization: Bearer <token>'

Response

{
  "user": {
    "id": "string",
    "createdAt": "2025-01-15T12:00:00Z",
    "updatedAt": "2025-01-15T12:00:00Z",
    "tags": {
      "key": "string"
    },
    "name": "string",
    "pictureUrl": "string",
    "properties": {
      "key": "string"
    },
    "attributes": {
      "key": "string"
    }
  }
}