Provisioning API · Internal testing only

getAuthenticatedAccount

GET

/me

const url = 'https://api.builders.ac/api/provisioning/v1alpha1/me';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.builders.ac/api/provisioning/v1alpha1/me \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Responses

200

Authenticated account.

application/json

object

required

Canonical lowercase Account TypeID.

string

>= 30 characters <= 30 characters /^acc_[0-7][0-9a-hjkmnp-tv-z]{25}$/

object

required

Allowed value: account

name

required

string

<= 255 characters

email

required

string format: email

<= 255 characters

Example

{
  "id": "acc_01k4m9xq7te2yv3h4p8qd6r7wz",
  "object": "account",
  "name": "Northwind Labs",
  "email": "ops@northwind-labs.com"
}

Headers

x-correlation-id

string

The id of this request, echoed on every response and repeated in the correlation_id member of a problem body. Quote it in support requests.

401

Authentication required. The example shows authentication_required; this status is also answered with invalid_api_key. Branch on code, not on the status.

application/problem+json

object

type

required

string format: uri-reference

title

required

string

status

required

integer

detail

required

string

code

required

Extensible enum. Branch on this, never on title. New codes may appear at any time, so treat an unrecognised one as its HTTP status; GET /problems lists every code this version can answer with, and GET /problems/{code} resolves one.

string

retryable

required

boolean

retry_after

string format: date-time

correlation_id

required

string

errors

object

key

additional properties

Array<string>

Example

{
  "type": "https://api.builders.ac/api/provisioning/v1alpha1/problems/authentication_required",
  "title": "Authentication required",
  "status": 401,
  "detail": "Provide an active Provisioning API Key as a Bearer token.",
  "code": "authentication_required",
  "retryable": false,
  "correlation_id": "9f1c2b7a-3d5e-4c81-9a77-2f6b0e4d51c3"
}

Headers

x-correlation-id

string

The id of this request, echoed on every response and repeated in the correlation_id member of a problem body. Quote it in support requests.

403

Account inactive. The example shows account_inactive; this status is also answered with insufficient_proof. Branch on code, not on the status.

application/problem+json

object

type

required

string format: uri-reference

title

required

string

status

required

integer

detail

required

string

code

required

string

retryable

required

boolean

retry_after

string format: date-time

correlation_id

required

string

errors

object

key

additional properties

Array<string>

Example

{
  "type": "https://api.builders.ac/api/provisioning/v1alpha1/problems/account_inactive",
  "title": "Account inactive",
  "status": 403,
  "detail": "This account is inactive.",
  "code": "account_inactive",
  "retryable": false,
  "correlation_id": "9f1c2b7a-3d5e-4c81-9a77-2f6b0e4d51c3"
}

Headers

x-correlation-id

string

The id of this request, echoed on every response and repeated in the correlation_id member of a problem body. Quote it in support requests.

429

Rate limit exceeded. The example shows rate_limit_exceeded.

application/problem+json

object

type

required

string format: uri-reference

title

required

string

status

required

integer

detail

required

string

code

required

string

retryable

required

boolean

retry_after

string format: date-time

correlation_id

required

string

errors

object

key

additional properties

Array<string>

Example

{
  "type": "https://api.builders.ac/api/provisioning/v1alpha1/problems/rate_limit_exceeded",
  "title": "Rate limit exceeded",
  "status": 429,
  "detail": "Too many requests were made for this policy.",
  "code": "rate_limit_exceeded",
  "retryable": true,
  "correlation_id": "9f1c2b7a-3d5e-4c81-9a77-2f6b0e4d51c3",
  "retry_after": "2026-04-15T09:16:04Z"
}

Headers

x-correlation-id

string

The id of this request, echoed on every response and repeated in the correlation_id member of a problem body. Quote it in support requests.

503

Service unavailable. The example shows service_unavailable; this status is also answered with encryption_keys_unavailable, provider_unreachable. Branch on code, not on the status.

application/problem+json

object

type

required

string format: uri-reference

title

required

string

status

required

integer

detail

required

string

code

required

string

retryable

required

boolean

retry_after

string format: date-time

correlation_id

required

string

errors

object

key

additional properties

Array<string>

Example

{
  "type": "https://api.builders.ac/api/provisioning/v1alpha1/problems/service_unavailable",
  "title": "Service unavailable",
  "status": 503,
  "detail": "Retry the request later; the service is temporarily unavailable.",
  "code": "service_unavailable",
  "retryable": true,
  "correlation_id": "9f1c2b7a-3d5e-4c81-9a77-2f6b0e4d51c3"
}

Headers

x-correlation-id

string

The id of this request, echoed on every response and repeated in the correlation_id member of a problem body. Quote it in support requests.