Query
query SearchTenants($searchQuery: TenantsSearchQuery!) {
searchTenants(searchQuery: $searchQuery) {
edges {
cursor
node {
tenant {
__typename
}
}
}
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
}
}Variables
{
"searchQuery": {
"term": "string"
}
}Response
{
"data": {
"searchTenants": {
"edges": [
{
"cursor": "string",
"node": {
"tenant": {
"__typename": "Tenant"
}
}
}
],
"pageInfo": {
"hasPreviousPage": true,
"hasNextPage": true,
"startCursor": "string",
"endCursor": "string"
}
}
}
}Queries
searchTenants
Searches tenants by name (case-insensitive partial match) or by external ID (exact match).
The search term must be at least 2 characters long. Returns a paginated list of results.
Requires the tenant:read permission.
QUERY
searchTenants(searchQuery: TenantsSearchQuery!, filters: TenantsFilter, first: Int, after: String, last: Int, before: String): TenantSearchResultConnection!Arguments
searchQuery
required
filters
first
Int
after
String
last
Int
before
String
Returns
edges
pageInfo
Query
query SearchTenants($searchQuery: TenantsSearchQuery!) {
searchTenants(searchQuery: $searchQuery) {
edges {
cursor
node {
tenant {
__typename
}
}
}
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
}
}Variables
{
"searchQuery": {
"term": "string"
}
}Response
{
"data": {
"searchTenants": {
"edges": [
{
"cursor": "string",
"node": {
"tenant": {
"__typename": "Tenant"
}
}
}
],
"pageInfo": {
"hasPreviousPage": true,
"hasNextPage": true,
"startCursor": "string",
"endCursor": "string"
}
}
}
}Was this page helpful?