v49

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-02-185890337.1 KB
Credentials

List credentials for a tenant

List all SMTP and API credentials for a tenant. Credentials are used to send emails via Ark on behalf of the tenant.

Security: Credential keys are not returned in the list response. Use the retrieve endpoint with reveal=true to get the key.

get/tenants/{tenantId}/credentials

Path parameters

tenantIdstring required

The tenant ID

Query parameters

pageinteger

Page number (1-indexed)

perPageinteger

Number of items per page (max 100)

type'smtp' | 'api'

Filter by credential type

Response

List of credentials

pageinteger required

Current page number (1-indexed)

perPageinteger required

Items per page

totalinteger required

Total number of credentials

totalPagesinteger required

Total number of pages

Example response

{
  "data": [
    {
      "id": 123,
      "name": "production-smtp",
      "type": "smtp",
      "lastUsedAt": "2026-02-03T10:30:00Z",
      "createdAt": "2026-01-15T08:00:00Z",
      "updatedAt": "2026-02-03T10:30:00Z"
    }
  ],
  "page": 1,
  "perPage": 30,
  "total": 5,
  "totalPages": 1,
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}