curl --request GET \
--url https://api.brandfetch.io/v2/viewer \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.brandfetch.io/v2/viewer"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.brandfetch.io/v2/viewer', 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.brandfetch.io/v2/viewer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.brandfetch.io/v2/viewer"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.brandfetch.io/v2/viewer")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brandfetch.io/v2/viewer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"type": "api-key",
"id": "id5ZQvmz9A",
"urn": "urn:brandfetch:organization:cl5s9fps1275071ol9h7gs072m:api-key:id5ZQvmz9A",
"name": "Production key",
"createdAt": "2026-05-12T09:14:07.000Z",
"usage": {
"used": 1234,
"quota": 250000
},
"organization": {
"id": "cl5s9fps1275071ol9h7gs072m",
"urn": "urn:brandfetch:organization:cl5s9fps1275071ol9h7gs072m",
"name": "Acme Inc."
}
}Viewer API
Returns the identity of the credential used to authenticate the request: an API key or a user session token (JWT). Use it to verify a credential during integration setup (a 200 response means the credential is valid; 401/403 means it is missing, unknown, or revoked) and to display which API key and organization are connected. Requests to this endpoint are free: they never consume API credits.
curl --request GET \
--url https://api.brandfetch.io/v2/viewer \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.brandfetch.io/v2/viewer"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.brandfetch.io/v2/viewer', 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.brandfetch.io/v2/viewer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.brandfetch.io/v2/viewer"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.brandfetch.io/v2/viewer")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brandfetch.io/v2/viewer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"type": "api-key",
"id": "id5ZQvmz9A",
"urn": "urn:brandfetch:organization:cl5s9fps1275071ol9h7gs072m:api-key:id5ZQvmz9A",
"name": "Production key",
"createdAt": "2026-05-12T09:14:07.000Z",
"usage": {
"used": 1234,
"quota": 250000
},
"organization": {
"id": "cl5s9fps1275071ol9h7gs072m",
"urn": "urn:brandfetch:organization:cl5s9fps1275071ol9h7gs072m",
"name": "Acme Inc."
}
}usage, matching
the x-api-key-quota and x-api-key-approximate-usage headers returned by
billable endpoints.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
The presented credential is valid. The type property indicates which kind of credential authenticated the request and determines the response shape.
- API key
- User
The authenticated API key.
The kind of credential that authenticated the request.
api-key Id of the API key.
URN of the API key, e.g. urn:brandfetch:organization:{organization.id}:api-key:{id}.
Display name of the API key, as set in the dashboard.
When the API key was created.
API credit consumption for the current billing period, mirroring the x-api-key-quota and x-api-key-approximate-usage response headers of billable endpoints. Because this endpoint is free, used is the exact count, not approximated one ahead like the header.
Show child attributes
Show child attributes
The organization the API key belongs to.
Show child attributes
Show child attributes
Was this page helpful?