Pular para o conteúdo
Healthing CRM

List Tenants

GET
/api/v1/admin/tenants

List all tenants with pagination and filters (super admin only).

Authorizations

Seção intitulada “Authorizations ”

Parameters

Seção intitulada “ Parameters ”

Query Parameters

Seção intitulada “Query Parameters ”
page
Page
integer
default: 1 >= 1
per_page
Per Page
integer
default: 20 >= 1 <= 100
status
Any of:
TenantStatus

Tenant status options.

string
Allowed values: active trial suspended cancelled
search
Any of:
string

Responses

Seção intitulada “ Responses ”

200

Seção intitulada “200 ”

Successful Response

TenantListResponse

List tenants response.

object
tenants
required
Tenants
Array<object>
TenantListItem

Tenant list item for admin.

object
id
required
Id
integer
name
required
Name
string
slug
required
Slug
string
schema_name
required
Schema Name
string
status
required
TenantStatus

Tenant status options.

string
Allowed values: active trial suspended cancelled
trial_ends_at
required
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
total_users
Total Users
integer
0
total_contacts
Total Contacts
integer
0
total_companies
Total Companies
integer
0
owner_name
Any of:
string
owner_email
Any of:
string
total
required
Total
integer
page
required
Page
integer
per_page
required
Per Page
integer

422

Seção intitulada “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string