Skip to main content
GET
/
tenants
cURL
curl "https://api.arkhq.io/v1/tenants?page=1&perPage=20" \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "data": [
    {
      "id": "cm6abc123def456",
      "name": "Acme Corp",
      "metadata": {
        "plan": "pro"
      },
      "status": "active",
      "createdAt": "2026-02-03T10:30:00Z",
      "updatedAt": "2026-02-03T10:30:00Z"
    },
    {
      "id": "cm6xyz789ghi012",
      "name": "Widget Inc",
      "metadata": {},
      "status": "active",
      "createdAt": "2026-02-02T14:20:00Z",
      "updatedAt": "2026-02-02T14:20:00Z"
    }
  ],
  "page": 1,
  "perPage": 20,
  "total": 2,
  "totalPages": 1,
  "meta": {
    "requestId": "req_abc123xyz"
  }
}

Documentation Index

Fetch the complete documentation index at: https://arkhq.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use your API key from arkhq.io/org/credentials

Authorization: Bearer YOUR_API_KEY

Query Parameters

​
page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
​
perPage
integer
default:20

Number of items per page (max 100)

Required range: 1 <= x <= 100
​
status
enum<string>

Filter by tenant status

Available options:
active,
suspended,
archived

Response

List of tenants

​
data
object[]
required

List of tenants

​
page
integer
required

Current page number (1-indexed)

Example:

1

​
perPage
integer
required

Items per page

Example:

20

​
total
integer
required

Total number of tenants

Example:

42

​
totalPages
integer
required

Total number of pages

Example:

3

​
meta
object
required