curl --request GET \
--url https://api.northell.io/nhl/prod/mediamagic-verify-integrations/api/workspace \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.northell.io/nhl/prod/mediamagic-verify-integrations/api/workspace"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.northell.io/nhl/prod/mediamagic-verify-integrations/api/workspace', 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.northell.io/nhl/prod/mediamagic-verify-integrations/api/workspace",
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-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.northell.io/nhl/prod/mediamagic-verify-integrations/api/workspace"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-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.northell.io/nhl/prod/mediamagic-verify-integrations/api/workspace")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.northell.io/nhl/prod/mediamagic-verify-integrations/api/workspace")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orgName": "<string>",
"apiKeyName": "<string>"
}Resolve the workspace behind this API key
Return the workspace and organization this API key is scoped to.
Every other endpoint takes the workspace implicitly from the key and never reports which one it resolved to, so an integration holding more than one key — or storing anything per workspace — cannot tell them apart. This is the endpoint that answers it.
Everything returned is already established by authenticating the request, so there is no database read beyond the key lookup every endpoint does.
Authentication: Requires X-API-Key header with valid API key.
curl --request GET \
--url https://api.northell.io/nhl/prod/mediamagic-verify-integrations/api/workspace \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.northell.io/nhl/prod/mediamagic-verify-integrations/api/workspace"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.northell.io/nhl/prod/mediamagic-verify-integrations/api/workspace', 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.northell.io/nhl/prod/mediamagic-verify-integrations/api/workspace",
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-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.northell.io/nhl/prod/mediamagic-verify-integrations/api/workspace"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-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.northell.io/nhl/prod/mediamagic-verify-integrations/api/workspace")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.northell.io/nhl/prod/mediamagic-verify-integrations/api/workspace")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orgName": "<string>",
"apiKeyName": "<string>"
}Authorizations
Workspace-scoped API key. Format: sk_live_{64 hex chars}
Response
Successful Response
Who the presented API key belongs to.
Every other endpoint takes the workspace implicitly from the key and never says which one it resolved to. An integration that holds several keys, or that stores anything per workspace, has no way to find out — this closes that gap. All of it is already known from authenticating the request, so the read costs nothing.
Workspace this API key is scoped to
Organization that owns the workspace
Organization display name
Label given to this API key when it was created. Useful for telling several keys apart in an integration's own logs.