getUser

Retrieves the User object for a valid identifier.

GET/users/me

Header parameters

x-user-keystringrequired

Authentication Key

Response

application/json

Returns a User object if a valid identifier was provided

The response is of type getUserResponse · object.

userobjectrequired

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://chat.botpress.cloud/your_default_webhook_url/users/me \
  --header 'x-user-key: <x-user-key>' \
  --header 'Authorization: Bearer <token>'

Response

{
  "user": {
    "id": "string",
    "name": "string",
    "pictureUrl": "string",
    "profile": "string",
    "createdAt": "2025-01-15T12:00:00Z",
    "updatedAt": "2025-01-15T12:00:00Z"
  }
}