Provisioning

List the accounts you provisioned

Returns the accounts you provisioned, newest first. Each carries its lifecycle status (PROVISIONED → CLAIMED → ACTIVE), the access_level you hold over it and the state of its claim link.

  • status: narrows the list to one lifecycle stage.
  • external_ref: looks an account up by the reference you assigned when provisioning it; returns the 0..1 matching accounts.

Cursor pagination. This collection pages by cursor/next_cursor instead of by page, so it carries no pagination block. That is a documented variant of pagination, not a different envelope: the collection still travels under a named key inside data. Keep asking with the next_cursor of the previous response until it comes back null.

get/v1/accounts

Request

  • Base URL: https://app.beel.es/api
  • URL: https://app.beel.es/api/v1/accounts
  • Auth: HTTP bearer

Query parameters

status'PROVISIONED' | 'CLAIMED' | 'ACTIVE'

Lifecycle stage of a provisioned account. The claim gates the stage: PROVISIONED (created, not yet claimed — the holder has not set a password / taken ownership, even if a NIF was seeded at provisioning or you invoice on their behalf with OPERATE); CLAIMED (the holder set their password and took ownership, no NIF yet); ACTIVE (claimed and has at least one NIF — can operate under their own ownership).

Keeps only the accounts at this lifecycle stage. Omitted, every stage is listed.

external_refstring

Your own id for the account; returns the 0..1 matching accounts.

limitinteger

Maximum number of accounts to return per page (1–200). Defaults to 50.

cursorstring

Opaque pagination cursor from a previous response's next_cursor.

Response

A page of provisioned accounts.

successboolean required

Example response

{
  "success": true,
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.