API reference

Changelog

• v1 Tellagent: the reference groups AI Workflows, Runs and the new Automations section under Tellagent. GET /v1/automations (filter by status and project), GET /v1/automations/{id}, GET /v1/automations/{id}/runs (filter by status) and GET /v1/automation-runs/{id} (with its steps), under the new automations:read scope; POST /v1/automations/{id}/enrollments (with a required Idempotency-Key) enrolls contacts in a published automation under the new automations:enroll scope, and sends the automation's real email and texts. The API never creates, edits or publishes an automation.
• v1 Skunk Works: GET /v1/skunkworks/projects, GET /v1/skunkworks/projects/{project_id}/items (filter by status, type, sprint, assignee, epic, label, words, changed since), GET /v1/skunkworks/projects/{project_id}/items/{key} (description, linked documents and history) and GET /v1/skunkworks/projects/{project_id}/sprints (with a completed sprint's review), under the new skunkworks:read scope.
• v1 Thrive contacts: GET /v1/contacts (search, exact email, lifecycle stage, changed since), GET /v1/contacts/{id}, POST /v1/contacts (with an optional Idempotency-Key; a duplicate email is 409 contact_exists with the existing id) and PATCH /v1/contacts/{id} (only the fields sent change). The API never deletes a contact or lifts a do-not-contact or email opt-out.
• v1 Data Management: GET /v1/projects, GET /v1/projects/{id}, GET /v1/projects/{id}/items, GET /v1/items/{id} and POST /v1/projects/{id}/items to create a page from Markdown or HTML (with an optional Idempotency-Key). Files are listed and described but not uploaded or downloaded.
• v1 Runs and usage: GET /v1/workflows/{id}, POST /v1/workflows/{id}/runs (with a required Idempotency-Key), GET /v1/workflows/{id}/runs, GET /v1/runs/{id} and GET /v1/usage. Keys can carry a monthly spend cap.
• v1 First release: API keys created in Account → API keys, and GET /v1/workflows.