List all tenants

get

https://api.controlup.com/v1/organizations/{tenantManagerOrgId}/tenants

Returns a paginated list of tenants (organizations) under the Tenant Manager.
Only Tenant Manager admins with "Manage Settings" permission can access this endpoint.

Path Params

tenantManagerOrgId

uuid

required

^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$

ID of the Tenant Manager organization.

Query Params

_page

int32

≥ 1

Defaults to 1

The page of results to return.
The first page is page number 1.

_limit

int32

≥ 1

Defaults to 10

The number of results returned per page.

_sortBy

string

enum

Sort by this field. Use "id" for organization_id.

Allowed:

_order

string

enum

Sort order: "asc" or "desc".

Allowed:

organization_id

uuid

^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$

Filter by tenant organization ID. Only the tenant with this ID is returned (exact match).

account_id

uuid

^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$

Filter by account ID. Only organizations belonging to this account are returned.

name

string

Filter by organization name (case-insensitive partial match).

connection_type

string

enum

Filter by connection type: "direct" (same account) or "linked" (from another account).

Allowed:

status

string

enum

Filter by organization status: "active" (enabled) or "inactive" (disabled).

Allowed:

prospect

boolean

Filter by prospect: only prospects (true) or only non-prospects (false).

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ok

400Bad Request

401Unauthorized: Access is denied

403Forbidden: Access to this resource is denied

404Not Found: The requested resource could not be found

500Internal Server Error