Skip to main content
Using TypeScript? Check out our GraphQL SDK for a fully typed client.
We provide two of methods for fetching tenants:
  1. Get tenants to fetch more than one tenant at a time.
  2. Get tenant by ID
For all of these queries you need the following permissions:
  • tenant:read

​
Get tenants

Our API allows you to fetch tenants as a collection using the tenants query in GraphQL. This endpoint supports Pagination.
Query
query tenants($first: Int, $after: String, $last: Int, $before: String) {
  tenants(first: $first, after: $after, last: $last, before: $before) {
    edges {
      cursor
      node {
        id
        name
        externalId
        url
      }
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
  }
}
Variables
{
  "first": 25
}

​
Get tenant by ID

If you know the tenant’s ID in Plain you can use this method to fetch the tenant. Generally speaking it’s preferable to use upsert when you have the full details of the tenant.
Query
query tenant($tenantId: ID!) {
  tenant(tenantId: $tenantId) {
    id
    externalId
    name
    url
  }
}
Variables
{
  "tenantId": "te_123"
}