PPylon Developers
ApiAdmin Tenants

List tenants

Returns a paginated list of tenants.

GET
/api/admin/v1/tenants
AuthorizationBearer <token>

Enter your bearer token from the Pylon Auth API.

In: header

Query Parameters

page?integer
Default1
Formatint32
pageSize?integer
Default20
Formatint32
sort?string
q?string
status?unknown
Value in"Active" | "Suspended" | "Deleted" | null
includeDeleted?boolean
Defaultfalse

Response Body

application/json

application/json

curl -X GET "https://loading/api/admin/v1/tenants"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "slug": "string",
      "name": "string",
      "status": "string"
    }
  ],
  "meta": {
    "totalCount": 0,
    "page": 0,
    "pageSize": 0,
    "totalPages": 0,
    "hasNext": true,
    "hasPrevious": true
  },
  "links": null
}
{
  "code": "string",
  "message": "string"
}