GuidesChangelogAPI Reference
API Reference

/api/v5/tenant/

get
https://percolate.com/api/v5/tenant/

Returns all available tenants a user has access to even if their access token is bound to a single tenant.

Query Params
string

Search tenants by name

string

A CSV of types to filter by:

  • production
  • sandbox
  • internal
string
enum

Filter by tenant status:

  • active
  • inactive
Allowed:
boolean

If true, only return next tenants.

boolean

If true, enable superusers to fetch tenants info via staff admin page.

integer

Limit the number of paginated results.

integer

A 0-based offset to adjust the pagination window.

Responses

Retry-After header

Updated over 2 years ago

Language
Credentials
OAuth2
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 2 years ago