getUser

Retrieves the User object for a valid identifier.

GET /users/me

Get User

cURL

curl --request GET \
  --url https://chat.botpress.cloud/{webhookUrl}/users/me \
  --header 'x-user-key: <x-user-key>'

import requests

url = "https://chat.botpress.cloud/{webhookUrl}/users/me"

headers = {"x-user-key": "<x-user-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-user-key': '<x-user-key>'}};

fetch('https://chat.botpress.cloud/{webhookUrl}/users/me', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://chat.botpress.cloud/{webhookUrl}/users/me",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-user-key: <x-user-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://chat.botpress.cloud/{webhookUrl}/users/me"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-user-key", "<x-user-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://chat.botpress.cloud/{webhookUrl}/users/me")
  .header("x-user-key", "<x-user-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://chat.botpress.cloud/{webhookUrl}/users/me")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-user-key"] = '<x-user-key>'

response = http.request(request)
puts response.read_body

200

{
  "user": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "pictureUrl": "<string>",
    "profile": "<string>"
  }
}

{
  "user": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "pictureUrl": "<string>",
    "profile": "<string>"
  }
}

Headers

x-user-key · string · required

Authentication Key

Response

200

application/json

Returns a User object if a valid identifier was provided

user · object · required

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.

Show child attributes