{ "openapi": "3.0.3", "info": { "title": "Scribe Public API", "version": "v1", "description": "Public REST API for Scribe email signature management. Read-only access for AI agents, CLI tools, and automation platforms." }, "paths": { "/v1/analytics/campaigns": { "get": { "summary": "Per-campaign analytics", "tags": [ "Analytics" ], "parameters": [ { "name": "date_from", "in": "query", "required": false, "description": "Start date (YYYY-MM-DD)", "schema": { "type": "string" } }, { "name": "date_to", "in": "query", "required": false, "description": "End date (YYYY-MM-DD)", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } } ], "security": [ { "BearerApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_analytics_campaigns_collection_response" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_error_response" } } } } } } }, "/v1/analytics/countries": { "get": { "summary": "Geographic analytics breakdown", "tags": [ "Analytics" ], "parameters": [ { "name": "date_from", "in": "query", "required": false, "description": "Start date (YYYY-MM-DD)", "schema": { "type": "string" } }, { "name": "date_to", "in": "query", "required": false, "description": "End date (YYYY-MM-DD)", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } } ], "security": [ { "BearerApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_analytics_countries_collection_response" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_error_response" } } } } } } }, "/v1/analytics/overview": { "get": { "summary": "Get analytics overview", "tags": [ "Analytics" ], "parameters": [ { "name": "date_from", "in": "query", "required": false, "description": "Start date (YYYY-MM-DD)", "schema": { "type": "string" } }, { "name": "date_to", "in": "query", "required": false, "description": "End date (YYYY-MM-DD)", "schema": { "type": "string" } }, { "name": "granularity", "in": "query", "required": false, "description": "daily or hourly", "schema": { "type": "string" } } ], "security": [ { "BearerApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_analytics_overview_response" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_error_response" } } } } } } }, "/v1/analytics/signatures": { "get": { "summary": "Per-signature template analytics", "tags": [ "Analytics" ], "parameters": [ { "name": "date_from", "in": "query", "required": false, "description": "Start date (YYYY-MM-DD)", "schema": { "type": "string" } }, { "name": "date_to", "in": "query", "required": false, "description": "End date (YYYY-MM-DD)", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } } ], "security": [ { "BearerApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_analytics_signatures_collection_response" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_error_response" } } } } } } }, "/v1/analytics/teammates": { "get": { "summary": "Per-teammate analytics", "tags": [ "Analytics" ], "parameters": [ { "name": "date_from", "in": "query", "required": false, "description": "Start date (YYYY-MM-DD)", "schema": { "type": "string" } }, { "name": "date_to", "in": "query", "required": false, "description": "End date (YYYY-MM-DD)", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } } ], "security": [ { "BearerApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_analytics_teammates_collection_response" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_error_response" } } } } } } }, "/v1/anchors/{anchor_uuid}/analytics": { "get": { "summary": "Get analytics for an anchor", "tags": [ "Anchors" ], "parameters": [ { "name": "anchor_uuid", "in": "path", "required": true, "description": "Anchor UUID", "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "required": false, "description": "Start date (YYYY-MM-DD)", "schema": { "type": "string" } }, { "name": "date_to", "in": "query", "required": false, "description": "End date (YYYY-MM-DD)", "schema": { "type": "string" } }, { "name": "granularity", "in": "query", "required": false, "description": "daily or hourly", "schema": { "type": "string" } } ], "security": [ { "BearerApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_analytics_anchor_detail_response" } } } }, "404": { "description": "Anchor not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_error_response" } } } } } } }, "/v1/anchors": { "get": { "summary": "List anchors with analytics", "tags": [ "Anchors" ], "parameters": [ { "name": "date_from", "in": "query", "required": false, "description": "Start date (YYYY-MM-DD)", "schema": { "type": "string" } }, { "name": "date_to", "in": "query", "required": false, "description": "End date (YYYY-MM-DD)", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } } ], "security": [ { "BearerApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_anchor_collection_response" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_error_response" } } } } } } }, "/v1/campaigns/{campaign_uuid}/analytics": { "get": { "summary": "Get analytics for a campaign", "tags": [ "Campaigns" ], "parameters": [ { "name": "campaign_uuid", "in": "path", "required": true, "description": "Campaign UUID", "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "required": false, "description": "Start date (YYYY-MM-DD)", "schema": { "type": "string" } }, { "name": "date_to", "in": "query", "required": false, "description": "End date (YYYY-MM-DD)", "schema": { "type": "string" } }, { "name": "granularity", "in": "query", "required": false, "description": "daily or hourly", "schema": { "type": "string" } } ], "security": [ { "BearerApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_analytics_campaign_detail_response" } } } }, "404": { "description": "Campaign not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_error_response" } } } } } } }, "/v1/campaigns": { "get": { "summary": "List campaigns", "tags": [ "Campaigns" ], "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } } ], "security": [ { "BearerApiKey": [] } ], "responses": { "200": { "description": "Filtered by status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_campaign_collection_response" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_error_response" } } } } } } }, "/v1/campaigns/{uuid}": { "get": { "summary": "Get a campaign", "tags": [ "Campaigns" ], "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "BearerApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_campaign_response" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_error_response" } } } } } } }, "/v1/integration_entities": { "get": { "summary": "List integration entities", "tags": [ "Integration Entities" ], "parameters": [ { "name": "kind", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "integration_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } } ], "security": [ { "BearerApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_integration_entity_collection_response" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_error_response" } } } } } } }, "/v1/integration_entities/{uuid}": { "get": { "summary": "Get an integration entity", "tags": [ "Integration Entities" ], "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "BearerApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_integration_entity_response" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_error_response" } } } } } } }, "/v1/invoices": { "get": { "summary": "List invoices", "tags": [ "Billing" ], "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } } ], "security": [ { "BearerApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_invoice_collection_response" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_error_response" } } } } } } }, "/v1/invoices/{uuid}": { "get": { "summary": "Get an invoice", "tags": [ "Billing" ], "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "BearerApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_invoice_response" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_error_response" } } } } } } }, "/v1/signature_templates/{signature_template_uuid}/installations": { "get": { "summary": "List installations for a signature template", "tags": [ "Signature Templates" ], "parameters": [ { "name": "signature_template_uuid", "in": "path", "required": true, "description": "Signature template UUID", "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "description": "Filter by status: installed, failed, pending, uninstalled", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } } ], "security": [ { "BearerApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_installation_collection_response" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_error_response" } } } }, "404": { "description": "Template not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_error_response" } } } } } } }, "/v1/signature_templates": { "get": { "summary": "List signature templates", "tags": [ "Signature Templates" ], "parameters": [ { "name": "kind", "in": "query", "required": false, "description": "Filter by kind", "schema": { "type": "string" } }, { "name": "folder_id", "in": "query", "required": false, "description": "Filter by folder UUID", "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "description": "Search by name", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "description": "Sort field", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } } ], "security": [ { "BearerApiKey": [] } ], "responses": { "200": { "description": "Workspace scoping - cannot see other workspace data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_signature_template_collection_response" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_error_response" } } } } } } }, "/v1/signature_templates/{uuid}": { "get": { "summary": "Get a signature template", "tags": [ "Signature Templates" ], "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "BearerApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_signature_template_response" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_error_response" } } } } } } }, "/v1/smart_fields": { "get": { "summary": "List smart fields", "tags": [ "Smart Fields" ], "parameters": [ { "name": "integration_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "required", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } } ], "security": [ { "BearerApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_smart_field_collection_response" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_error_response" } } } } } } }, "/v1/smart_fields/{uuid}": { "get": { "summary": "Get a smart field", "tags": [ "Smart Fields" ], "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "BearerApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_smart_field_response" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_error_response" } } } } } } }, "/v1/subscription": { "get": { "summary": "Get subscription details", "tags": [ "Billing" ], "security": [ { "BearerApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_subscription_response" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_error_response" } } } } } } }, "/v1/teammates": { "get": { "summary": "List teammates", "tags": [ "Teammates" ], "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "integration_entity_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } } ], "security": [ { "BearerApiKey": [] } ], "responses": { "200": { "description": "Workspace scoping", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_teammate_collection_response" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_error_response" } } } } } } }, "/v1/teammates/{uuid}": { "get": { "summary": "Get a teammate", "tags": [ "Teammates" ], "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "BearerApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_teammate_response" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_error_response" } } } } } } }, "/v1/workspace": { "get": { "summary": "Get workspace details", "tags": [ "Workspace" ], "security": [ { "BearerApiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_workspace_response" } } } }, "401": { "description": "Unauthorized - revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_v1_error_response" } } } } } } } }, "servers": [ { "url": "https://api.scribe-mail.com", "description": "Production" } ], "components": { "securitySchemes": { "BearerApiKey": { "type": "http", "scheme": "bearer", "description": "API key authentication. Use your API key as the Bearer token." } }, "schemas": { "api_v1_analytics_anchor_detail_response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "anchor_analytics" ] }, "attributes": { "type": "object", "properties": { "date_from": { "type": "string" }, "date_to": { "type": "string" }, "totals": { "type": "object", "properties": { "views": { "type": "integer" }, "clicks": { "type": "integer" }, "ctr": { "type": "number" } }, "required": [ "views", "clicks", "ctr" ] }, "time_series": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string" }, "views": { "type": "integer" }, "clicks": { "type": "integer" }, "ctr": { "type": "number" } }, "required": [ "date", "views", "clicks", "ctr" ] } } }, "required": [ "date_from", "date_to", "totals", "time_series" ] } }, "required": [ "id", "type", "attributes" ] }, "meta": { "$ref": "#/components/schemas/api_v1_meta" } }, "required": [ "data", "meta" ] }, "api_v1_analytics_campaign_detail_response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "campaign_analytics" ] }, "attributes": { "type": "object", "properties": { "campaign_name": { "type": "string" }, "date_from": { "type": "string" }, "date_to": { "type": "string" }, "totals": { "type": "object", "properties": { "views": { "type": "integer" }, "clicks": { "type": "integer" }, "ctr": { "type": "number" }, "unique_clickers": { "type": "integer" } }, "required": [ "views", "clicks", "ctr", "unique_clickers" ] }, "time_series": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string" }, "views": { "type": "integer" }, "clicks": { "type": "integer" }, "ctr": { "type": "number" } }, "required": [ "date", "views", "clicks", "ctr" ] } } }, "required": [ "campaign_name", "date_from", "date_to", "totals", "time_series" ] } }, "required": [ "id", "type", "attributes" ] }, "meta": { "$ref": "#/components/schemas/api_v1_meta" } }, "required": [ "data", "meta" ] }, "api_v1_analytics_campaigns_collection_response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "campaign_analytics" ] }, "attributes": { "type": "object", "properties": { "campaign_name": { "type": "string" }, "campaign_id": { "type": "string" }, "views": { "type": "integer" }, "clicks": { "type": "integer" }, "ctr": { "type": "number" } }, "required": [ "campaign_name", "campaign_id", "views", "clicks", "ctr" ] } }, "required": [ "id", "type", "attributes" ] } }, "meta": { "$ref": "#/components/schemas/api_v1_meta" } }, "required": [ "data", "meta" ] }, "api_v1_analytics_countries_collection_response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "country_analytics" ] }, "attributes": { "type": "object", "properties": { "country_code": { "type": "string" }, "country_name": { "type": "string" }, "views": { "type": "integer" }, "clicks": { "type": "integer" }, "ctr": { "type": "number" } }, "required": [ "country_code", "country_name", "views", "clicks", "ctr" ] } }, "required": [ "id", "type", "attributes" ] } }, "meta": { "$ref": "#/components/schemas/api_v1_meta" } }, "required": [ "data", "meta" ] }, "api_v1_analytics_overview_response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "analytics_overview" ] }, "attributes": { "type": "object", "properties": { "date_from": { "type": "string" }, "date_to": { "type": "string" }, "totals": { "type": "object", "properties": { "views": { "type": "integer" }, "clicks": { "type": "integer" }, "ctr": { "type": "number" } }, "required": [ "views", "clicks", "ctr" ] }, "time_series": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string" }, "views": { "type": "integer" }, "clicks": { "type": "integer" }, "ctr": { "type": "number" } }, "required": [ "date", "views", "clicks", "ctr" ] } } }, "required": [ "date_from", "date_to", "totals", "time_series" ] } }, "required": [ "type", "attributes" ] }, "meta": { "$ref": "#/components/schemas/api_v1_meta" } }, "required": [ "data", "meta" ] }, "api_v1_analytics_signatures_collection_response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "signature_analytics" ] }, "attributes": { "type": "object", "properties": { "signature_template_name": { "type": "string" }, "signature_template_id": { "type": "string" }, "views": { "type": "integer" }, "clicks": { "type": "integer" }, "ctr": { "type": "number" } }, "required": [ "signature_template_name", "signature_template_id", "views", "clicks", "ctr" ] } }, "required": [ "id", "type", "attributes" ] } }, "meta": { "$ref": "#/components/schemas/api_v1_meta" } }, "required": [ "data", "meta" ] }, "api_v1_analytics_teammates_collection_response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "teammate_analytics" ] }, "attributes": { "type": "object", "properties": { "teammate_name": { "type": "string", "nullable": true }, "teammate_id": { "type": "string" }, "views": { "type": "integer" }, "clicks": { "type": "integer" }, "ctr": { "type": "number" } }, "required": [ "teammate_name", "teammate_id", "views", "clicks", "ctr" ] } }, "required": [ "id", "type", "attributes" ] } }, "meta": { "$ref": "#/components/schemas/api_v1_meta" } }, "required": [ "data", "meta" ] }, "api_v1_anchor_collection_response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "anchor" ] }, "attributes": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "signature_template": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "campaign": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "analytics": { "type": "object", "properties": { "views": { "type": "integer" }, "clicks": { "type": "integer" }, "ctr": { "type": "number" } }, "required": [ "views", "clicks", "ctr" ] } }, "required": [ "url", "signature_template", "campaign", "analytics" ] } }, "required": [ "id", "type", "attributes" ] } }, "meta": { "$ref": "#/components/schemas/api_v1_meta" } }, "required": [ "data", "meta" ] }, "api_v1_anchor_response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "anchor" ] }, "attributes": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "signature_template": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "campaign": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "analytics": { "type": "object", "properties": { "views": { "type": "integer" }, "clicks": { "type": "integer" }, "ctr": { "type": "number" } }, "required": [ "views", "clicks", "ctr" ] } }, "required": [ "url", "signature_template", "campaign", "analytics" ] } }, "required": [ "id", "type", "attributes" ] }, "meta": { "$ref": "#/components/schemas/api_v1_meta" } }, "required": [ "data", "meta" ] }, "api_v1_campaign_collection_response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "campaign" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string" }, "status": { "type": "string" }, "behaviour": { "type": "string", "nullable": true }, "start_time": { "type": "string", "nullable": true }, "end_time": { "type": "string", "nullable": true }, "time_zone": { "type": "string", "nullable": true }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "signature_templates_count": { "type": "integer" } }, "required": [ "name", "status", "created_at", "updated_at", "signature_templates_count" ] } }, "required": [ "id", "type", "attributes" ] } }, "meta": { "$ref": "#/components/schemas/api_v1_meta" } }, "required": [ "data", "meta" ] }, "api_v1_campaign_response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "campaign" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string" }, "status": { "type": "string" }, "behaviour": { "type": "string", "nullable": true }, "start_time": { "type": "string", "nullable": true }, "end_time": { "type": "string", "nullable": true }, "time_zone": { "type": "string", "nullable": true }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "signature_templates_count": { "type": "integer" } }, "required": [ "name", "status", "created_at", "updated_at", "signature_templates_count" ] } }, "required": [ "id", "type", "attributes" ] }, "meta": { "$ref": "#/components/schemas/api_v1_meta" } }, "required": [ "data", "meta" ] }, "api_v1_error_response": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "type", "message", "code", "request_id" ] } }, "required": [ "error" ] }, "api_v1_installation_collection_response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "installation" ] }, "attributes": { "type": "object", "properties": { "email": { "type": "object", "properties": { "address": { "type": "string", "nullable": true } }, "required": [ "address" ] }, "teammate": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "name": { "type": "string", "nullable": true } }, "required": [ "id" ] }, "email_client": { "type": "string", "nullable": true }, "device_kind": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "installed", "failed", "pending", "uninstalled" ] }, "installation_count": { "type": "integer", "nullable": true }, "first_installed_at": { "type": "string", "nullable": true }, "last_installed_at": { "type": "string", "nullable": true }, "last_failed_at": { "type": "string", "nullable": true }, "last_failed_error_code": { "type": "string", "nullable": true } }, "required": [ "email", "teammate", "status" ] } }, "required": [ "id", "type", "attributes" ] } }, "meta": { "$ref": "#/components/schemas/api_v1_meta" } }, "required": [ "data", "meta" ] }, "api_v1_integration_entity_collection_response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "integration_entity" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string" }, "kind": { "type": "string" }, "integration": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "kind": { "type": "string", "nullable": true } }, "required": [ "id" ] }, "teammates_count": { "type": "integer" }, "signature_status": { "type": "object", "properties": { "fully_installed": { "type": "integer" }, "partially_installed": { "type": "integer" }, "not_installed": { "type": "integer" } }, "required": [ "fully_installed", "partially_installed", "not_installed" ] } }, "required": [ "name", "kind", "integration", "teammates_count", "signature_status" ] } }, "required": [ "id", "type", "attributes" ] } }, "meta": { "$ref": "#/components/schemas/api_v1_meta" } }, "required": [ "data", "meta" ] }, "api_v1_integration_entity_response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "integration_entity" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string" }, "kind": { "type": "string" }, "integration": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "kind": { "type": "string", "nullable": true } }, "required": [ "id" ] }, "teammates_count": { "type": "integer" }, "signature_status": { "type": "object", "properties": { "fully_installed": { "type": "integer" }, "partially_installed": { "type": "integer" }, "not_installed": { "type": "integer" } }, "required": [ "fully_installed", "partially_installed", "not_installed" ] } }, "required": [ "name", "kind", "integration", "teammates_count", "signature_status" ] } }, "required": [ "id", "type", "attributes" ] }, "meta": { "$ref": "#/components/schemas/api_v1_meta" } }, "required": [ "data", "meta" ] }, "api_v1_invoice_collection_response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "invoice" ] }, "attributes": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "total_amount_cents": { "type": "integer", "nullable": true }, "currency": { "type": "string", "nullable": true }, "details": { "type": "object", "properties": { "line_items": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "amount_cents": { "type": "integer", "nullable": true }, "quantity": { "type": "integer", "nullable": true } } } } }, "required": [ "line_items" ] }, "period_start": { "type": "string", "nullable": true }, "period_end": { "type": "string", "nullable": true }, "created_at": { "type": "string" } }, "required": [ "status", "total_amount_cents", "currency", "details", "created_at" ] } }, "required": [ "id", "type", "attributes" ] } }, "meta": { "$ref": "#/components/schemas/api_v1_meta" } }, "required": [ "data", "meta" ] }, "api_v1_invoice_response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "invoice" ] }, "attributes": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "total_amount_cents": { "type": "integer", "nullable": true }, "currency": { "type": "string", "nullable": true }, "details": { "type": "object", "properties": { "line_items": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "amount_cents": { "type": "integer", "nullable": true }, "quantity": { "type": "integer", "nullable": true } } } } }, "required": [ "line_items" ] }, "period_start": { "type": "string", "nullable": true }, "period_end": { "type": "string", "nullable": true }, "created_at": { "type": "string" } }, "required": [ "status", "total_amount_cents", "currency", "details", "created_at" ] } }, "required": [ "id", "type", "attributes" ] }, "meta": { "$ref": "#/components/schemas/api_v1_meta" } }, "required": [ "data", "meta" ] }, "api_v1_meta": { "type": "object", "properties": { "request_id": { "type": "string" } }, "required": [ "request_id" ], "additionalProperties": true }, "api_v1_signature_template_collection_response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "signature_template" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string" }, "kind": { "type": "string" }, "accent_color": { "type": "string", "nullable": true }, "folder": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "installation_activated": { "type": "boolean" }, "assign_to_all_future_emails": { "type": "boolean" }, "show_marketing_campaigns": { "type": "boolean" }, "last_published_at": { "type": "string", "nullable": true }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "counts": { "type": "object", "properties": { "assigned_emails": { "type": "integer" }, "installed": { "type": "integer" }, "pending": { "type": "integer" }, "failed": { "type": "integer" } }, "required": [ "assigned_emails", "installed", "pending", "failed" ] } }, "required": [ "name", "kind", "folder", "installation_activated", "assign_to_all_future_emails", "show_marketing_campaigns", "created_at", "updated_at", "counts" ] } }, "required": [ "id", "type", "attributes" ] } }, "meta": { "$ref": "#/components/schemas/api_v1_meta" } }, "required": [ "data", "meta" ] }, "api_v1_signature_template_response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "signature_template" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string" }, "kind": { "type": "string" }, "accent_color": { "type": "string", "nullable": true }, "folder": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "installation_activated": { "type": "boolean" }, "assign_to_all_future_emails": { "type": "boolean" }, "show_marketing_campaigns": { "type": "boolean" }, "last_published_at": { "type": "string", "nullable": true }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "counts": { "type": "object", "properties": { "assigned_emails": { "type": "integer" }, "installed": { "type": "integer" }, "pending": { "type": "integer" }, "failed": { "type": "integer" } }, "required": [ "assigned_emails", "installed", "pending", "failed" ] } }, "required": [ "name", "kind", "folder", "installation_activated", "assign_to_all_future_emails", "show_marketing_campaigns", "created_at", "updated_at", "counts" ] } }, "required": [ "id", "type", "attributes" ] }, "meta": { "$ref": "#/components/schemas/api_v1_meta" } }, "required": [ "data", "meta" ] }, "api_v1_smart_field_collection_response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "smart_field" ] }, "attributes": { "type": "object", "properties": { "label": { "type": "string" }, "slug": { "type": "string" }, "kind": { "type": "string" }, "required": { "type": "boolean" }, "position": { "type": "integer" }, "data_source": { "type": "object", "nullable": true, "properties": { "integration_id": { "type": "string" }, "integration_kind": { "type": "string", "nullable": true }, "integration_attribute": { "type": "string", "nullable": true } }, "required": [ "integration_id" ] }, "completion": { "type": "object", "properties": { "total_teammates": { "type": "integer" }, "filled": { "type": "integer" }, "empty": { "type": "integer" }, "completion_rate": { "type": "number" } }, "required": [ "total_teammates", "filled", "empty", "completion_rate" ] } }, "required": [ "label", "slug", "kind", "required", "position", "data_source", "completion" ] } }, "required": [ "id", "type", "attributes" ] } }, "meta": { "$ref": "#/components/schemas/api_v1_meta" } }, "required": [ "data", "meta" ] }, "api_v1_smart_field_response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "smart_field" ] }, "attributes": { "type": "object", "properties": { "label": { "type": "string" }, "slug": { "type": "string" }, "kind": { "type": "string" }, "required": { "type": "boolean" }, "position": { "type": "integer" }, "data_source": { "type": "object", "nullable": true, "properties": { "integration_id": { "type": "string" }, "integration_kind": { "type": "string", "nullable": true }, "integration_attribute": { "type": "string", "nullable": true } }, "required": [ "integration_id" ] }, "completion": { "type": "object", "properties": { "total_teammates": { "type": "integer" }, "filled": { "type": "integer" }, "empty": { "type": "integer" }, "completion_rate": { "type": "number" } }, "required": [ "total_teammates", "filled", "empty", "completion_rate" ] } }, "required": [ "label", "slug", "kind", "required", "position", "data_source", "completion" ] } }, "required": [ "id", "type", "attributes" ] }, "meta": { "$ref": "#/components/schemas/api_v1_meta" } }, "required": [ "data", "meta" ] }, "api_v1_subscription_response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "subscription" ] }, "attributes": { "type": "object", "properties": { "plan": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "billing_interval": { "type": "string", "nullable": true }, "seats": { "type": "object", "properties": { "max": { "type": "integer", "nullable": true }, "used": { "type": "integer" } }, "required": [ "max", "used" ] }, "pricing": { "type": "object", "properties": { "amount_cents": { "type": "integer", "nullable": true }, "currency": { "type": "string", "nullable": true } }, "required": [ "amount_cents", "currency" ] }, "add_ons": { "type": "object", "nullable": true }, "current_period_end": { "type": "string", "nullable": true }, "cancel_at_period_end": { "type": "boolean", "nullable": true }, "payment_status": { "type": "object", "properties": { "last_payment_failed": { "type": "boolean" }, "failure_message": { "type": "string", "nullable": true } }, "required": [ "last_payment_failed", "failure_message" ] }, "created_at": { "type": "string" } }, "required": [ "plan", "status", "seats", "pricing", "payment_status", "created_at" ] } }, "required": [ "id", "type", "attributes" ] }, "meta": { "$ref": "#/components/schemas/api_v1_meta" } }, "required": [ "data", "meta" ] }, "api_v1_teammate_collection_response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "teammate" ] }, "attributes": { "type": "object", "properties": { "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "emails": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string" }, "primary": { "type": "boolean" } }, "required": [ "address", "primary" ] } }, "role": { "type": "string", "nullable": true }, "integration_entities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" } }, "required": [ "id", "name", "kind" ] } }, "signature_status": { "type": "object", "properties": { "assigned_templates": { "type": "integer" }, "installed": { "type": "integer" }, "pending": { "type": "integer" }, "failed": { "type": "integer" } }, "required": [ "assigned_templates", "installed", "pending", "failed" ] }, "smart_fields": { "type": "object" }, "created_at": { "type": "string" } }, "required": [ "first_name", "last_name", "emails", "role", "integration_entities", "signature_status", "smart_fields", "created_at" ] } }, "required": [ "id", "type", "attributes" ] } }, "meta": { "$ref": "#/components/schemas/api_v1_meta" } }, "required": [ "data", "meta" ] }, "api_v1_teammate_response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "teammate" ] }, "attributes": { "type": "object", "properties": { "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "emails": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string" }, "primary": { "type": "boolean" } }, "required": [ "address", "primary" ] } }, "role": { "type": "string", "nullable": true }, "integration_entities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" } }, "required": [ "id", "name", "kind" ] } }, "signature_status": { "type": "object", "properties": { "assigned_templates": { "type": "integer" }, "installed": { "type": "integer" }, "pending": { "type": "integer" }, "failed": { "type": "integer" } }, "required": [ "assigned_templates", "installed", "pending", "failed" ] }, "smart_fields": { "type": "object" }, "created_at": { "type": "string" } }, "required": [ "first_name", "last_name", "emails", "role", "integration_entities", "signature_status", "smart_fields", "created_at" ] } }, "required": [ "id", "type", "attributes" ] }, "meta": { "$ref": "#/components/schemas/api_v1_meta" } }, "required": [ "data", "meta" ] }, "api_v1_workspace_response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "tracking_enabled": { "type": "boolean" }, "currency_code": { "type": "string", "nullable": true }, "subscription": { "type": "object" }, "counts": { "type": "object" } }, "required": [ "name", "tracking_enabled", "counts" ] } }, "required": [ "id", "type", "attributes" ] }, "meta": { "$ref": "#/components/schemas/api_v1_meta" } }, "required": [ "data", "meta" ] } } } }