Revenue grew 12% on Q2.
\n" } } } } }, "400": { "description": "The request is not valid.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "invalid_request", "code": "missing_field", "message": "content is required.", "param": "content", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "description": "The key may not do this.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "permission", "code": "insufficient_scope", "message": "This API key does not have the content:write scope.", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "404": { "description": "Not found in this account.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "not_found", "code": "resource_not_found", "message": "No project with that id.", "param": "id", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "409": { "description": "The Idempotency-Key is busy, or its first request did not finish.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "conflict", "code": "idempotency_in_progress", "message": "A request with this Idempotency-Key is still being handled. Retry in a few seconds.", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "413": { "description": "The page is too large.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "invalid_request", "code": "page_too_large", "message": "This page is too large to store (more than 900000 bytes once converted to HTML). Split it into two pages.", "param": "content", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "422": { "description": "A body field cannot be used.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "invalid_request", "code": "unknown_field", "message": "A page takes name, format, content and folder_id; \"title\" is not one of them.", "param": "title", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/items/{id}": { "get": { "operationId": "getItem", "tags": [ "Items" ], "summary": "Get an item", "description": "One item. For a page, `body` holds its text, as HTML (or Markdown, for a page that was stored as Markdown); images in a page are references (`Three launches this week.
\n" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "description": "The key may not do this.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "permission", "code": "insufficient_scope", "message": "This API key does not have the content:read scope.", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "404": { "description": "Not found in this account.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "not_found", "code": "resource_not_found", "message": "No item with that id.", "param": "id", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/contacts": { "get": { "operationId": "listContacts", "tags": [ "Contacts" ], "summary": "List contacts", "description": "The account's contacts in Thrive, newest first. Deleted (archived) contacts are left out. Filters combine: `q` searches names, emails, titles and company names; `email` finds the one contact with that address; `updated_since` returns only contacts changed at or after a time, for keeping another system in step.", "x-scope": "contacts:read", "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Cursor" }, { "name": "q", "in": "query", "required": false, "description": "Contains this text, ignoring case (1 to 100 characters).", "schema": { "type": "string", "minLength": 1, "maxLength": 100 } }, { "name": "email", "in": "query", "required": false, "description": "Exactly this email address, ignoring case.", "schema": { "type": "string", "minLength": 1, "maxLength": 254 } }, { "name": "lifecycle", "in": "query", "required": false, "description": "Only contacts at this lifecycle stage.", "schema": { "type": "string", "enum": [ "subscriber", "lead", "marketing_qualified", "sales_qualified", "opportunity", "customer", "evangelist", "other" ] } }, { "name": "updated_since", "in": "query", "required": false, "description": "Only contacts changed at or after this time: a date (YYYY-MM-DD, UTC) or an ISO-8601 date and time with a zone.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of contacts.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactList" }, "example": { "data": [ { "id": "1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f", "full_name": "Maya Lindqvist", "first_name": "Maya", "last_name": "Lindqvist", "title": "Head of Operations", "email": "maya@northwind.example", "phone": "+1 415 555 0134", "company_id": "6e5d4c3b-2a1f-4e0d-9c8b-7a6f5e4d3c2b", "status": "active", "lifecycle_stage": "sales_qualified", "lead_source": "Website form", "email_opt_out": false, "created_at": "2026-09-28T16:42:10.000Z", "updated_at": "2026-10-03T09:15:00.000Z" } ], "has_more": false, "next_cursor": null } } } }, "400": { "description": "The request is not valid.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "invalid_request", "code": "invalid_parameter", "message": "lifecycle must be one of: subscriber, lead, marketing_qualified, sales_qualified, opportunity, customer, evangelist, other.", "param": "lifecycle", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "description": "The key may not do this.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "permission", "code": "insufficient_scope", "message": "This API key does not have the contacts:read scope.", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "404": { "description": "No endpoint at that path.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "not_found", "code": "route_not_found", "message": "There is no endpoint at GET /v1/contact.", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "post": { "operationId": "createContact", "tags": [ "Contacts" ], "summary": "Create a contact", "description": "Adds a contact to Thrive and answers `201` with it. It needs a name: `full_name`, or `first_name` and `last_name`. It is unassigned (no owner) until someone in Thrive assigns it, and its history says it was created through the API.\n\n**One contact per email address.** If a contact in the account already has the address, nothing is created or changed: the answer is `409 contact_exists` with that contact's id in `resource_id`, so you can update it with PATCH. An address that belongs to someone erased from Thrive at their request is refused with `409 contact_do_not_contact`.\n\n`Idempotency-Key` is optional and recommended: a retry with the same key and the same request returns the first answer, with `Idempotent-Replay: true`, and never makes a second contact.", "x-scope": "contacts:write", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKeyOptional" } ], "requestBody": { "required": true, "description": "The contact.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateContactRequest" }, "example": { "first_name": "Maya", "last_name": "Lindqvist", "email": "maya@northwind.example", "title": "Head of Operations", "lead_source": "Website form" } } } }, "responses": { "201": { "description": "The contact was created.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Idempotent-Replay": { "$ref": "#/components/headers/Idempotent-Replay" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" }, "example": { "id": "1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f", "full_name": "Maya Lindqvist", "first_name": "Maya", "last_name": "Lindqvist", "title": "Head of Operations", "email": "maya@northwind.example", "phone": "+1 415 555 0134", "company_id": "6e5d4c3b-2a1f-4e0d-9c8b-7a6f5e4d3c2b", "status": "active", "lifecycle_stage": "sales_qualified", "lead_source": "Website form", "email_opt_out": false, "created_at": "2026-09-28T16:42:10.000Z", "updated_at": "2026-10-03T09:15:00.000Z" } } } }, "400": { "description": "The request is not valid.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "invalid_request", "code": "missing_field", "message": "A contact needs a name: full_name, or first_name and last_name.", "param": "full_name", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "description": "The key may not do this.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "permission", "code": "insufficient_scope", "message": "This API key does not have the contacts:write scope.", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "404": { "description": "Not found in this account.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "not_found", "code": "resource_not_found", "message": "No company with that id.", "param": "company_id", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "409": { "description": "A contact already has that email address, or the Idempotency-Key is busy.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "conflict", "code": "contact_exists", "message": "A contact with that email address already exists. Update it with PATCH /v1/contacts/1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f.", "param": "email", "resource_id": "1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "422": { "description": "A body field cannot be used.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "invalid_request", "code": "unknown_field", "message": "A contact takes full_name, first_name, last_name, title, email, phone, company_id, lifecycle_stage, lead_source, email_opt_out; \"owner\" is not one of them.", "param": "owner", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/contacts/{id}": { "get": { "operationId": "getContact", "tags": [ "Contacts" ], "summary": "Get a contact", "description": "One contact. A deleted (archived) contact is not found.", "x-scope": "contacts:read", "parameters": [ { "$ref": "#/components/parameters/ContactId" } ], "responses": { "200": { "description": "The contact.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" }, "example": { "id": "1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f", "full_name": "Maya Lindqvist", "first_name": "Maya", "last_name": "Lindqvist", "title": "Head of Operations", "email": "maya@northwind.example", "phone": "+1 415 555 0134", "company_id": "6e5d4c3b-2a1f-4e0d-9c8b-7a6f5e4d3c2b", "status": "active", "lifecycle_stage": "sales_qualified", "lead_source": "Website form", "email_opt_out": false, "created_at": "2026-09-28T16:42:10.000Z", "updated_at": "2026-10-03T09:15:00.000Z" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "description": "The key may not do this.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "permission", "code": "insufficient_scope", "message": "This API key does not have the contacts:read scope.", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "404": { "description": "Not found in this account.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "not_found", "code": "resource_not_found", "message": "No contact with that id.", "param": "id", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "patch": { "operationId": "updateContact", "tags": [ "Contacts" ], "summary": "Update a contact", "description": "Changes only the fields you send; every other field is left as it is. Send `null` to clear a field (not `full_name`, which a contact always has). Changing `first_name` or `last_name` does not change `full_name`: send it too if it should change. An empty body changes nothing and returns the contact.\n\nThe API cannot lift an email opt-out (`email_opt_out: false` on a contact that has opted out is `409 opt_out_locked`), and cannot change someone erased from Thrive at their request (`409 contact_do_not_contact`). Moving a contact to an email address another contact has is `409 contact_exists`.", "x-scope": "contacts:write", "parameters": [ { "$ref": "#/components/parameters/ContactId" } ], "requestBody": { "required": true, "description": "The fields to change.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateContactRequest" }, "example": { "lifecycle_stage": "customer", "title": "COO", "phone": null } } } }, "responses": { "200": { "description": "The contact, as it is now.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" }, "example": { "id": "1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f", "full_name": "Maya Lindqvist", "first_name": "Maya", "last_name": "Lindqvist", "title": "COO", "email": "maya@northwind.example", "phone": null, "company_id": "6e5d4c3b-2a1f-4e0d-9c8b-7a6f5e4d3c2b", "status": "active", "lifecycle_stage": "customer", "lead_source": "Website form", "email_opt_out": false, "created_at": "2026-09-28T16:42:10.000Z", "updated_at": "2026-10-03T09:15:00.000Z" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "description": "The key may not do this.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "permission", "code": "insufficient_scope", "message": "This API key does not have the contacts:write scope.", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "404": { "description": "Not found in this account.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "not_found", "code": "resource_not_found", "message": "No contact with that id.", "param": "id", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "409": { "description": "The change is not allowed for this contact.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "conflict", "code": "opt_out_locked", "message": "This contact has opted out of email. The API cannot opt them back in; a person can, in Thrive.", "param": "email_opt_out", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "422": { "description": "A body field cannot be used.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "invalid_request", "code": "invalid_field", "message": "Lifecycle stage must be one of: subscriber, lead, marketing_qualified, sales_qualified, opportunity, customer, evangelist, other.", "param": "lifecycle_stage", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } } } }, "components": { "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer", "bearerFormat": "vg_live_…", "description": "An API key from Account → API keys, sent as `Authorization: Bearer vg_live_…`." } }, "headers": { "X-Request-Id": { "description": "Identifies this request. Quote it to support.", "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Requests this key may make in the current minute.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current minute.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the minute ends and the count starts again.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait before trying again.", "schema": { "type": "integer" } }, "Idempotent-Replay": { "description": "`true` when this is the stored answer to an earlier request with the same `Idempotency-Key`.", "schema": { "type": "string" } } }, "parameters": { "Limit": { "name": "limit", "in": "query", "required": false, "description": "How many to return.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, "WorkflowId": { "name": "id", "in": "path", "required": true, "description": "The workflow's id.", "example": "3f6c1d2e-8a4b-4f7e-9c21-5d0e7a1b2c3d", "schema": { "type": "string", "format": "uuid" } }, "RunId": { "name": "id", "in": "path", "required": true, "description": "The run's id.", "example": "4b7e1c2d-3f5a-4b6c-8d7e-9f0a1b2c3d4e", "schema": { "type": "string", "format": "uuid" } }, "IdempotencyKey": { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique value for this run, 8 to 64 printable characters (a UUID is ideal). Send the same value again to retry safely.", "example": "6f1d2c3b-run-2026-10-03-1420", "schema": { "type": "string" } }, "IdempotencyKeyOptional": { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Optional: a unique value for this request, 8 to 64 printable characters (a UUID is ideal). Send the same value again to retry without creating a second one.", "example": "6f1d2c3b-page-2026-10-03-1420", "schema": { "type": "string" } }, "ProjectId": { "name": "id", "in": "path", "required": true, "description": "The project's id.", "example": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "schema": { "type": "string", "format": "uuid" } }, "ItemId": { "name": "id", "in": "path", "required": true, "description": "The item's id.", "example": "5d4c3b2a-1f0e-4d9c-8b7a-6e5f4d3c2b1a", "schema": { "type": "string", "format": "uuid" } }, "ContactId": { "name": "id", "in": "path", "required": true, "description": "The contact's id.", "example": "1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f", "schema": { "type": "string", "format": "uuid" } }, "Cursor": { "name": "cursor", "in": "query", "required": false, "description": "The `next_cursor` from the previous page. Leave it out for the first page.", "schema": { "type": "string" } } }, "schemas": { "Error": { "type": "object", "additionalProperties": false, "required": [ "error" ], "properties": { "error": { "type": "object", "additionalProperties": false, "required": [ "type", "code", "message", "request_id" ], "properties": { "type": { "type": "string", "enum": [ "invalid_request", "authentication", "insufficient_credit", "permission", "not_found", "conflict", "rate_limit", "api_error" ] }, "code": { "type": "string" }, "message": { "type": "string" }, "param": { "type": "string" }, "resource_id": { "type": "string", "format": "uuid", "description": "On contact_exists: the id of the contact that already has the address." }, "request_id": { "type": "string" } } } } }, "RunSummary": { "type": "object", "additionalProperties": false, "required": [ "id", "status", "at" ], "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "description": "queued, running, succeeded, failed, awaiting_approval or cancelled." }, "at": { "type": "string", "format": "date-time", "description": "When the run was created (UTC)." } } }, "Workflow": { "type": "object", "additionalProperties": false, "required": [ "id", "name", "description", "status", "project_id", "updated_at", "last_run" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "active", "paused" ] }, "project_id": { "type": [ "string", "null" ], "format": "uuid", "description": "null for a workflow not yet in a project." }, "updated_at": { "type": "string", "format": "date-time" }, "last_run": { "oneOf": [ { "$ref": "#/components/schemas/RunSummary" }, { "type": "null" } ] } } }, "StartRunRequest": { "type": "object", "additionalProperties": false, "properties": {}, "description": "No fields in v1. Any field is refused with 422 unknown_field." }, "RunStarted": { "type": "object", "additionalProperties": false, "required": [ "id", "workflow_id", "status", "trigger", "created_at" ], "properties": { "id": { "type": "string", "format": "uuid" }, "workflow_id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "queued" ] }, "trigger": { "type": "string", "enum": [ "api" ] }, "created_at": { "type": "string", "format": "date-time" } } }, "RunListItem": { "type": "object", "additionalProperties": false, "required": [ "id", "workflow_id", "status", "trigger", "summary", "created_at", "started_at", "finished_at" ], "properties": { "id": { "type": "string", "format": "uuid" }, "workflow_id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "description": "queued, running, succeeded, failed, partial, awaiting_approval, rejected or cancelled." }, "trigger": { "type": "string", "description": "How it was started: api, manual (from the hub), schedule or chat." }, "summary": { "type": "string", "description": "One line on how it went." }, "created_at": { "type": "string", "format": "date-time" }, "started_at": { "type": [ "string", "null" ], "format": "date-time" }, "finished_at": { "type": [ "string", "null" ], "format": "date-time", "description": "null until the run ends." } } }, "Run": { "type": "object", "additionalProperties": false, "required": [ "id", "workflow_id", "status", "trigger", "summary", "created_at", "started_at", "finished_at", "billed_micros", "steps" ], "properties": { "id": { "type": "string", "format": "uuid" }, "workflow_id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "description": "queued, running, succeeded, failed, partial, awaiting_approval, rejected or cancelled." }, "trigger": { "type": "string", "description": "How it was started: api, manual (from the hub), schedule or chat." }, "summary": { "type": "string", "description": "One line on how it went." }, "created_at": { "type": "string", "format": "date-time" }, "started_at": { "type": [ "string", "null" ], "format": "date-time" }, "finished_at": { "type": [ "string", "null" ], "format": "date-time", "description": "null until the run ends." }, "billed_micros": { "type": "integer", "minimum": 0, "description": "What the run has been billed so far, in micros (1,000,000 = US$1)." }, "steps": { "type": "array", "items": { "$ref": "#/components/schemas/RunStep" }, "description": "One per block, in the order they ran." } } }, "RunStep": { "type": "object", "additionalProperties": false, "required": [ "node_id", "node_kind", "status", "ms", "error" ], "properties": { "node_id": { "type": "string", "description": "The block's id in the workflow." }, "node_kind": { "type": "string", "description": "What kind of block it is." }, "status": { "type": "string", "description": "queued, running, succeeded, failed, skipped or awaiting." }, "ms": { "type": "integer", "minimum": 0, "description": "How long the block took." }, "error": { "type": [ "string", "null" ], "description": "Why the block failed, or null." } } }, "RunList": { "type": "object", "additionalProperties": false, "required": [ "data", "has_more", "next_cursor" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RunListItem" } }, "has_more": { "type": "boolean" }, "next_cursor": { "type": [ "string", "null" ] } } }, "Usage": { "type": "object", "additionalProperties": false, "required": [ "from", "to", "currency", "total_micros", "total_usd", "balance_micros", "balance_usd", "by_day", "by_feature" ], "properties": { "from": { "type": "string", "format": "date" }, "to": { "type": "string", "format": "date" }, "currency": { "type": "string", "enum": [ "usd" ] }, "total_micros": { "type": "integer", "minimum": 0, "description": "Billed in the window, in micros." }, "total_usd": { "type": "string", "description": "The same, in US dollars, rounded to the cent." }, "balance_micros": { "type": "integer", "description": "The account's prepaid balance now, in micros." }, "balance_usd": { "type": "string" }, "by_day": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "day", "micros" ], "properties": { "day": { "type": "string", "format": "date" }, "micros": { "type": "integer", "minimum": 0 } } } }, "by_feature": { "type": "array", "description": "Largest first. `feature` is the name Observability shows each line under.", "items": { "type": "object", "additionalProperties": false, "required": [ "feature", "micros" ], "properties": { "feature": { "type": "string" }, "micros": { "type": "integer", "minimum": 0 } } } } } }, "Project": { "type": "object", "additionalProperties": false, "required": [ "id", "name", "description", "archived", "created_at", "updated_at" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "archived": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "ProjectList": { "type": "object", "additionalProperties": false, "required": [ "data", "has_more", "next_cursor" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Project" } }, "has_more": { "type": "boolean" }, "next_cursor": { "type": [ "string", "null" ] } } }, "ItemListItem": { "type": "object", "additionalProperties": false, "required": [ "id", "project_id", "folder_id", "name", "kind", "ext", "size_bytes", "status", "grounding", "created_at", "updated_at" ], "properties": { "id": { "type": "string", "format": "uuid" }, "project_id": { "type": "string", "format": "uuid" }, "folder_id": { "type": [ "string", "null" ], "format": "uuid", "description": "The folder it is in, or null at the top of the project." }, "name": { "type": "string" }, "kind": { "type": "string", "description": "page, file, dataset, image or link." }, "ext": { "type": [ "string", "null" ], "description": "The file extension, such as pdf or csv; html or md for a page." }, "size_bytes": { "type": "integer", "minimum": 0 }, "status": { "type": "string", "description": "ready, queued or processing while a file is being read, or failed." }, "grounding": { "type": "boolean", "description": "Whether Chat & Research and Odin use it when answering." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "Item": { "type": "object", "additionalProperties": false, "required": [ "id", "project_id", "folder_id", "name", "kind", "ext", "size_bytes", "status", "grounding", "created_at", "updated_at", "body" ], "properties": { "id": { "type": "string", "format": "uuid" }, "project_id": { "type": "string", "format": "uuid" }, "folder_id": { "type": [ "string", "null" ], "format": "uuid", "description": "The folder it is in, or null at the top of the project." }, "name": { "type": "string" }, "kind": { "type": "string", "description": "page, file, dataset, image or link." }, "ext": { "type": [ "string", "null" ], "description": "The file extension, such as pdf or csv; html or md for a page." }, "size_bytes": { "type": "integer", "minimum": 0 }, "status": { "type": "string", "description": "ready, queued or processing while a file is being read, or failed." }, "grounding": { "type": "boolean", "description": "Whether Chat & Research and Odin use it when answering." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "body": { "oneOf": [ { "$ref": "#/components/schemas/ItemBody" }, { "type": "null" } ], "description": "A page's text; null for anything that is not a page." } } }, "ItemBody": { "type": "object", "additionalProperties": false, "required": [ "format", "content" ], "properties": { "format": { "type": "string", "enum": [ "html", "markdown" ] }, "content": { "type": "string" } } }, "ItemList": { "type": "object", "additionalProperties": false, "required": [ "data", "has_more", "next_cursor" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ItemListItem" } }, "has_more": { "type": "boolean" }, "next_cursor": { "type": [ "string", "null" ] } } }, "CreatePageRequest": { "type": "object", "additionalProperties": false, "required": [ "name", "format", "content" ], "description": "Any other field is refused with 422 unknown_field.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 300, "description": "The page's name in Data Management." }, "format": { "type": "string", "enum": [ "markdown", "html" ], "description": "What `content` is written in." }, "content": { "type": "string", "description": "The page's text. At most about 900 KB once converted to HTML (and the whole request at most 1 MB)." }, "folder_id": { "type": [ "string", "null" ], "format": "uuid", "description": "A folder in this project. Leave it out, or null, for the top of the project." } } }, "Contact": { "type": "object", "additionalProperties": false, "required": [ "id", "full_name", "first_name", "last_name", "title", "email", "phone", "company_id", "status", "lifecycle_stage", "lead_source", "email_opt_out", "created_at", "updated_at" ], "properties": { "id": { "type": "string", "format": "uuid" }, "full_name": { "type": "string" }, "first_name": { "type": [ "string", "null" ] }, "last_name": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "status": { "type": "string", "enum": [ "active", "dormant", "do_not_contact" ], "description": "`do_not_contact`: never contact them. Set in Thrive only; the API cannot change it." }, "lifecycle_stage": { "type": [ "string", "null" ] }, "lead_source": { "type": [ "string", "null" ] }, "email_opt_out": { "type": "boolean", "description": "true when they have opted out of email." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "ContactList": { "type": "object", "additionalProperties": false, "required": [ "data", "has_more", "next_cursor" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "has_more": { "type": "boolean" }, "next_cursor": { "type": [ "string", "null" ] } } }, "CreateContactRequest": { "type": "object", "additionalProperties": false, "properties": { "full_name": { "type": [ "string", "null" ], "maxLength": 200, "description": "The name shown in Thrive. On create, leave it out to make it from first_name and last_name." }, "first_name": { "type": [ "string", "null" ], "maxLength": 100, "description": "First name." }, "last_name": { "type": [ "string", "null" ], "maxLength": 100, "description": "Last name." }, "title": { "type": [ "string", "null" ], "maxLength": 200, "description": "Job title." }, "email": { "type": [ "string", "null" ], "format": "email", "maxLength": 254, "description": "Their email address. One contact per address in an account." }, "phone": { "type": [ "string", "null" ], "maxLength": 60, "description": "Phone number." }, "company_id": { "type": [ "string", "null" ], "format": "uuid", "description": "A company in Thrive in this account." }, "lifecycle_stage": { "type": [ "string", "null" ], "enum": [ "subscriber", "lead", "marketing_qualified", "sales_qualified", "opportunity", "customer", "evangelist", "other", null ], "description": "Where they are in the funnel." }, "lead_source": { "type": [ "string", "null" ], "maxLength": 80, "description": "Where they came from, in your words (at most 80 characters)." }, "email_opt_out": { "type": "boolean", "description": "true when they have opted out of email. The API can set it to true but cannot set it back to false on a contact that has opted out." } }, "description": "Needs full_name, or first_name and last_name. Any other field is refused with 422 unknown_field." }, "UpdateContactRequest": { "type": "object", "additionalProperties": false, "properties": { "full_name": { "type": [ "string", "null" ], "maxLength": 200, "description": "The name shown in Thrive. On create, leave it out to make it from first_name and last_name." }, "first_name": { "type": [ "string", "null" ], "maxLength": 100, "description": "First name." }, "last_name": { "type": [ "string", "null" ], "maxLength": 100, "description": "Last name." }, "title": { "type": [ "string", "null" ], "maxLength": 200, "description": "Job title." }, "email": { "type": [ "string", "null" ], "format": "email", "maxLength": 254, "description": "Their email address. One contact per address in an account." }, "phone": { "type": [ "string", "null" ], "maxLength": 60, "description": "Phone number." }, "company_id": { "type": [ "string", "null" ], "format": "uuid", "description": "A company in Thrive in this account." }, "lifecycle_stage": { "type": [ "string", "null" ], "enum": [ "subscriber", "lead", "marketing_qualified", "sales_qualified", "opportunity", "customer", "evangelist", "other", null ], "description": "Where they are in the funnel." }, "lead_source": { "type": [ "string", "null" ], "maxLength": 80, "description": "Where they came from, in your words (at most 80 characters)." }, "email_opt_out": { "type": "boolean", "description": "true when they have opted out of email. The API can set it to true but cannot set it back to false on a contact that has opted out." } }, "description": "Only the fields sent change; null clears one. Any other field is refused with 422 unknown_field." }, "WorkflowList": { "type": "object", "additionalProperties": false, "required": [ "data", "has_more", "next_cursor" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Workflow" } }, "has_more": { "type": "boolean" }, "next_cursor": { "type": [ "string", "null" ] } } } }, "responses": { "BadRequest": { "description": "The request is not valid.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "invalid_request", "code": "invalid_cursor", "message": "cursor is not valid", "param": "cursor", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "Unauthorized": { "description": "No valid API key.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "WWW-Authenticate": { "description": "Always `Bearer`.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "authentication", "code": "invalid_api_key", "message": "The API key is missing or not valid.", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "Forbidden": { "description": "The key may not do this.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "permission", "code": "insufficient_scope", "message": "This API key does not have the workflows:read scope.", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "NotFound": { "description": "Not found in this account.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "not_found", "code": "resource_not_found", "message": "No project with that id.", "param": "project_id", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "RateLimited": { "description": "Too many requests.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "rate_limit", "code": "rate_limited", "message": "Too many requests for this API key. Try again in 12 seconds.", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } }, "InternalError": { "description": "Something went wrong on our side.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": { "type": "api_error", "code": "internal_error", "message": "Something went wrong on our end. Please try again.", "request_id": "req_5f0c2a9e1b7d4c3a8e6f1d20" } } } } } } } }