list

Lists tenants defined within the environment.

Parameters

search (optional) - Text search for the tenant name or key
page (optional) - The page number of the results to fetch, starting at 1
perPage (optional) - The number of results per page (maximum of 100)

Implementation

await permit.api.tenants.list({
  search: "example",
  page: 1,
  perPage: 20,
});