Core GraphQL APIReferenceQueries
Identity__tenants
Platform admin only.
QUERY
identity__tenants(where: CommonPaginationDto): TenantsWithPagination!Platform admin only.
Arguments
where?Returns
- identity__tenants
meta?nodes?Example Request
query Identity__tenants { identity__tenants { meta { currentPage hasNextPage totalCount totalPages } nodes { _id address { caption lat lng } businessPhoneNumber charges { taxRate } createdAt description name siteDomain status tagline } }}{ "data": { "identity__tenants": { "meta": { "currentPage": 10.5, "hasNextPage": true, "totalCount": 10.5, "totalPages": 10.5 }, "nodes": [ { "_id": "1", "address": { "caption": "string", "lat": 10.5, "lng": 10.5 }, "businessPhoneNumber": "string", "charges": { "taxRate": 10.5 }, "createdAt": "<DateTime>", "description": "string", "name": "string", "siteDomain": "string", "status": "string", "tagline": "string" } ] } }}Identity__tenant QUERY
Requires a signed-in staff user. Needs the `identity__Tenant` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).
Identity__users QUERY
Requires a signed-in staff user. Needs the `identity__User` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).