ListAccounts (under organization)
    • Dark
      Light

    ListAccounts (under organization)

    • Dark
      Light

    Article summary

    Get
    /v1/organizations/{organizationId}/accounts

    Availability

    Early Access: July 1, 2026

    Early Access is gated; contact the Backblaze Sales team for access.

    Limited Availability: July 1, 2026

    This API is available only to customers with access to the Backblaze Enterprise Web Console. For more information, contact the Backblaze Sales team.

    List accounts under an organization

    Returns the immediate child accounts of the given organization. Results are fully consistent, and the caller must have permission to list the entire collection at that level, or the request fails.

    Intended for administrative and automation use cases that require a complete and authoritative view of an account collection.

    Security
    HTTP
    Type bearer

    Short-lived bearer token obtained from GET /orgs/v1/authorize. Sent as Authorization - Bearer .

    Path parameters
    organizationId
    stringRequired

    The opaque identifier of the organization.

    Pattern^[a-z0-9_-]{8,64}$
    Exampleorg-acme-prod
    Query parameters
    showDeleted
    boolean

    If true, include resources in the DELETED state. Defaults to false.

    Defaultfalse
    pageSize
    integer

    Maximum number of items to return. Default 50, maximum 1000.

    Minimum1
    Maximum1000
    Default50
    pageToken
    string

    Opaque pagination token returned from a previous List response.

    Responses
    200

    The request succeeded.

    {
      "accounts": [
        {
          "name": "accounts/912345678901",
          "accountId": "912345678901",
          "parent": "organizations/org-acme-prod",
          "organization": "organizations/org-acme-prod",
          "displayName": "tenant-prod",
          "billingAccount": "billingAccounts/456",
          "state": "ACTIVE",
          "suspensionReasons": [],
          "etag": "BwXk9a2J8p0=",
          "createTime": "2026-02-03T21:10:00Z",
          "updateTime": "2026-02-03T21:15:00Z",
          "deleteTime": null,
          "purgeTime": null
        }
      ],
      "nextPageToken": "eyJwYWdlIjoyfQ=="
    }
    Expand All
    object
    accounts
    Array of object (Account)
    object
    name
    string

    Resource name in the form accounts/.

    Exampleaccounts/912345678901
    accountId
    string

    The numeric account identifier. Valid values match 9[0-4][0-9]{10}.

    Example912345678901
    parent
    string

    Parent resource name. May be an organization or an Organizational Unit.

    Exampleorganizations/org-acme-prod
    organization
    string

    The organization the account belongs to. Always populated, even if parent is an Organizational Unit.

    Exampleorganizations/org-acme-prod
    billingAccount
    string

    Billing account reference, in the form billingAccounts/. Must belong to the same organization as the account. Cannot be changed after creation.

    ExamplebillingAccounts/456
    displayName
    string
    Exampletenant-prod
    state
    string

    Account lifecycle state. An account is SUSPENDED while one or more suspension reasons are active.

    Valid values[ "ACTIVE", "SUSPENDED", "DELETED" ]
    ExampleACTIVE
    suspensionReasons
    Array of string

    Reasons the account is suspended. Values are unique and array order is unspecified.

    Example[]
    string
    Valid values[ "BACKBLAZE_INITIATED", "EXTERNALLY_INITIATED" ]
    etag
    string
    ExampleBwXk9a2J8p0=
    createTime
    string (date-time)
    updateTime
    string (date-time)
    deleteTime
    string (date-time) | null
    purgeTime
    string (date-time) | null
    nextPageToken
    string | null
    401

    The request was not authenticated.

    HTTP StatusCodeDescription
    401UNAUTHORIZEDMissing, expired, or invalid bearer token.
    Expand All
    object
    requestId
    string

    Opaque correlation identifier matching the Request-Id response header. Include in support requests.

    Example4bf92f3577b34da6a3ce929d0e0e4736
    error
    object
    code
    integer

    Numeric error code.

    Example10
    message
    string

    Human-readable description of the error.

    Exampleetag mismatch
    details
    object

    Reserved for structured, non-sensitive diagnostic information related to the error condition.

    403

    The caller is not authorized to perform this operation.

    HTTP StatusCodeDescription
    403FORBIDDENThe authenticated principal lacks permission for this action.
    Expand All
    object
    requestId
    string

    Opaque correlation identifier matching the Request-Id response header. Include in support requests.

    Example4bf92f3577b34da6a3ce929d0e0e4736
    error
    object
    code
    integer

    Numeric error code.

    Example10
    message
    string

    Human-readable description of the error.

    Exampleetag mismatch
    details
    object

    Reserved for structured, non-sensitive diagnostic information related to the error condition.

    429

    The request was rate-limited.

    HTTP StatusCodeDescription
    429TOO_MANY_REQUESTSRate limit exceeded. Use exponential backoff.
    Expand All
    object
    requestId
    string

    Opaque correlation identifier matching the Request-Id response header. Include in support requests.

    Example4bf92f3577b34da6a3ce929d0e0e4736
    error
    object
    code
    integer

    Numeric error code.

    Example10
    message
    string

    Human-readable description of the error.

    Exampleetag mismatch
    details
    object

    Reserved for structured, non-sensitive diagnostic information related to the error condition.

    500

    The server encountered an unexpected condition.

    HTTP StatusCodeDescription
    500INTERNALUnexpected server error. Include the requestId when contacting support.
    Expand All
    object
    requestId
    string

    Opaque correlation identifier matching the Request-Id response header. Include in support requests.

    Example4bf92f3577b34da6a3ce929d0e0e4736
    error
    object
    code
    integer

    Numeric error code.

    Example10
    message
    string

    Human-readable description of the error.

    Exampleetag mismatch
    details
    object

    Reserved for structured, non-sensitive diagnostic information related to the error condition.


    Was this article helpful?