Sign in

v57

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-012143051018.3 KB
Tenant Account

Retrieve all Tenant Accounts

Retrieve all Tenant Accounts for the org.

The Infrastructure Provider and Tenant are inferred from the org's membership. User must have authorization role with PROVIDER_ADMIN, PROVIDER_VIEWER, or TENANT_ADMIN suffix.

get/v2/org/{org}/nico/tenant/account

Query parameters

infrastructureProviderIdstring uuid

Filter Tenant Accounts by Infrastructure Provider ID. Deprecated: Infrastructure Provider is now inferred from the org's membership.

tenantIdstring uuid

Filter Tenant Accounts by Tenant ID

querystring

Search string to filter Tenant Accounts by account number, tenant org, or tenant org display name

includeRelation'InfrastructureProvider' | 'Tenant'

Related entity to expand

pageNumberinteger
Example:1

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

orderBy'STATUS_ASC' | 'STATUS_DESC' | 'CREATED_ASC' | 'CREATED_DESC' | 'UPDATED_ASC' | 'UPDATED_DESC' | 'ACCOUNT_NUMBER_ASC' | 'ACCOUNT_NUMBER_DESC' | 'TENANT_ORG_NAME_ASC' | 'TENANT_ORG_NAME_DESC' | 'TENANT_ORG_DISPLAY_NAME_ASC' | 'TENANT_ORG_DISPLAY_NAME_DESC' | 'TENANT_CONTACT_EMAIL_ASC' | 'TENANT_CONTACT_EMAIL_DESC' | 'TENANT_CONTACT_FULL_NAME_ASC' | 'TENANT_CONTACT_FULL_NAME_DESC'

Ordering for pagination query

Response

OK

idstring uuid

Unique UUID v4 identifier for the Tenant Account

infrastructureProviderIdstring uuid

ID of the Infrastructure Provider

infrastructureProviderOrgstring

Organization name of the Infrastructure Provider

tenantIdstring uuid nullable

ID of the Tenant

tenantOrgstring nullable

Org of the Tenant

allocationCountinteger

Number of Allocations for the Tenant Account

status'Pending' | 'Invited' | 'Ready' | 'Error'

Status values for Tenant Account objects

createdstring date-time

Date/time when the Tenant Account was created

updatedstring date-time

Date/time when the Tenant Account was last updated

Example response

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
    "infrastructureProviderOrg": "xskkpgqpeakn",
    "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    "tenantOrg": "rf43bbtnb9c5",
    "tenantContact": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "email": "janed@nvidia.com",
      "firstName": "Jane",
      "lastName": "Doe",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    },
    "allocationCount": 0,
    "status": "Ready",
    "statusHistory": [
      {
        "status": "Ready",
        "message": "Account ready, Tenant accepted invite",
        "created": "2019-08-24T14:15:22Z",
        "updated": "2019-08-24T14:15:22Z"
      }
    ],
    "siteCapabilities": [
      {
        "targetedInstanceCreation": true
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z"
  }
]