Provisioning API · Internal testing only

Retrieve a sequencer account

GET

/provider-accounts/{pra}

const url = 'https://api.builders.ac/api/provisioning/v1alpha1/provider-accounts/pra_01jsdqrf91f949ybjwh90xde9g';
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/provider-accounts/pra_01jsdqrf91f949ybjwh90xde9g \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Path Parameters

pra

required

string

>= 30 characters <= 30 characters /^[pP][rR][aA]_[0-7][0-9a-hjkmnp-tv-zA-HJKMNP-TV-Z]{25}$/

Provider account TypeIDs are accepted case-insensitively. Responses use canonical lowercase.

Responses

200

Provider account. Secrets are never included.

application/json

object

required

Canonical lowercase TypeID.

string

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

object

required

Allowed value: provider_account

provider

required

The sequencer behind a provider account.

string

Allowed values: instantly smartlead plusvibe bison

username

required

The login the upload worker signs in with; null when the sequencer authenticates by key alone.

string | null

<= 255 characters

url

required

The per-customer base URL, for providers that have one.

string | null format: uri

sequencer_workspaces

required

Workspace names known at the sequencer: the one registered plus any discovered from the key. PUT /domains/{dom}/sequencer takes one of these.

Array<string>

validation_status

required

The outcome of the last credential check with the sequencer; null when the account has never been checked.

string | null

Allowed values: valid invalid

validated_at

required

When the credentials were last verified with the sequencer.

string | null format: date-time

external_id

required

Opaque and case-sensitive; unique per owning Account within the provider-account resource type.

string | null

>= 1 characters <= 255 characters

created_at

required

string | null format: date-time

updated_at

required

string | null format: date-time

Example

{
  "id": "pra_01jsdqrf91f949ybjwh90xde9g",
  "object": "provider_account",
  "provider": "instantly",
  "username": "outbound@northwind-labs.com",
  "url": "https://northwind.sequencer.example",
  "sequencer_workspaces": [
    "Northwind Outbound",
    "Northwind EU"
  ],
  "validation_status": "valid",
  "validated_at": "2026-04-16T11:02:37Z",
  "external_id": "crm-8421",
  "created_at": "2026-04-15T09:15:04Z",
  "updated_at": "2026-04-16T11:02:37Z"
}

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.

404

Not found. The example shows not_found.

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/not_found",
  "title": "Not found",
  "status": 404,
  "detail": "The requested resource was not found.",
  "code": "not_found",
  "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.