List Sub-Orgs

Request example

{
  "query": {
    "limit": 20,
    "name": "%PrimeVault%"
  }
}

# Sample only. Generate a new signed token for each request
# (see Authentication). Tokens expire after 120 seconds.
curl --request GET \
  --url "https://api.primevault.com/api/external/sub_orgs/?limit=20&name=%25PrimeVault%25" \
  --header "Authorization: Bearer <signed JWT>" \
  --header "Api-Key: <API key>" \
  --header "Accept: application/json"

{
  "results": [
    {
      "id": "a648fa0d-4ca9-4f4f-a520-7ef5e9db34eb",
      "orgId": "a30d5e99-7076-45da-a933-0d5642619340",
      "name": "PrimeVault customer",
      "controlMode": "MANAGED",
      "createdAt": "2026-09-14T12:00:00Z",
      "updatedAt": "2026-09-14T12:00:00Z",
      "isDeleted": false,
      "version": 1
    }
  ],
  "nextCursor": null,
  "hasNext": false
}

GET /api/external/sub_orgs/?limit={limit}&cursor={cursor}&name={name} Returns the sub-orgs visible to the authenticated API user. Results are scoped to the organization, exclude deleted rows, and are ordered newest first by creation time, with ID as the tie-breaker.

Query parameters

string

Case-insensitive SQL-pattern match. Use %PrimeVault% to match names containing PrimeVault, or PrimeVault% for a prefix. % matches any sequence and _ matches one character.

integer

Page size. Default: 20; effective range: 1-100.

string

Opaque cursor returned as nextCursor. Omit it or send an empty value for the first page.

Response

interface SubOrgListResponse {
  results: SubOrg[];
  nextCursor?: string | null;
  hasNext?: boolean;
}

JavaScript SDK - read every page

import type { SubOrg } from "@primevault/js-api-sdk";

const subOrgs: SubOrg[] = [];
let cursor: string | null = null;

do {
  const page = await apiClient.getSubOrgs(
    { name: "%PrimeVault%" },
    20,
    cursor,
  );
  subOrgs.push(...page.results);
  cursor = page.nextCursor;
} while (cursor);

Python SDK - read every page

from typing import List, Optional
from primevault_python_sdk.types import SubOrg

sub_orgs: List[SubOrg] = []
cursor: Optional[str] = None

while True:
    page = api_client.get_sub_orgs(
        {"name": "%PrimeVault%"}, limit=20, cursor=cursor
    )
    sub_orgs.extend(page.results)
    if not page.hasNext:
        break
    cursor = page.nextCursor

Request example

{
  "query": {
    "limit": 20,
    "name": "%PrimeVault%"
  }
}

# Sample only. Generate a new signed token for each request
# (see Authentication). Tokens expire after 120 seconds.
curl --request GET \
  --url "https://api.primevault.com/api/external/sub_orgs/?limit=20&name=%25PrimeVault%25" \
  --header "Authorization: Bearer <signed JWT>" \
  --header "Api-Key: <API key>" \
  --header "Accept: application/json"

{
  "results": [
    {
      "id": "a648fa0d-4ca9-4f4f-a520-7ef5e9db34eb",
      "orgId": "a30d5e99-7076-45da-a933-0d5642619340",
      "name": "PrimeVault customer",
      "controlMode": "MANAGED",
      "createdAt": "2026-09-14T12:00:00Z",
      "updatedAt": "2026-09-14T12:00:00Z",
      "isDeleted": false,
      "version": 1
    }
  ],
  "nextCursor": null,
  "hasNext": false
}

When hasNext is true, pass nextCursor unchanged into the next request. Keep the same name filter and page size while paging. An empty result is results: [], nextCursor: null, and hasNext: false. This response does not include a total count.

⌘I

Request example

{
  "query": {
    "limit": 20,
    "name": "%PrimeVault%"
  }
}

# Sample only. Generate a new signed token for each request
# (see Authentication). Tokens expire after 120 seconds.
curl --request GET \
  --url "https://api.primevault.com/api/external/sub_orgs/?limit=20&name=%25PrimeVault%25" \
  --header "Authorization: Bearer <signed JWT>" \
  --header "Api-Key: <API key>" \
  --header "Accept: application/json"

{
  "results": [
    {
      "id": "a648fa0d-4ca9-4f4f-a520-7ef5e9db34eb",
      "orgId": "a30d5e99-7076-45da-a933-0d5642619340",
      "name": "PrimeVault customer",
      "controlMode": "MANAGED",
      "createdAt": "2026-09-14T12:00:00Z",
      "updatedAt": "2026-09-14T12:00:00Z",
      "isDeleted": false,
      "version": 1
    }
  ],
  "nextCursor": null,
  "hasNext": false
}

API Basics

Approvals

Accounts

Sub-Orgs

Transactions

Query parameters

Response

JavaScript SDK - read every page

Python SDK - read every page

​Query parameters

​Response

​JavaScript SDK - read every page

​Python SDK - read every page

Query parameters

Response

JavaScript SDK - read every page

Python SDK - read every page