v49

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

Get a credential

Get details of a specific credential.

Revealing the key: By default, the credential key is not returned. Pass reveal=true to include the key in the response. Use this sparingly and only when you need to retrieve the key (e.g., for configuration).

get/tenants/{tenantId}/credentials/{credentialId}

Path parameters

tenantIdstring required

The tenant ID

credentialIdinteger required

The credential ID (numeric)

Query parameters

revealboolean

Set to true to include the credential key in the response

Response

Credential details

successtrue required

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",
    "key": "cred_a1b2c3d4e5f6g7h8i9j0...",
    "smtpUsername": "cm6abc123def456/cred_a1b2c3d4e5f6g7h8i9j0..."
  },
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}