Describe the calling API key

Return metadata about the API key authenticating this request, including its scopes. The plaintext secret is never returned.

GET /api_keys/whoami

Describe the calling API key

cURL

curl --request GET \
  --url https://api.bridge.xyz/v0/api_keys/whoami \
  --header 'Api-Key: <api-key>'

import requests

url = "https://api.bridge.xyz/v0/api_keys/whoami"

headers = {"Api-Key": "<api-key>"}

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

print(response.text)

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

fetch('https://api.bridge.xyz/v0/api_keys/whoami', 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.bridge.xyz/v0/api_keys/whoami",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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.bridge.xyz/v0/api_keys/whoami"

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

	req.Header.Add("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.bridge.xyz/v0/api_keys/whoami")
  .header("Api-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bridge.xyz/v0/api_keys/whoami")

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

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

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

200

SuccessfulWhoAmIResponse

{
  "id": "5f1f5b3a-8c2b-4e5f-9d88-e0b2a7d3a1e8",
  "type": "Private",
  "owner_type": "Developer",
  "owner_id": "e802b3a4-f453-4da8-8a5b-dd50cede1e4f",
  "prefix": "sk-live",
  "last_4": "9f2c",
  "state": "Active",
  "created_at": "2026-04-22T15:04:05Z",
  "updated_at": "2026-04-22T15:04:05Z",
  "name": "Customer service key",
  "scopes": [
    "customer:read",
    "customer:create"
  ]
}

Authorizations

Api-Key · string · header · required

Response

200

application/json

Metadata describing the calling API key.

id · string<uuid> · required

The unique identifier for this API key.

type · enum<string> · required

Whether the key was created programmatically (Private) or via the Dashboard (Public).

Available options: Public, Private

owner_type · enum<string> · required

The type of entity that owns the key. Always Developer.

Available options: Developer

owner_id · string<uuid> · required

The developer ID that owns the key.

prefix · enum<string> · required

The environment prefix of the key. sk-live in production, sk-test in sandbox.

Available options: sk-live, sk-test

last_4 · string · required

The last four characters of the key, shown alongside the prefix for disambiguation in audit logs.

state · enum<string> · required

Lifecycle state of the key.

Available options: Active, Deleted

created_at · string<date-time> · required

updated_at · string<date-time> · required

scopes · string[] · required

The scopes authorized on this key. A single-element list containing bridge:api_unrestricted denotes an unrestricted key (all standard scopes). Any other list denotes a scoped key.

name · string

The human-readable label for this key, if one was provided at creation.

Maximum string length: 100