Retrieve a user

GET /admin/users/{userId}

Get user

cURL

curl --request GET \
  --url https://api.portkey.ai/v1/admin/users/{userId} \
  --header 'x-portkey-api-key: <api-key>'

import requests

url = "https://api.portkey.ai/v1/admin/users/{userId}"

headers = {"x-portkey-api-key": "<api-key>"}

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

print(response.text)

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

fetch('https://api.portkey.ai/v1/admin/users/{userId}', 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://api.portkey.ai/v1/admin/users/{userId}",
  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-portkey-api-key: <api-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://api.portkey.ai/v1/admin/users/{userId}"

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

	req.Header.Add("x-portkey-api-key", "<api-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://api.portkey.ai/v1/admin/users/{userId}")
  .header("x-portkey-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.portkey.ai/v1/admin/users/{userId}")

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

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

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

200

{
  "object": "user",
  "id": "61e08f60-4822-465e-ba23-39f85cd741cb",
  "first_name": "horace",
  "last_name": "slughorn",
  "role": "member",
  "email": "[e-mail]",
  "created_at": "2024-01-25 11:35:07",
  "last_updated_at": "2024-01-25 11:35:07",
  "workspace_ids": [
    "ws-shared-123"
  ]
}

Authorizations

x-portkey-api-key · string · header · required

Path Parameters

userId · string · required

Response

200 - application/json

OK

object · enum<string>

Available options: user

id · string<uuid>

first_name · string

last_name · string

role · enum<string>

Available options: admin, member, owner

email · string<email>

created_at · string<date-time>

last_updated_at · string<date-time>

workspace_ids · string[]