Skip to content
DonorIntel Knowledge Base

List All Tenants

GET
/v1/tenants/

List all tenants across the platform. Platform superadmin only.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
page
Page

Page number

integer
default: 1 >= 1

Page number

page_size
Page Size

Records per page

integer
default: 50 >= 1 <= 200

Records per page

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

OffsetPaginatedResponse[TenantSummary]
object
data
required
Data
Array<object>
TenantSummary

Lightweight Tenant projection for use in nested / list responses.

object
id
required
Id
string format: uuid
name
required
Name
string
slug
required
Slug
string
plan_name
required
Plan Name
string
is_active
required
Is Active
boolean
pagination
required
OffsetPaginationMeta

Offset pagination metadata.

object
total
required
Total
integer
page
required
Page
integer
page_size
required
Page Size
integer
total_pages
required
Total Pages
integer
has_next
required
Has Next
boolean
has_prev
required
Has Prev
boolean
meta
ResponseMeta

Metadata included in every response envelope.

object
request_id
Any of:
string
organization_id
Any of:
string

422

Section titled “422 ”

Validation Error

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