GET
/
v1
/
key
Get the current key
curl --request GET \
  --url https://platform.jobbit.uk/v1/key \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://platform.jobbit.uk/v1/key"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://platform.jobbit.uk/v1/key', 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://platform.jobbit.uk/v1/key",
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://platform.jobbit.uk/v1/key"

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://platform.jobbit.uk/v1/key")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://platform.jobbit.uk/v1/key")

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
{
  "id": "k3x9m2q7w1za",
  "kind": "user",
  "name": "Kent Physio website",
  "user_id": "7b0e2c4a-1d3f-4c8e-9a52-6f1d0e8b3a77",
  "plan": "plus",
  "scopes": [
    "account:read",
    "agent:read",
    "agent:write",
    "ai",
    "deploy:read",
    "deploy:write",
    "files:read",
    "files:write"
  ],
  "restrictions": {
    "apps": [
      "kent-physio-site"
    ],
    "max_credits_per_day": "500"
  },
  "expires_at": "2027-03-31T23:59:59+00:00"
}
{
"error": {
"code": "invalid_key",
"message": "the API key is missing or invalid",
"request_id": "5d3f0b7c8a2e4e19b6c47a90d1e2f3a4"
}
}
{
"error": {
"code": "insufficient_scope",
"message": "this key does not have the deploy:write permission",
"details": {
"required": "deploy:write"
},
"request_id": "5d3f0b7c8a2e4e19b6c47a90d1e2f3a4"
}
}
{
"error": {
"code": "rate_limited",
"message": "too many read requests, retry in 4 s",
"details": {
"group": "read",
"limit": 120,
"window_seconds": 60
},
"request_id": "5d3f0b7c8a2e4e19b6c47a90d1e2f3a4"
}
}

Authorizations

Authorization
string
header
required

An API key from Settings → API keys, sent as Authorization: Bearer jb_live_…

Response

The key.

id
string
required

The key id, 12 lowercase letters and digits. It is the part after jb_live_ and before the secret.

kind
enum<string>
required

user for keys made in the app, service for internal service keys.

Available options:
user,
service
name
string
required

The name given to the key.

user_id
string
required

The account that owns the key.

plan
enum<string>
required

The account's plan.

Available options:
free,
go,
plus,
pro,
max
scopes
enum<string>[]
required

Permissions granted, sorted. A write permission also includes its read permission.

Available options:
account:read,
billing:write,
ai,
agent:read,
agent:write,
deploy:read,
deploy:write,
deploy:admin,
files:read,
files:write,
automations:read,
automations:write,
automations:run,
webhooks:write,
projects:read,
projects:write,
domains:read,
domains:write
restrictions
object
required

Limits set on the key. Only the limits that are set appear.

expires_at
string<date-time> | null
required

When the key stops working, or null if it does not expire.