Credentials API
DRAFT — Internal Developer Use Only
This API reference is for internal development teams.
Overview
What it is: The credentials API provides read access to credentials used by automation actions and workflows. Credentials store authentication details for external systems like ServiceNow, SMTP servers, and webhooks.
Endpoints
| Method | Path | Description | Auth required |
|---|---|---|---|
GET | /api/v1/credentials | List credentials | JWT + API token |
GET /api/v1/credentials
List configured credentials. Supports filtering by purpose and tombstone status.
Query parameters:
| Parameter | Type | Description |
|---|---|---|
for | string | Filter by credential purpose (e.g., smtp, servicenow, webhook) |
tombstoned | boolean | Include soft-deleted credentials (true or false) |
Request:
http
GET /api/v1/credentials?for=smtp&tombstoned=false
Authorization: Bearer <token>Response (200):
json
[
{
"id": "cred-uuid-001",
"name": "SMTP Production",
"type": "smtp",
"tombstoned": false,
"createdAt": "2026-01-15T10:00:00Z"
}
]TIP
Credential secrets are never returned in API responses. Only metadata and configuration details are included.
