List all tenants
Changed onList all tenants with pagination. Filter by status if needed.
Request
- Base URLhttps://api.arkhq.io/v1
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Page number (1-indexed)
Number of items per page (max 100)
Filter by tenant status
Response
List of tenants
Example response
{
"data": [
{
"id": "cm6abc123def456ghi789",
"name": "Acme Corp",
"metadata": {
"plan": "pro",
"internalId": "cust_12345"
},
"status": "active",
"createdAt": "2026-02-03T10:30:00Z",
"updatedAt": "2026-02-03T10:30:00Z"
}
],
"page": 1,
"perPage": 20,
"total": 42,
"totalPages": 3,
"meta": {
"requestId": "req_V1StGXR8_Z5jdHi6"
}
}Changes
- warning
added the new
infrastructure_errorenum value to the/response property for the response status - warning
added the new
infrastructure_errorenum value to the/response property for the response status - warning
added the new
infrastructure_errorenum value to the/response property for the response status - warning
added the new
infrastructure_errorenum value to the/response property for the response status - info
removed the
postal_errorenum value from the/response property for the response status - info
removed the
postal_errorenum value from the/response property for the response status - info
removed the
postal_errorenum value from the/response property for the response status - info
removed the
postal_errorenum value from the/response property for the response status
- warning
- breaking
removed the required property
//from the response with the status - breaking
removed the required property
//from the response with the status - warning
added the new
already_existsenum value to the/response property for the response status - warning
added the new
already_existsenum value to the/response property for the response status - warning
added the new
already_existsenum value to the/response property for the response status - warning
added the new
already_existsenum value to the/response property for the response status - warning
added the new
attachment_too_largeenum value to the/response property for the response status - warning
added the new
attachment_too_largeenum value to the/response property for the response status - warning
added the new
attachment_too_largeenum value to the/response property for the response status - warning
added the new
attachment_too_largeenum value to the/response property for the response status - warning
added the new
authentication_requiredenum value to the/response property for the response status - warning
added the new
authentication_requiredenum value to the/response property for the response status - warning
added the new
authentication_requiredenum value to the/response property for the response status - warning
added the new
authentication_requiredenum value to the/response property for the response status - warning
added the new
billing_errorenum value to the/response property for the response status - warning
added the new
billing_errorenum value to the/response property for the response status - warning
added the new
billing_errorenum value to the/response property for the response status - warning
added the new
billing_errorenum value to the/response property for the response status - warning
added the new
billing_not_configuredenum value to the/response property for the response status - warning
added the new
billing_not_configuredenum value to the/response property for the response status - warning
added the new
billing_not_configuredenum value to the/response property for the response status - warning
added the new
billing_not_configuredenum value to the/response property for the response status - warning
added the new
credential_not_foundenum value to the/response property for the response status - warning
added the new
credential_not_foundenum value to the/response property for the response status - warning
added the new
credential_not_foundenum value to the/response property for the response status - warning
added the new
credential_not_foundenum value to the/response property for the response status - warning
added the new
credential_on_holdenum value to the/response property for the response status - warning
added the new
credential_on_holdenum value to the/response property for the response status - warning
added the new
credential_on_holdenum value to the/response property for the response status - warning
added the new
credential_on_holdenum value to the/response property for the response status - warning
added the new
credential_revokedenum value to the/response property for the response status - warning
added the new
credential_revokedenum value to the/response property for the response status - warning
added the new
credential_revokedenum value to the/response property for the response status - warning
added the new
credential_revokedenum value to the/response property for the response status - warning
added the new
delivery_not_foundenum value to the/response property for the response status - warning
added the new
delivery_not_foundenum value to the/response property for the response status - warning
added the new
delivery_not_foundenum value to the/response property for the response status - warning
added the new
delivery_not_foundenum value to the/response property for the response status - warning
added the new
domain_already_existsenum value to the/response property for the response status - warning
added the new
domain_already_existsenum value to the/response property for the response status - warning
added the new
domain_already_existsenum value to the/response property for the response status - warning
added the new
domain_already_existsenum value to the/response property for the response status - warning
added the new
domain_not_foundenum value to the/response property for the response status - warning
added the new
domain_not_foundenum value to the/response property for the response status - warning
added the new
domain_not_foundenum value to the/response property for the response status - warning
added the new
domain_not_foundenum value to the/response property for the response status - warning
added the new
domain_not_verifiedenum value to the/response property for the response status - warning
added the new
domain_not_verifiedenum value to the/response property for the response status - warning
added the new
domain_not_verifiedenum value to the/response property for the response status - warning
added the new
domain_not_verifiedenum value to the/response property for the response status - warning
added the new
email_not_foundenum value to the/response property for the response status - warning
added the new
email_not_foundenum value to the/response property for the response status - warning
added the new
email_not_foundenum value to the/response property for the response status - warning
added the new
email_not_foundenum value to the/response property for the response status - warning
added the new
external_id_already_existsenum value to the/response property for the response status - warning
added the new
external_id_already_existsenum value to the/response property for the response status - warning
added the new
external_id_already_existsenum value to the/response property for the response status - warning
added the new
external_id_already_existsenum value to the/response property for the response status - warning
added the new
forbiddenenum value to the/response property for the response status - warning
added the new
forbiddenenum value to the/response property for the response status - warning
added the new
forbiddenenum value to the/response property for the response status - warning
added the new
forbiddenenum value to the/response property for the response status - warning
added the new
idempotency_conflictenum value to the/response property for the response status - warning
added the new
idempotency_conflictenum value to the/response property for the response status - warning
added the new
idempotency_conflictenum value to the/response property for the response status - warning
added the new
idempotency_conflictenum value to the/response property for the response status - warning
added the new
insufficient_balanceenum value to the/response property for the response status - warning
added the new
insufficient_balanceenum value to the/response property for the response status - warning
added the new
insufficient_balanceenum value to the/response property for the response status - warning
added the new
insufficient_balanceenum value to the/response property for the response status - warning
added the new
internal_errorenum value to the/response property for the response status - warning
added the new
internal_errorenum value to the/response property for the response status - warning
added the new
internal_errorenum value to the/response property for the response status - warning
added the new
internal_errorenum value to the/response property for the response status - warning
added the new
invalid_api_keyenum value to the/response property for the response status - warning
added the new
invalid_api_keyenum value to the/response property for the response status - warning
added the new
invalid_api_keyenum value to the/response property for the response status - warning
added the new
invalid_api_keyenum value to the/response property for the response status - warning
added the new
invalid_email_addressenum value to the/response property for the response status - warning
added the new
invalid_email_addressenum value to the/response property for the response status - warning
added the new
invalid_email_addressenum value to the/response property for the response status - warning
added the new
invalid_email_addressenum value to the/response property for the response status - warning
added the new
invalid_raw_messageenum value to the/response property for the response status - warning
added the new
invalid_raw_messageenum value to the/response property for the response status - warning
added the new
invalid_raw_messageenum value to the/response property for the response status - warning
added the new
invalid_raw_messageenum value to the/response property for the response status - warning
added the new
invalid_requestenum value to the/response property for the response status - warning
added the new
invalid_requestenum value to the/response property for the response status - warning
added the new
invalid_requestenum value to the/response property for the response status - warning
added the new
invalid_requestenum value to the/response property for the response status - warning
added the new
ip_not_allowedenum value to the/response property for the response status - warning
added the new
ip_not_allowedenum value to the/response property for the response status - warning
added the new
ip_not_allowedenum value to the/response property for the response status - warning
added the new
ip_not_allowedenum value to the/response property for the response status - warning
added the new
message_too_largeenum value to the/response property for the response status - warning
added the new
message_too_largeenum value to the/response property for the response status - warning
added the new
message_too_largeenum value to the/response property for the response status - warning
added the new
message_too_largeenum value to the/response property for the response status - warning
added the new
metadata_key_invalidenum value to the/response property for the response status - warning
added the new
metadata_key_invalidenum value to the/response property for the response status - warning
added the new
metadata_key_invalidenum value to the/response property for the response status - warning
added the new
metadata_key_invalidenum value to the/response property for the response status - warning
added the new
metadata_too_largeenum value to the/response property for the response status - warning
added the new
metadata_too_largeenum value to the/response property for the response status - warning
added the new
metadata_too_largeenum value to the/response property for the response status - warning
added the new
metadata_too_largeenum value to the/response property for the response status - warning
added the new
metadata_value_invalidenum value to the/response property for the response status - warning
added the new
metadata_value_invalidenum value to the/response property for the response status - warning
added the new
metadata_value_invalidenum value to the/response property for the response status - warning
added the new
metadata_value_invalidenum value to the/response property for the response status - warning
added the new
missing_fieldenum value to the/response property for the response status - warning
added the new
missing_fieldenum value to the/response property for the response status - warning
added the new
missing_fieldenum value to the/response property for the response status - warning
added the new
missing_fieldenum value to the/response property for the response status - warning
added the new
missing_scopeenum value to the/response property for the response status - warning
added the new
missing_scopeenum value to the/response property for the response status - warning
added the new
missing_scopeenum value to the/response property for the response status - warning
added the new
missing_scopeenum value to the/response property for the response status - warning
added the new
not_foundenum value to the/response property for the response status - warning
added the new
not_foundenum value to the/response property for the response status - warning
added the new
not_foundenum value to the/response property for the response status - warning
added the new
not_foundenum value to the/response property for the response status - warning
added the new
payload_too_largeenum value to the/response property for the response status - warning
added the new
payload_too_largeenum value to the/response property for the response status - warning
added the new
payload_too_largeenum value to the/response property for the response status - warning
added the new
payload_too_largeenum value to the/response property for the response status - warning
added the new
payment_requiredenum value to the/response property for the response status - warning
added the new
payment_requiredenum value to the/response property for the response status - warning
added the new
payment_requiredenum value to the/response property for the response status - warning
added the new
payment_requiredenum value to the/response property for the response status - warning
added the new
postal_errorenum value to the/response property for the response status - warning
added the new
postal_errorenum value to the/response property for the response status - warning
added the new
postal_errorenum value to the/response property for the response status - warning
added the new
postal_errorenum value to the/response property for the response status - warning
added the new
rate_limit_exceededenum value to the/response property for the response status - warning
added the new
rate_limit_exceededenum value to the/response property for the response status - warning
added the new
rate_limit_exceededenum value to the/response property for the response status - warning
added the new
rate_limit_exceededenum value to the/response property for the response status - warning
added the new
send_limit_exceededenum value to the/response property for the response status - warning
added the new
send_limit_exceededenum value to the/response property for the response status - warning
added the new
send_limit_exceededenum value to the/response property for the response status - warning
added the new
send_limit_exceededenum value to the/response property for the response status - warning
added the new
server_suspendedenum value to the/response property for the response status - warning
added the new
server_suspendedenum value to the/response property for the response status - warning
added the new
server_suspendedenum value to the/response property for the response status - warning
added the new
server_suspendedenum value to the/response property for the response status - warning
added the new
service_unavailableenum value to the/response property for the response status - warning
added the new
service_unavailableenum value to the/response property for the response status - warning
added the new
service_unavailableenum value to the/response property for the response status - warning
added the new
service_unavailableenum value to the/response property for the response status - warning
added the new
suppressed_recipientenum value to the/response property for the response status - warning
added the new
suppressed_recipientenum value to the/response property for the response status - warning
added the new
suppressed_recipientenum value to the/response property for the response status - warning
added the new
suppressed_recipientenum value to the/response property for the response status - warning
added the new
suppression_not_foundenum value to the/response property for the response status - warning
added the new
suppression_not_foundenum value to the/response property for the response status - warning
added the new
suppression_not_foundenum value to the/response property for the response status - warning
added the new
suppression_not_foundenum value to the/response property for the response status - warning
added the new
tenant_not_foundenum value to the/response property for the response status - warning
added the new
tenant_not_foundenum value to the/response property for the response status - warning
added the new
tenant_not_foundenum value to the/response property for the response status - warning
added the new
tenant_not_foundenum value to the/response property for the response status - warning
added the new
too_many_attachmentsenum value to the/response property for the response status - warning
added the new
too_many_attachmentsenum value to the/response property for the response status - warning
added the new
too_many_attachmentsenum value to the/response property for the response status - warning
added the new
too_many_attachmentsenum value to the/response property for the response status - warning
added the new
too_many_recipientsenum value to the/response property for the response status - warning
added the new
too_many_recipientsenum value to the/response property for the response status - warning
added the new
too_many_recipientsenum value to the/response property for the response status - warning
added the new
too_many_recipientsenum value to the/response property for the response status - warning
added the new
unauthenticated_from_addressenum value to the/response property for the response status - warning
added the new
unauthenticated_from_addressenum value to the/response property for the response status - warning
added the new
unauthenticated_from_addressenum value to the/response property for the response status - warning
added the new
unauthenticated_from_addressenum value to the/response property for the response status - warning
added the new
unprocessable_entityenum value to the/response property for the response status - warning
added the new
unprocessable_entityenum value to the/response property for the response status - warning
added the new
unprocessable_entityenum value to the/response property for the response status - warning
added the new
unprocessable_entityenum value to the/response property for the response status - warning
added the new
validation_errorenum value to the/response property for the response status - warning
added the new
validation_errorenum value to the/response property for the response status - warning
added the new
validation_errorenum value to the/response property for the response status - warning
added the new
validation_errorenum value to the/response property for the response status - warning
added the new
webhook_not_foundenum value to the/response property for the response status - warning
added the new
webhook_not_foundenum value to the/response property for the response status - warning
added the new
webhook_not_foundenum value to the/response property for the response status - warning
added the new
webhook_not_foundenum value to the/response property for the response status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status
- breaking