SettleMint
Administration

Organizations administration API

List every organization on a DALP platform from one cross-tenant endpoint built for platform administrators.

Overview

The organizations administration endpoint returns every organization on a DALP platform in one cross-tenant list. Platform administrators use the list to review tenants for capacity planning and governance, check owner and member coverage, and see how many assets each organization runs, all without switching context into each tenant. Most DALP endpoints operate inside one active organization. This endpoint spans all organizations by design.

The endpoint is read-only. It reports the current organization roster and does not create, rename, or remove organizations, members, or assets.

Access and scope

This endpoint requires a DALP account with the global administrator role. The platform rejects any other caller with a forbidden error before the handler runs, and the platform records the call in the global administrator audit log. An API key inherits the role of the account that created the key, so a key works here only when its owner holds the global administrator role.

The response spans every organization on the platform, not just the caller's active organization. Treat the result as platform-wide administrative data and protect it accordingly.

Requirements

Before you call this endpoint:

  • Authenticate with a DALP account that holds the global administrator role.
  • Send list controls using the JSON:API query convention: sort, page[offset], page[limit], and filter[<field>].
  • Pass --globoff to curl so it does not expand the square brackets in query parameters.

List all organizations

Load the organization roster with pagination. The default sort is createdAt.

curl --globoff "https://your-platform.example.com/api/v2/admin/organizations?page[offset]=0&page[limit]=50&sort=-createdAt" \
  -H "X-Api-Key: sm_dalp_xxxxxxxxxxxxxxxx"
{
  "data": [
    {
      "id": "org_123abc",
      "name": "Acme Corp",
      "slug": "acme-corp",
      "logo": "https://example.com/logo.png",
      "createdAt": "2026-05-17T09:10:29.428Z",
      "ownerCount": 2,
      "ownerEmails": ["[email protected]", "[email protected]"],
      "memberCount": 10,
      "assetCount": 5
    }
  ],
  "meta": {
    "total": 1
  },
  "links": {
    "self": "/v2/admin/organizations?page[offset]=0&page[limit]=50&sort=-createdAt",
    "first": "/v2/admin/organizations?page[offset]=0&page[limit]=50&sort=-createdAt",
    "prev": null,
    "next": null,
    "last": "/v2/admin/organizations?page[offset]=0&page[limit]=50&sort=-createdAt"
  }
}

The response uses the standard DALP list envelope. data holds the organization rows, meta.total reports the full count across the platform, and links carries pagination cursors. meta.facets is omitted because this endpoint does not compute server-side facet counts.

Organization model

Each row combines core organization data with aggregate counts so you can size and govern a tenant without a second call.

FieldTypeNotes
idstringOrganization identifier.
namestringOrganization display name.
slugstringURL-safe organization identifier.
logostring or nullLogo URL when one is set, otherwise null.
createdAtISO 8601 timestampWhen the organization was created.
ownerCountintegerNumber of owners in the organization.
ownerEmailsarray of stringsEmail addresses for the organization owners.
memberCountintegerTotal members, owners included.
assetCountintegerNumber of assets the organization runs.

The endpoint supports the JSON:API collection controls used across DALP list endpoints.

Sort by any supported field. Prefix the field with - for descending order.

curl --globoff "https://your-platform.example.com/api/v2/admin/organizations?sort=name" \
  -H "X-Api-Key: sm_dalp_xxxxxxxxxxxxxxxx"

Filter on a single column with filter[<field>].

curl --globoff "https://your-platform.example.com/api/v2/admin/organizations?filter[slug]=acme-corp" \
  -H "X-Api-Key: sm_dalp_xxxxxxxxxxxxxxxx"

Search across organizations with filter[q]. The platform matches the query against organization fields and returns the organizations that match.

curl --globoff "https://your-platform.example.com/api/v2/admin/organizations?filter[q]=acme" \
  -H "X-Api-Key: sm_dalp_xxxxxxxxxxxxxxxx"
ControlParameterNotes
Sortsort=nameSort on name, slug, or createdAt. Prefix - to reverse.
Filterfilter[name]=AcmeFilter on name, slug, or createdAt.
Global searchfilter[q]=acmeSearch across organizations.
Page offsetpage[offset]=0Zero-based start index for the page.
Page sizepage[limit]=50Rows per page. Defaults to 50, with a maximum of 200.

Use the CLI

The same roster is available from the DALP CLI for quick checks:

dalp admin organizations list

Run the command with a platform administrator account through the active Platform API context. Use the CLI for ad hoc reviews and the API when you build dashboards, capacity reports, or governance tooling.

Operational notes

  • The result is platform-wide. Restrict access to global administrators and the systems that act for them.
  • meta.total counts every organization on the platform, independent of the current page.
  • ownerEmails lists the organization owners so administrators can route ownership and escalation questions without a second lookup.
  • The aggregate counts reflect the organization's current owners, members, and assets at read time.

On this page