List Organizations

GET/v1/organizations

List organizations

Query ParametersExpand Collapse

cursor: optional string

Pagination cursor returned by a previous request

limit: optional number

Maximum number of items to return

maximum100

minimum10

ReturnsExpand Collapse

OrganizationList object { items, pagination }

items: array of Organization { id, billing_email, billing_state, 11 more }

id: string

Organization ID.

billing_email: string

Billing email. Null when no custom billing email is set (reverts to the oldest owner’s email).

billing_state: "unfunded" or "active" or "requires_action" or 2 more

Organization billing lifecycle state.

One of the following:

"unfunded"

"active"

"requires_action"

"suspended"

"closed"

billing_state_since: string

When the organization entered its current billing state.

formatdate-time

charging_model: "manual" or "prepaid"

How the organization is charged for resource usage.

One of the following:

"manual"

"prepaid"

created_at: string

When the Organization was created.

formatdate-time

domains: array of OrganizationDomain { id, domain, verified }

Domains associated with the organization.

id: string

Domain ID.

domain: string

Domain name.

verified: boolean

Whether the domain has been verified.

name: string

Organization name.

personal: boolean

Whether the organization is a personal Organization.

services: OrganizationServices { cloud, jit_provisioning, scim, 2 more }

Services that the Organization has access to.

cloud: boolean

Whether cloud services are enabled for the organization.

jit_provisioning: boolean

Whether just-in-time provisioning is enabled for the organization.

scim: boolean

Whether SCIM provisioning is enabled for the organization.

siem: boolean

Whether SIEM integration is enabled for the organization.

sso: boolean

Whether single sign-on is enabled for the organization.

stripe_customer_id: string

Stripe customer ID.

type: OrganizationType

Organization type.

One of the following:

"personal"

"company"

updated_at: string

When the Organization was updated.

formatdate-time

auth_id: optional string

Authentication provider organization ID.

pagination: Pagination { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

minimum0

List Organizations

curl https://api.nirvanalabs.io/v1/organizations \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY"

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "billing_email": "billing@example.com",
      "billing_state": "active",
      "billing_state_since": "2025-01-01T00:00:00Z",
      "charging_model": "prepaid",
      "created_at": "2025-01-01T00:00:00Z",
      "domains": [
        {
          "id": "456e7890-e89b-12d3-a456-426614174000",
          "domain": "example.com",
          "verified": true
        }
      ],
      "name": "My Organization",
      "personal": false,
      "services": {
        "cloud": true,
        "jit_provisioning": true,
        "scim": false,
        "siem": false,
        "sso": false
      },
      "stripe_customer_id": "cus_1234567890",
      "type": "company",
      "updated_at": "2025-01-01T00:00:00Z",
      "auth_id": "org_01H8GQBX3Z"
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}

Returns Examples

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "billing_email": "billing@example.com",
      "billing_state": "active",
      "billing_state_since": "2025-01-01T00:00:00Z",
      "charging_model": "prepaid",
      "created_at": "2025-01-01T00:00:00Z",
      "domains": [
        {
          "id": "456e7890-e89b-12d3-a456-426614174000",
          "domain": "example.com",
          "verified": true
        }
      ],
      "name": "My Organization",
      "personal": false,
      "services": {
        "cloud": true,
        "jit_provisioning": true,
        "scim": false,
        "siem": false,
        "sso": false
      },
      "stripe_customer_id": "cus_1234567890",
      "type": "company",
      "updated_at": "2025-01-01T00:00:00Z",
      "auth_id": "org_01H8GQBX3Z"
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}