{ "openapi": "3.1.0", "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema", "info": { "title": "Adlass API", "version": "1.0.0", "description": "Scoped, tenant-isolated access to Adlass operations.", "termsOfService": "https://adlass.io/terms", "contact": { "name": "Adlass", "url": "https://developers.adlass.io" } }, "servers": [ { "url": "https://api.adlass.io/v1", "description": "Production: adl_live_ keys" }, { "url": "https://dev.adlass.io/v1", "description": "Development: adl_test_ keys" } ], "security": [ { "bearerApiKey": [] } ], "tags": [ { "name": "API keys", "description": "API keys operations." }, { "name": "Attio", "description": "Attio operations." }, { "name": "Audit", "description": "Audit operations." }, { "name": "Documents", "description": "Documents operations." }, { "name": "Email (IMAP)", "description": "Email (IMAP) operations." }, { "name": "Facturación", "description": "Facturación operations." }, { "name": "Folders", "description": "Folders operations." }, { "name": "Gmail", "description": "Gmail operations." }, { "name": "Google Drive", "description": "Google Drive operations." }, { "name": "Google Sheets", "description": "Google Sheets operations." }, { "name": "Integrations", "description": "Integrations operations." }, { "name": "Klaviyo", "description": "Klaviyo operations." }, { "name": "Meta Ads", "description": "Meta Ads operations." }, { "name": "Microsoft 365", "description": "Microsoft 365 operations." }, { "name": "MongoDB", "description": "MongoDB operations." }, { "name": "Notion", "description": "Notion operations." }, { "name": "Pages", "description": "Pages operations." }, { "name": "PostgreSQL", "description": "PostgreSQL operations." }, { "name": "Shopify", "description": "Shopify operations." }, { "name": "Skills", "description": "Skills operations." }, { "name": "Slack", "description": "Slack operations." }, { "name": "Spaces", "description": "Spaces operations." }, { "name": "Users", "description": "Users operations." }, { "name": "Webhooks", "description": "Webhooks operations." }, { "name": "Workflows", "description": "Workflows operations." } ], "x-tagGroups": [ { "name": "Spaces & Documents", "tags": [ "Spaces", "Folders", "Documents" ] }, { "name": "Skills & Workflows", "tags": [ "Skills", "Workflows" ] }, { "name": "Pages", "tags": [ "Pages" ] }, { "name": "Integrations", "tags": [ "Integrations", "Attio", "Email (IMAP)", "Facturación", "Gmail", "Google Drive", "Google Sheets", "Klaviyo", "Meta Ads", "Microsoft 365", "MongoDB", "Notion", "PostgreSQL", "Shopify", "Slack" ] }, { "name": "Account", "tags": [ "Users", "API keys" ] }, { "name": "Platform", "tags": [ "Audit", "Webhooks" ] } ], "paths": { "/spaces": { "get": { "operationId": "spacesList", "summary": "List spaces", "description": "List every Space the caller owns or has been given access to.", "tags": [ "Spaces" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "x-operation-key": "spaces.list", "x-required-scope": "spaces:read", "x-badges": [ { "name": "spaces:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpacesListResponse" }, "example": { "items": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "clerk_user_id": "user_2abcDEF", "name": "Customer documents", "storage_prefix": "tenants/acme/customer-documents/", "created_at": "2026-09-04T12:00:00Z", "role": "ADMIN", "is_owner": false, "can_read": false, "can_download": false, "can_upload": false, "can_delete": false, "can_rename": false, "document_count": 0, "member_count": 0, "skill_count": 0 } ], "next_cursor": null, "total": 0 } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "post": { "operationId": "spacesCreate", "summary": "Create a space", "description": "Create a named Space (logical data-room container) for the caller.", "tags": [ "Spaces" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "spaces.create", "x-required-scope": "spaces:write", "x-badges": [ { "name": "spaces:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "201": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpacesCreateResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "clerk_user_id": "user_2abcDEF", "name": "Customer documents", "storage_prefix": "tenants/acme/customer-documents/", "created_at": "2026-09-04T12:00:00Z", "role": "ADMIN", "is_owner": false, "can_read": false, "can_download": false, "can_upload": false, "can_delete": false, "can_rename": false, "document_count": 0, "member_count": 0, "skill_count": 0 } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpacesCreateRequest" }, "example": { "name": "Customer documents" } } } } } }, "/spaces/{space_id}": { "get": { "operationId": "spacesGet", "summary": "Get a space", "description": "Get one Space including the caller's effective permissions on it.", "tags": [ "Spaces" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "spaces.get", "x-required-scope": "spaces:read", "x-badges": [ { "name": "spaces:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpacesGetResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "clerk_user_id": "user_2abcDEF", "name": "Customer documents", "storage_prefix": "tenants/acme/customer-documents/", "created_at": "2026-09-04T12:00:00Z", "role": "ADMIN", "is_owner": false, "can_read": false, "can_download": false, "can_upload": false, "can_delete": false, "can_rename": false, "document_count": 0, "member_count": 0, "skill_count": 0 } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "patch": { "operationId": "spacesUpdate", "summary": "Rename a space", "description": "Rename a Space and relocate its stored content.", "tags": [ "Spaces" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "spaces.update", "x-required-scope": "spaces:write", "x-badges": [ { "name": "spaces:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpacesUpdateResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "clerk_user_id": "user_2abcDEF", "name": "Customer documents", "storage_prefix": "tenants/acme/customer-documents/", "created_at": "2026-09-04T12:00:00Z", "role": "ADMIN", "is_owner": false, "can_read": false, "can_download": false, "can_upload": false, "can_delete": false, "can_rename": false, "document_count": 0, "member_count": 0, "skill_count": 0 } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpacesUpdateRequest" }, "example": { "name": "Customer documents" } } } } }, "delete": { "operationId": "spacesDelete", "summary": "Delete a space", "description": "Delete a Space, its documents, folders, memberships and stored content.", "tags": [ "Spaces" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "spaces.delete", "x-required-scope": "spaces:destroy", "x-badges": [ { "name": "spaces:destroy", "position": "before" } ], "x-risk-level": "irreversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpacesDeleteResponse" }, "example": { "space_id": "123e4567-e89b-42d3-a456-426614174000", "outcome": "deleted" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/spaces/{space_id}/summary": { "get": { "operationId": "spacesSummary", "summary": "Get the space summary", "description": "Return the Space's current generated summary, if one exists.", "tags": [ "Spaces" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "spaces.summary", "x-required-scope": "spaces:read", "x-badges": [ { "name": "spaces:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpacesSummaryResponse" }, "example": { "available": false, "content": {}, "fact_count": 0, "generated_at": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/spaces/{space_id}/active-jobs": { "get": { "operationId": "spacesJobsInProgress", "summary": "List active extraction jobs", "description": "List the extraction jobs still running for documents in a Space.", "tags": [ "Spaces" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "spaces.jobs_in_progress", "x-required-scope": "spaces:read", "x-badges": [ { "name": "spaces:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpacesJobsInProgressResponse" }, "example": { "items": [ { "document_id": "123e4567-e89b-42d3-a456-426614174000", "file_name": "invoice-2026-09.pdf" } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/spaces/{space_id}/clean": { "post": { "operationId": "spacesClean", "summary": "Clean up failed documents and facts", "description": "Delete failed-extraction documents from a Space and reclaim facts-table storage (OPTIMIZE + VACUUM). Requires delete permission.", "tags": [ "Spaces" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "spaces.clean", "x-required-scope": "spaces:destroy", "x-badges": [ { "name": "spaces:destroy", "position": "before" } ], "x-risk-level": "irreversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpacesCleanResponse" }, "example": { "space_id": "123e4567-e89b-42d3-a456-426614174000", "deleted_documents": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "file_name": "invoice-2026-09.pdf", "status": "deleted" } ], "facts_rows_deleted": 0, "optimize_metrics": {}, "vacuum_files_deleted": 0 } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/spaces/{space_id}/members": { "get": { "operationId": "spacesSharesList", "summary": "List space members", "description": "List the owner, every member and every pending invite of a Space. Any member may read it; invite links are included for managers only.", "tags": [ "Spaces" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "x-operation-key": "spaces.shares_list", "x-required-scope": "spaces:read", "x-badges": [ { "name": "spaces:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpacesSharesListResponse" }, "example": { "items": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "user_id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "role": "OWNER", "can_read": false, "can_download": false, "can_upload": false, "can_delete": false, "can_rename": false, "status": "INVITED", "accept_url": "example", "invited_by": {}, "accepted_at": "2026-09-04T12:00:00Z", "last_invited_at": "2026-09-04T12:00:00Z", "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z" } ], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "post": { "operationId": "spacesShare", "summary": "Invite a member", "description": "Share a Space with someone by email and role (ADMIN/EDITOR/READER), with optional per-permission overrides. Unregistered emails get a pending invite.", "tags": [ "Spaces" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "spaces.share", "x-required-scope": "spaces:write", "x-badges": [ { "name": "spaces:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "201": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpacesShareResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "user_id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "role": "ADMIN", "can_read": false, "can_download": false, "can_upload": false, "can_delete": false, "can_rename": false, "status": "INVITED", "accept_url": "example", "invited_by": {}, "accepted_at": "2026-09-04T12:00:00Z", "last_invited_at": "2026-09-04T12:00:00Z", "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpacesShareRequest" }, "example": { "email": "developer@example.com", "role": "ADMIN" } } } } } }, "/spaces/{space_id}/members/{membership_id}": { "patch": { "operationId": "spacesShareUpdate", "summary": "Update a member's role", "description": "Change a Space member's role and/or permission overrides.", "tags": [ "Spaces" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "membership_id", "in": "path", "required": true, "description": "Resource identifier: membership_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "spaces.share_update", "x-required-scope": "spaces:write", "x-badges": [ { "name": "spaces:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpacesShareUpdateResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "user_id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "role": "ADMIN", "can_read": false, "can_download": false, "can_upload": false, "can_delete": false, "can_rename": false, "status": "INVITED", "accept_url": "example", "invited_by": {}, "accepted_at": "2026-09-04T12:00:00Z", "last_invited_at": "2026-09-04T12:00:00Z", "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpacesShareUpdateRequest" }, "example": {} } } } }, "delete": { "operationId": "spacesShareRevoke", "summary": "Remove a member", "description": "Revoke a member's access to a Space. Any member may revoke their own membership (leave); revoking someone else's requires manage permission.", "tags": [ "Spaces" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "membership_id", "in": "path", "required": true, "description": "Resource identifier: membership_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "spaces.share_revoke", "x-required-scope": "spaces:destroy", "x-badges": [ { "name": "spaces:destroy", "position": "before" } ], "x-risk-level": "irreversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpacesShareRevokeResponse" }, "example": { "space_id": "123e4567-e89b-42d3-a456-426614174000", "membership_id": "123e4567-e89b-42d3-a456-426614174000", "status": "revoked" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/spaces/{space_id}/members/{membership_id}/accept": { "post": { "operationId": "spacesShareAccept", "summary": "Accept a space invitation", "description": "Accept a pending Space-share invite addressed to the caller; grants access.", "tags": [ "Spaces" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "membership_id", "in": "path", "required": true, "description": "Resource identifier: membership_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "spaces.share_accept", "x-required-scope": "spaces:write", "x-badges": [ { "name": "spaces:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpacesShareAcceptResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "user_id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "role": "ADMIN", "can_read": false, "can_download": false, "can_upload": false, "can_delete": false, "can_rename": false, "status": "INVITED", "accept_url": "example", "invited_by": {}, "accepted_at": "2026-09-04T12:00:00Z", "last_invited_at": "2026-09-04T12:00:00Z", "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/spaces/{space_id}/members/{membership_id}/decline": { "post": { "operationId": "spacesShareDecline", "summary": "Decline a space invitation", "description": "Decline a pending Space-share invite addressed to the caller.", "tags": [ "Spaces" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "membership_id", "in": "path", "required": true, "description": "Resource identifier: membership_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "spaces.share_decline", "x-required-scope": "spaces:destroy", "x-badges": [ { "name": "spaces:destroy", "position": "before" } ], "x-risk-level": "irreversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpacesShareDeclineResponse" }, "example": { "space_id": "123e4567-e89b-42d3-a456-426614174000", "membership_id": "123e4567-e89b-42d3-a456-426614174000", "status": "declined" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/spaces/{space_id}/members/{membership_id}/resend": { "post": { "operationId": "spacesShareResend", "summary": "Resend a space invitation", "description": "Send the invite email for a pending Space membership again. Requires manage permission; at most once per minute per invite.", "tags": [ "Spaces" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "membership_id", "in": "path", "required": true, "description": "Resource identifier: membership_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "spaces.share_resend", "x-required-scope": "spaces:write", "x-badges": [ { "name": "spaces:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpacesShareResendResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "user_id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "role": "ADMIN", "can_read": false, "can_download": false, "can_upload": false, "can_delete": false, "can_rename": false, "status": "INVITED", "accept_url": "example", "invited_by": {}, "accepted_at": "2026-09-04T12:00:00Z", "last_invited_at": "2026-09-04T12:00:00Z", "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/users/me/space-invitations": { "get": { "operationId": "spacesInvitationsMine", "summary": "List my pending space invitations", "description": "List the pending Space invites addressed to the caller.", "tags": [ "Spaces" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" } ], "x-operation-key": "spaces.invitations_mine", "x-required-scope": "spaces:read", "x-badges": [ { "name": "spaces:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpacesInvitationsMineResponse" }, "example": { "items": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "space_name": "example", "role": "ADMIN", "invited_by": {}, "created_at": "2026-09-04T12:00:00Z" } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/spaces/{space_id}/folders": { "get": { "operationId": "documentsFoldersList", "summary": "List folders", "description": "List every folder in a Space with its document and sub-folder counts.", "tags": [ "Folders" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "x-operation-key": "documents.folders_list", "x-required-scope": "documents:read", "x-badges": [ { "name": "documents:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsFoldersListResponse" }, "example": { "items": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "parent_id": "123e4567-e89b-42d3-a456-426614174000", "name": "Customer documents", "path": "/", "created_at": "2026-09-04T12:00:00Z", "document_count": 0, "child_folder_count": 0 } ], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "post": { "operationId": "documentsFolderCreate", "summary": "Create a folder", "description": "Create a folder in a Space, optionally nested under a parent folder.", "tags": [ "Folders" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "documents.folder_create", "x-required-scope": "documents:write", "x-badges": [ { "name": "documents:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "201": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsFolderCreateResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "parent_id": "123e4567-e89b-42d3-a456-426614174000", "name": "Customer documents", "path": "/", "created_at": "2026-09-04T12:00:00Z", "document_count": 0, "child_folder_count": 0 } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsFolderCreateRequest" }, "example": { "name": "Customer documents" } } } } } }, "/spaces/{space_id}/folders/{folder_id}": { "patch": { "operationId": "documentsFolderRename", "summary": "Rename a folder", "description": "Rename a folder, rewriting the paths and stored object keys of everything beneath it in one atomic change.", "tags": [ "Folders" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "folder_id", "in": "path", "required": true, "description": "Resource identifier: folder_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "documents.folder_rename", "x-required-scope": "documents:write", "x-badges": [ { "name": "documents:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsFolderRenameResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "parent_id": "123e4567-e89b-42d3-a456-426614174000", "name": "Customer documents", "path": "/", "created_at": "2026-09-04T12:00:00Z", "document_count": 0, "child_folder_count": 0 } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsFolderRenameRequest" }, "example": { "name": "Customer documents" } } } } }, "delete": { "operationId": "documentsFolderDelete", "summary": "Delete a folder", "description": "Delete a folder and all its child folders and documents.", "tags": [ "Folders" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "folder_id", "in": "path", "required": true, "description": "Resource identifier: folder_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "documents.folder_delete", "x-required-scope": "documents:destroy", "x-badges": [ { "name": "documents:destroy", "position": "before" } ], "x-risk-level": "irreversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsFolderDeleteResponse" }, "example": { "folder_id": "123e4567-e89b-42d3-a456-426614174000", "outcome": "deleted" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/spaces/{space_id}/folders/{folder_id}/move": { "post": { "operationId": "documentsFolderMove", "summary": "Move a folder", "description": "Move a folder subtree to another parent in the same Space.", "tags": [ "Folders" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "folder_id", "in": "path", "required": true, "description": "Resource identifier: folder_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "documents.folder_move", "x-required-scope": "documents:write", "x-badges": [ { "name": "documents:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsFolderMoveResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "parent_id": "123e4567-e89b-42d3-a456-426614174000", "name": "Customer documents", "path": "/", "created_at": "2026-09-04T12:00:00Z", "document_count": 0, "child_folder_count": 0 } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsFolderMoveRequest" }, "example": { "parent_folder_id": "123e4567-e89b-42d3-a456-426614174000" } } } } } }, "/spaces/{space_id}/contents": { "get": { "operationId": "documentsSpaceContents", "summary": "List the space root", "description": "List the folders and documents at the root of a Space.", "tags": [ "Folders" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "documents.space_contents", "x-required-scope": "documents:read", "x-badges": [ { "name": "documents:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsSpaceContentsResponse" }, "example": { "space_id": "123e4567-e89b-42d3-a456-426614174000", "folder_id": "123e4567-e89b-42d3-a456-426614174000", "path": "/", "folders": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "parent_id": "123e4567-e89b-42d3-a456-426614174000", "name": "Customer documents", "path": "/", "created_at": "2026-09-04T12:00:00Z", "document_count": 0, "child_folder_count": 0 } ], "documents": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "tenant_id": "123e4567-e89b-42d3-a456-426614174000", "workspace_id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "folder_id": "123e4567-e89b-42d3-a456-426614174000", "uploaded_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "name": "Customer documents" }, "file_name": "invoice-2026-09.pdf", "content_type": "application/pdf", "file_size": 0, "storage_key": "tenants/acme/customer-documents/invoice-2026-09.pdf", "status": "PENDING_UPLOAD", "created_at": "2026-09-04T12:00:00Z", "doc_origin": "UPLOADED", "live_content_type": "MARKDOWN", "has_active_collab_session": false, "has_content": false } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/spaces/{space_id}/folders/{folder_id}/contents": { "get": { "operationId": "documentsFolderContents", "summary": "List folder contents", "description": "List the immediate child folders and documents of one folder.", "tags": [ "Folders" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "folder_id", "in": "path", "required": true, "description": "Resource identifier: folder_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "documents.folder_contents", "x-required-scope": "documents:read", "x-badges": [ { "name": "documents:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsFolderContentsResponse" }, "example": { "space_id": "123e4567-e89b-42d3-a456-426614174000", "folder_id": "123e4567-e89b-42d3-a456-426614174000", "path": "/", "folders": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "parent_id": "123e4567-e89b-42d3-a456-426614174000", "name": "Customer documents", "path": "/", "created_at": "2026-09-04T12:00:00Z", "document_count": 0, "child_folder_count": 0 } ], "documents": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "tenant_id": "123e4567-e89b-42d3-a456-426614174000", "workspace_id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "folder_id": "123e4567-e89b-42d3-a456-426614174000", "uploaded_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "name": "Customer documents" }, "file_name": "invoice-2026-09.pdf", "content_type": "application/pdf", "file_size": 0, "storage_key": "tenants/acme/customer-documents/invoice-2026-09.pdf", "status": "PENDING_UPLOAD", "created_at": "2026-09-04T12:00:00Z", "doc_origin": "UPLOADED", "live_content_type": "MARKDOWN", "has_active_collab_session": false, "has_content": false } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/spaces/{space_id}/browse": { "get": { "operationId": "documentsLs", "summary": "Browse a path", "description": "List a Space at a POSIX-style path. At the root it also reports the synthetic 'facts' and 'summary' directories the extraction pipeline maintains.", "tags": [ "Folders" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "path", "in": "query", "required": false, "description": "Filter or parameter: path.", "schema": { "type": "string", "default": "/" } } ], "x-operation-key": "documents.ls", "x-required-scope": "documents:read", "x-badges": [ { "name": "documents:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsLsResponse" }, "example": { "space_id": "123e4567-e89b-42d3-a456-426614174000", "path": "/", "entries": [ { "name": "Customer documents", "type": "dir", "document_id": "123e4567-e89b-42d3-a456-426614174000", "size": 0 } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/documents": { "get": { "operationId": "documentsList", "summary": "List documents", "description": "List the documents in the Spaces the caller can read, optionally filtered by Space or status.", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "query", "required": false, "description": "Filter or parameter: space_id.", "schema": { "type": "string", "format": "uuid" } }, { "name": "status", "in": "query", "required": false, "description": "Filter or parameter: status.", "schema": { "type": "string", "enum": [ "PENDING_UPLOAD", "UPLOADED", "PROCESSING", "PROCESSED", "FAILED", "ARCHIVED" ] } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "x-operation-key": "documents.list", "x-required-scope": "documents:read", "x-badges": [ { "name": "documents:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsListResponse" }, "example": { "items": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "tenant_id": "123e4567-e89b-42d3-a456-426614174000", "workspace_id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "folder_id": "123e4567-e89b-42d3-a456-426614174000", "uploaded_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "name": "Customer documents" }, "file_name": "invoice-2026-09.pdf", "content_type": "application/pdf", "file_size": 0, "storage_key": "tenants/acme/customer-documents/invoice-2026-09.pdf", "status": "PENDING_UPLOAD", "created_at": "2026-09-04T12:00:00Z", "doc_origin": "UPLOADED", "live_content_type": "MARKDOWN", "has_active_collab_session": false, "has_content": false } ], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "post": { "operationId": "documentsUploadInitiate", "summary": "Register an upload", "description": "Register a document's metadata before its bytes are uploaded. Returns the document_id needed by documents.upload_url and documents.upload_confirm.", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "documents.upload_initiate", "x-required-scope": "documents:write", "x-badges": [ { "name": "documents:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "201": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsUploadInitiateResponse" }, "example": { "document_id": "123e4567-e89b-42d3-a456-426614174000", "storage_key": "tenants/acme/customer-documents/invoice-2026-09.pdf", "status": "ACTIVE", "space_id": "123e4567-e89b-42d3-a456-426614174000", "folder_id": "123e4567-e89b-42d3-a456-426614174000" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsUploadInitiateRequest" }, "example": { "space_id": "123e4567-e89b-42d3-a456-426614174000", "file_name": "invoice-2026-09.pdf", "file_size": 0 } } } } } }, "/documents/{document_id}": { "get": { "operationId": "documentsGet", "summary": "Get a document", "description": "Get one document's metadata, including the caller's current live-collaboration mode (write/read) for it.", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "document_id", "in": "path", "required": true, "description": "Resource identifier: document_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "documents.get", "x-required-scope": "documents:read", "x-badges": [ { "name": "documents:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsGetResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "tenant_id": "123e4567-e89b-42d3-a456-426614174000", "workspace_id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "folder_id": "123e4567-e89b-42d3-a456-426614174000", "uploaded_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "name": "Customer documents" }, "file_name": "invoice-2026-09.pdf", "content_type": "application/pdf", "file_size": 0, "storage_key": "tenants/acme/customer-documents/invoice-2026-09.pdf", "status": "PENDING_UPLOAD", "created_at": "2026-09-04T12:00:00Z", "doc_origin": "UPLOADED", "live_content_type": "MARKDOWN", "has_active_collab_session": false, "has_content": false, "collab_mode": "write" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "patch": { "operationId": "documentsRename", "summary": "Rename a document", "description": "Rename a document, moving its stored object to the new name.", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "document_id", "in": "path", "required": true, "description": "Resource identifier: document_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "documents.rename", "x-required-scope": "documents:write", "x-badges": [ { "name": "documents:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsRenameResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "tenant_id": "123e4567-e89b-42d3-a456-426614174000", "workspace_id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "folder_id": "123e4567-e89b-42d3-a456-426614174000", "uploaded_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "name": "Customer documents" }, "file_name": "invoice-2026-09.pdf", "content_type": "application/pdf", "file_size": 0, "storage_key": "tenants/acme/customer-documents/invoice-2026-09.pdf", "status": "PENDING_UPLOAD", "created_at": "2026-09-04T12:00:00Z", "doc_origin": "UPLOADED", "live_content_type": "MARKDOWN", "has_active_collab_session": false, "has_content": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsRenameRequest" }, "example": { "file_name": "invoice-2026-09.pdf" } } } } }, "delete": { "operationId": "documentsDelete", "summary": "Delete a document", "description": "Delete one document and its stored object.", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "document_id", "in": "path", "required": true, "description": "Resource identifier: document_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "documents.delete", "x-required-scope": "documents:destroy", "x-badges": [ { "name": "documents:destroy", "position": "before" } ], "x-risk-level": "irreversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsDeleteResponse" }, "example": { "document_id": "123e4567-e89b-42d3-a456-426614174000", "outcome": "deleted" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/documents/{document_id}/upload-url": { "get": { "operationId": "documentsUploadUrl", "summary": "Get a presigned upload URL", "description": "Mint a fresh presigned PUT URL for a registered, not-yet-uploaded document. Call it again instead of reusing an expired URL.", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "document_id", "in": "path", "required": true, "description": "Resource identifier: document_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "documents.upload_url", "x-required-scope": "documents:read", "x-badges": [ { "name": "documents:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsUploadUrlResponse" }, "example": { "document_id": "123e4567-e89b-42d3-a456-426614174000", "presigned_url": "https://storage.example.com/invoice-2026-09.pdf?signature=example", "expires_at": "2026-09-04T12:00:00Z", "instructions_for_agent": "Upload the file with HTTP PUT to presigned_url." } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/documents/{document_id}/confirm-upload": { "post": { "operationId": "documentsUploadConfirm", "summary": "Confirm an upload", "description": "Finalize an upload once the PUT succeeded: verifies the stored object, marks the document UPLOADED and queues fact extraction.", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "document_id", "in": "path", "required": true, "description": "Resource identifier: document_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "documents.upload_confirm", "x-required-scope": "documents:write", "x-badges": [ { "name": "documents:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsUploadConfirmResponse" }, "example": { "document_id": "123e4567-e89b-42d3-a456-426614174000", "document_status": "UPLOADED", "processing_job_id": "123e4567-e89b-42d3-a456-426614174000", "processing_status": "QUEUED" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/documents/{document_id}/download": { "get": { "operationId": "documentsDownload", "summary": "Get a presigned download URL", "description": "Mint a presigned GET URL for one document. Requires download permission on the owning Space.", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "document_id", "in": "path", "required": true, "description": "Resource identifier: document_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "documents.download", "x-required-scope": "documents:read", "x-badges": [ { "name": "documents:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsDownloadResponse" }, "example": { "document_id": "123e4567-e89b-42d3-a456-426614174000", "file_name": "invoice-2026-09.pdf", "presigned_url": "https://storage.example.com/invoice-2026-09.pdf?signature=example", "instructions_for_agent": "Upload the file with HTTP PUT to presigned_url." } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/documents/bulk-download": { "post": { "operationId": "documentsDownloadBulk", "summary": "Download documents as ZIP", "description": "Assemble up to 50 documents into a ZIP in temporary storage and return a presigned URL valid for 30 minutes. The archive is a regenerable artifact — call again rather than reusing an expired URL.", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" } ], "x-operation-key": "documents.download_bulk", "x-required-scope": "documents:read", "x-badges": [ { "name": "documents:read", "position": "before" }, { "name": "External side effect" } ], "x-risk-level": "none", "x-effect": "external_side_effect", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsDownloadBulkResponse" }, "example": { "presigned_url": "https://storage.example.com/invoice-2026-09.pdf?signature=example", "zip_file_name": "adlass-documents.zip", "file_count": 0, "total_size_bytes": 0, "expires_at": "2026-09-04T12:00:00Z", "failed_document_ids": [], "instructions_for_agent": "Upload the file with HTTP PUT to presigned_url." } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsDownloadBulkRequest" }, "example": { "document_ids": [ "123e4567-e89b-42d3-a456-426614174000" ] } } } } } }, "/documents/{document_id}/move": { "post": { "operationId": "documentsMove", "summary": "Move a document", "description": "Move a document into another folder of the same Space, relocating its stored object so path and metadata stay consistent.", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "document_id", "in": "path", "required": true, "description": "Resource identifier: document_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "documents.move", "x-required-scope": "documents:write", "x-badges": [ { "name": "documents:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsMoveResponse" }, "example": { "document_id": "123e4567-e89b-42d3-a456-426614174000", "file_name": "invoice-2026-09.pdf", "new_storage_key": "tenants/acme/customer-documents/archive/invoice-2026-09.pdf", "destination_folder_id": "123e4567-e89b-42d3-a456-426614174000" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsMoveRequest" }, "example": {} } } } } }, "/documents/bulk-move": { "post": { "operationId": "documentsBulkMove", "summary": "Move documents", "description": "Move many documents into one folder, relocating each stored object.", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "documents.bulk_move", "x-required-scope": "documents:write", "x-badges": [ { "name": "documents:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsBulkMoveResponse" }, "example": { "moved_count": 0, "failed_document_ids": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsBulkMoveRequest" }, "example": { "document_ids": [ "123e4567-e89b-42d3-a456-426614174000" ] } } } } } }, "/documents/bulk-delete": { "post": { "operationId": "documentsBulkDelete", "summary": "Delete documents", "description": "Delete many documents and their stored objects in one request.", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "documents.bulk_delete", "x-required-scope": "documents:destroy", "x-badges": [ { "name": "documents:destroy", "position": "before" } ], "x-risk-level": "irreversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsBulkDeleteResponse" }, "example": { "deleted_count": 0, "failed_document_ids": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsBulkDeleteRequest" }, "example": { "document_ids": [ "123e4567-e89b-42d3-a456-426614174000" ] } } } } } }, "/documents/live": { "post": { "operationId": "documentsLiveCreate", "summary": "Create a live document", "description": "Create a live-collaboration document, sheet, or database (task board). Its content lives in the CRDT and is edited with documents.live_edit (documents/sheets), documents.database_row_* (databases), or the collab WebSocket. Markdown documents accept optional initial content; databases start with a task-board template schema.", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "documents.live_create", "x-required-scope": "documents:write", "x-badges": [ { "name": "documents:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "201": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsLiveCreateResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "tenant_id": "123e4567-e89b-42d3-a456-426614174000", "workspace_id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "folder_id": "123e4567-e89b-42d3-a456-426614174000", "uploaded_by": {}, "file_name": "invoice-2026-09.pdf", "content_type": "application/pdf", "file_size": 0, "storage_key": "tenants/acme/customer-documents/invoice-2026-09.pdf", "status": "ACTIVE", "created_at": "2026-09-04T12:00:00Z", "doc_origin": "example", "live_content_type": "example", "has_active_collab_session": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsLiveCreateRequest" }, "example": { "space_id": "123e4567-e89b-42d3-a456-426614174000", "file_name": "invoice-2026-09.pdf", "content_type": "application/vnd.adlass.live-document" } } } } } }, "/documents/{document_id}/content": { "get": { "operationId": "documentsLiveRead", "summary": "Read live content", "description": "Read a live document's current merged content plus the content_hash to pass back as expected_content_hash when editing it.", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "document_id", "in": "path", "required": true, "description": "Resource identifier: document_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "documents.live_read", "x-required-scope": "documents:read", "x-badges": [ { "name": "documents:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsLiveReadResponse" }, "example": { "document_id": "123e4567-e89b-42d3-a456-426614174000", "file_name": "invoice-2026-09.pdf", "live_content_type": "MARKDOWN", "content_hash": "3f786850e387550fdab836ed7e6dc881de23001b" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "patch": { "operationId": "documentsLiveEdit", "summary": "Edit live content", "description": "Change a live document's content and fan the change out to everyone currently editing it. Markdown documents take 'content'; sheets take 'cells' and/or 'row_order'; live databases are rejected — mutate them with the documents.database_row_* operations. Pass expected_content_hash from documents.live_read to be rejected with live_edit_conflict instead of overwriting a concurrent change. Browser keystrokes reach the server with up to ~2s delay, so they can be invisible to the hash check; the CRDT still merges them conflict-free.", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "document_id", "in": "path", "required": true, "description": "Resource identifier: document_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "documents.live_edit", "x-required-scope": "documents:write", "x-badges": [ { "name": "documents:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsLiveEditResponse" }, "example": { "document_id": "123e4567-e89b-42d3-a456-426614174000", "content_hash": "3f786850e387550fdab836ed7e6dc881de23001b", "changed": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsLiveEditRequest" }, "example": {} } } } } }, "/documents/{document_id}/content/save": { "post": { "operationId": "documentsLiveSave", "summary": "Save live content", "description": "Consolidate a live document's pending edits into a durable snapshot, export it to storage and enqueue fact re-extraction (the extraction itself runs asynchronously). Use a fresh idempotency_key per save.", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "document_id", "in": "path", "required": true, "description": "Resource identifier: document_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "documents.live_save", "x-required-scope": "documents:write", "x-badges": [ { "name": "documents:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsLiveSaveResponse" }, "example": { "document_id": "123e4567-e89b-42d3-a456-426614174000", "saved_at": "2026-09-04T12:00:00Z", "extraction_requested": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/documents/{document_id}/rows": { "get": { "operationId": "documentsDatabaseRead", "summary": "Read database rows", "description": "Read a live-database document (e.g. a task board): its property schema, views, all rows, and the content_hash to pass back as expected_content_hash when mutating rows.", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "document_id", "in": "path", "required": true, "description": "Resource identifier: document_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "documents.database_read", "x-required-scope": "documents:read", "x-badges": [ { "name": "documents:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsDatabaseReadResponse" }, "example": { "document_id": "123e4567-e89b-42d3-a456-426614174000", "file_name": "invoice-2026-09.pdf", "content_hash": "3f786850e387550fdab836ed7e6dc881de23001b", "schema": {}, "views": {}, "rows": {} } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "post": { "operationId": "documentsDatabaseRowCreate", "summary": "Create a database row", "description": "Create a row (e.g. a task) in a live-database document and fan it out to everyone currently viewing the board. Read the database first for valid property ids and select options.", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "document_id", "in": "path", "required": true, "description": "Resource identifier: document_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "documents.database_row_create", "x-required-scope": "documents:write", "x-badges": [ { "name": "documents:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "201": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsDatabaseRowCreateResponse" }, "example": { "document_id": "123e4567-e89b-42d3-a456-426614174000", "content_hash": "3f786850e387550fdab836ed7e6dc881de23001b", "changed": false, "row_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsDatabaseRowCreateRequest" }, "example": { "cells": {} } } } } } }, "/documents/{document_id}/rows/{row_id}": { "patch": { "operationId": "documentsDatabaseRowUpdate", "summary": "Update a database row", "description": "Update cells of a row in a live-database document, e.g. move a task to another status column via {\"status\": \"done\"}. Setting a cell to null clears it.", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "document_id", "in": "path", "required": true, "description": "Resource identifier: document_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "row_id", "in": "path", "required": true, "description": "Resource identifier: row_id.", "schema": { "type": "string", "maxLength": 64 }, "example": "example" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "documents.database_row_update", "x-required-scope": "documents:write", "x-badges": [ { "name": "documents:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsDatabaseRowUpdateResponse" }, "example": { "document_id": "123e4567-e89b-42d3-a456-426614174000", "content_hash": "3f786850e387550fdab836ed7e6dc881de23001b", "changed": false, "row_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsDatabaseRowUpdateRequest" }, "example": { "cells": {} } } } } }, "delete": { "operationId": "documentsDatabaseRowDelete", "summary": "Delete a database row", "description": "Delete a row from a live-database document.", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "document_id", "in": "path", "required": true, "description": "Resource identifier: document_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "row_id", "in": "path", "required": true, "description": "Resource identifier: row_id.", "schema": { "type": "string", "maxLength": 64 }, "example": "example" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "documents.database_row_delete", "x-required-scope": "documents:destroy", "x-badges": [ { "name": "documents:destroy", "position": "before" } ], "x-risk-level": "irreversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsDatabaseRowDeleteResponse" }, "example": { "document_id": "123e4567-e89b-42d3-a456-426614174000", "content_hash": "3f786850e387550fdab836ed7e6dc881de23001b", "changed": false, "row_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsDatabaseRowDeleteRequest" }, "example": {} } } } } }, "/spaces/{space_id}/facts": { "get": { "operationId": "documentsFactsRead", "summary": "List extracted facts", "description": "Read a Space's extracted facts page by page, with the current summary, the failed extractions and the extractions still in progress. Never errors while extraction is running.", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "keyword", "in": "query", "required": false, "description": "Optional keyword filter", "schema": { "type": "string", "description": "Optional keyword filter" } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } } ], "x-operation-key": "documents.facts_read", "x-required-scope": "documents:read", "x-badges": [ { "name": "documents:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsFactsReadResponse" }, "example": { "space_id": "123e4567-e89b-42d3-a456-426614174000", "facts": [ { "key": "invoice_total", "value": "1250.00", "confidence": 0.98, "source_field": "total", "metadata": { "document_id": "123e4567-e89b-42d3-a456-426614174001", "file_name": "invoice-2026-09.pdf" }, "lastupdate": "2026-09-04T12:00:00Z" } ], "total_facts": 1, "offset": 0, "limit": 50, "failed_extractions": [], "in_progress": [], "summary": { "available": false, "content": null, "fact_count": null, "generated_at": null }, "items": [], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/spaces/{space_id}/facts/search": { "post": { "operationId": "documentsFactsGrep", "summary": "Search facts", "description": "Search a Space's extracted facts by relevance (BM25) or, with regex=true, by regular expression. Returns an empty result list rather than an error when nothing matches.", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "documents.facts_grep", "x-required-scope": "documents:read", "x-badges": [ { "name": "documents:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsFactsGrepResponse" }, "example": { "space_id": "123e4567-e89b-42d3-a456-426614174000", "pattern": "invoice", "regex": false, "results": [ { "key": "invoice_total", "value": "1250.00", "confidence": 0.98, "source_field": "total", "metadata": { "document_id": "123e4567-e89b-42d3-a456-426614174001", "file_name": "invoice-2026-09.pdf" }, "lastupdate": "2026-09-04T12:00:00Z" } ], "total_returned": 1 } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsFactsGrepRequest" }, "example": { "pattern": "example" } } } } } }, "/documents/{document_id}/facts": { "get": { "operationId": "documentsFactsCat", "summary": "Get a document's facts", "description": "Return every extracted fact belonging to one document. Reports status='no_facts' rather than an error when nothing has been extracted yet.", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "document_id", "in": "path", "required": true, "description": "Resource identifier: document_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "documents.facts_cat", "x-required-scope": "documents:read", "x-badges": [ { "name": "documents:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsFactsCatResponse" }, "example": { "document_id": "123e4567-e89b-42d3-a456-426614174000", "file_name": "invoice-2026-09.pdf", "status": "success", "facts": [ { "key": "invoice_total", "value": "1250.00", "confidence": 0.98 } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/processing-jobs": { "get": { "operationId": "documentsJobsList", "summary": "List extraction jobs", "description": "List extraction jobs for the tenant's documents, newest first. Pass document_id to see only the jobs of one document.", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "document_id", "in": "query", "required": false, "description": "Filter or parameter: document_id.", "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "x-operation-key": "documents.jobs_list", "x-required-scope": "documents:read", "x-badges": [ { "name": "documents:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsJobsListResponse" }, "example": { "items": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "document_id": "123e4567-e89b-42d3-a456-426614174000", "job_type": "example", "status": "QUEUED", "celery_task_id": "example", "started_at": "2026-09-04T12:00:00Z", "completed_at": "2026-09-04T12:00:00Z", "error_message": "example" } ], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/processing-jobs/{job_id}": { "get": { "operationId": "documentsJobsGet", "summary": "Get an extraction job", "description": "Get one extraction job by id.", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "job_id", "in": "path", "required": true, "description": "Resource identifier: job_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "documents.jobs_get", "x-required-scope": "documents:read", "x-badges": [ { "name": "documents:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsJobsGetResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "document_id": "123e4567-e89b-42d3-a456-426614174000", "job_type": "example", "status": "QUEUED", "celery_task_id": "example", "started_at": "2026-09-04T12:00:00Z", "completed_at": "2026-09-04T12:00:00Z", "error_message": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/skills": { "get": { "operationId": "skillsSearch", "summary": "List skills", "description": "Search public Skill templates and Skills owned by the current tenant.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "query", "in": "query", "required": false, "description": "Name or summary text", "schema": { "type": "string", "description": "Name or summary text" } }, { "name": "space_id", "in": "query", "required": false, "description": "Scope run statistics and automation flags to one Space", "schema": { "type": "string", "format": "uuid", "description": "Scope run statistics and automation flags to one Space" } }, { "name": "kind", "in": "query", "required": false, "description": "Only Skills of this kind; omit for all", "schema": { "type": "string", "enum": [ "PLATFORM", "AGENT" ], "description": "Only Skills of this kind; omit for all" } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "x-operation-key": "skills.search", "x-required-scope": "skills:read", "x-badges": [ { "name": "skills:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsSearchResponse" }, "example": { "items": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "slug": "customer-documents", "kind": "PLATFORM", "name": "Customer documents", "summary": "Extracts totals and due dates from supplier invoices.", "status": "ACTIVE", "visibility": "PRIVATE", "categories": [], "tags": [], "is_template": false, "current_version": 0, "has_draft": false, "draft_revision": 0, "draft_updated_at": "2026-09-04T12:00:00Z", "created_by_id": "123e4567-e89b-42d3-a456-426614174000", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "access_mode": "example", "share_count": 0, "access": { "share_role": "example", "is_creator": false, "access_mode": "example", "can_view": false, "can_run": false, "can_edit": false, "can_share": false, "can_archive": false }, "updated_at": "2026-09-04T12:00:00Z", "run_count": 0, "total_cost_micro_usd": 0, "total_micro_credits": 0, "last_run_at": "2026-09-04T12:00:00Z", "automation_active": false } ], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "post": { "operationId": "skillsCreate", "summary": "Create a skill", "description": "Create a tenant-owned Skill draft, either from a template or from an explicit draft (template_id and draft are mutually exclusive). Returns the caller's existing unsaved draft if one exists.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "skills.create", "x-required-scope": "skills:write", "x-badges": [ { "name": "skills:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "201": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsCreateResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "slug": "customer-documents", "kind": "PLATFORM", "name": "Customer documents", "summary": "Extracts totals and due dates from supplier invoices.", "status": "ACTIVE", "visibility": "PRIVATE", "categories": [], "tags": [], "is_template": false, "current_version": 0, "has_draft": false, "draft_revision": 0, "draft_updated_at": "2026-09-04T12:00:00Z", "created_by_id": "123e4567-e89b-42d3-a456-426614174000", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "access_mode": "example", "share_count": 0, "access": { "share_role": "example", "is_creator": false, "access_mode": "example", "can_view": false, "can_run": false, "can_edit": false, "can_share": false, "can_archive": false }, "updated_at": "2026-09-04T12:00:00Z", "version": { "id": "123e4567-e89b-42d3-a456-426614174000", "version": 0, "definition": {}, "content_hash": "3f786850e387550fdab836ed7e6dc881de23001b", "change_note": "Initial version", "created_at": "2026-09-04T12:00:00Z" }, "draft": {} } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsCreateRequest" }, "example": {} } } } } }, "/skills/{skill_id}": { "get": { "operationId": "skillsGet", "summary": "Get a skill", "description": "Get one Skill with its active version definition and current draft.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "skill_id", "in": "path", "required": true, "description": "Resource identifier: skill_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "skills.get", "x-required-scope": "skills:read", "x-badges": [ { "name": "skills:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsGetResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "slug": "customer-documents", "kind": "PLATFORM", "name": "Customer documents", "summary": "Extracts totals and due dates from supplier invoices.", "status": "ACTIVE", "visibility": "PRIVATE", "categories": [], "tags": [], "is_template": false, "current_version": 0, "has_draft": false, "draft_revision": 0, "draft_updated_at": "2026-09-04T12:00:00Z", "created_by_id": "123e4567-e89b-42d3-a456-426614174000", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "access_mode": "example", "share_count": 0, "access": { "share_role": "example", "is_creator": false, "access_mode": "example", "can_view": false, "can_run": false, "can_edit": false, "can_share": false, "can_archive": false }, "updated_at": "2026-09-04T12:00:00Z", "version": { "id": "123e4567-e89b-42d3-a456-426614174000", "version": 0, "definition": {}, "content_hash": "3f786850e387550fdab836ed7e6dc881de23001b", "change_note": "Initial version", "created_at": "2026-09-04T12:00:00Z" }, "draft": {} } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "patch": { "operationId": "skillsRename", "summary": "Rename a skill", "description": "Rename a tenant-owned Skill without creating a new version.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "skill_id", "in": "path", "required": true, "description": "Resource identifier: skill_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "skills.rename", "x-required-scope": "skills:write", "x-badges": [ { "name": "skills:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsRenameResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "slug": "customer-documents", "kind": "PLATFORM", "name": "Customer documents", "summary": "Extracts totals and due dates from supplier invoices.", "status": "ACTIVE", "visibility": "PRIVATE", "categories": [], "tags": [], "is_template": false, "current_version": 0, "has_draft": false, "draft_revision": 0, "draft_updated_at": "2026-09-04T12:00:00Z", "created_by_id": "123e4567-e89b-42d3-a456-426614174000", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "access_mode": "example", "share_count": 0, "access": { "share_role": "example", "is_creator": false, "access_mode": "example", "can_view": false, "can_run": false, "can_edit": false, "can_share": false, "can_archive": false }, "updated_at": "2026-09-04T12:00:00Z", "version": { "id": "123e4567-e89b-42d3-a456-426614174000", "version": 0, "definition": {}, "content_hash": "3f786850e387550fdab836ed7e6dc881de23001b", "change_note": "Initial version", "created_at": "2026-09-04T12:00:00Z" }, "draft": {} } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsRenameRequest" }, "example": { "name": "Customer documents" } } } } }, "delete": { "operationId": "skillsDelete", "summary": "Delete a skill", "description": "Delete a tenant-owned Skill with its versions, automations and Space installations. Fails with 409 while runs of the Skill exist.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "skill_id", "in": "path", "required": true, "description": "Resource identifier: skill_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "skills.delete", "x-required-scope": "skills:destroy", "x-badges": [ { "name": "skills:destroy", "position": "before" } ], "x-risk-level": "irreversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsDeleteResponse" }, "example": { "outcome": "deleted" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/skills/{skill_id}/draft": { "put": { "operationId": "skillsDraftSave", "summary": "Save the skill draft", "description": "Store the working copy of a tenant-owned Skill without creating a version. Rejects stale revisions with 409.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "skill_id", "in": "path", "required": true, "description": "Resource identifier: skill_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "skills.draft.save", "x-required-scope": "skills:write", "x-badges": [ { "name": "skills:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsDraftSaveResponse" }, "example": { "skill_id": "123e4567-e89b-42d3-a456-426614174000", "draft_revision": 0, "draft_updated_at": "2026-09-04T12:00:00Z" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsDraftSaveRequest" }, "example": { "expected_revision": 0, "draft": {} } } } } }, "delete": { "operationId": "skillsDraftDiscard", "summary": "Discard the skill draft", "description": "Drop the working copy of an active Skill; the active version stays.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "skill_id", "in": "path", "required": true, "description": "Resource identifier: skill_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "skills.draft.discard", "x-required-scope": "skills:write", "x-badges": [ { "name": "skills:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsDraftDiscardResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "slug": "customer-documents", "kind": "PLATFORM", "name": "Customer documents", "summary": "Extracts totals and due dates from supplier invoices.", "status": "ACTIVE", "visibility": "PRIVATE", "categories": [], "tags": [], "is_template": false, "current_version": 0, "has_draft": false, "draft_revision": 0, "draft_updated_at": "2026-09-04T12:00:00Z", "created_by_id": "123e4567-e89b-42d3-a456-426614174000", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "access_mode": "example", "share_count": 0, "access": { "share_role": "example", "is_creator": false, "access_mode": "example", "can_view": false, "can_run": false, "can_edit": false, "can_share": false, "can_archive": false }, "updated_at": "2026-09-04T12:00:00Z", "version": { "id": "123e4567-e89b-42d3-a456-426614174000", "version": 0, "definition": {}, "content_hash": "3f786850e387550fdab836ed7e6dc881de23001b", "change_note": "Initial version", "created_at": "2026-09-04T12:00:00Z" }, "draft": {} } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsDraftDiscardRequest" }, "example": { "expected_revision": 0 } } } } } }, "/skills/{skill_id}/versions": { "get": { "operationId": "skillsVersions", "summary": "List skill versions", "description": "List every immutable version of one Skill, newest first.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "skill_id", "in": "path", "required": true, "description": "Resource identifier: skill_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "x-operation-key": "skills.versions", "x-required-scope": "skills:read", "x-badges": [ { "name": "skills:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsVersionsResponse" }, "example": { "items": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "version": 0, "definition": {}, "content_hash": "3f786850e387550fdab836ed7e6dc881de23001b", "change_note": "Initial version", "created_at": "2026-09-04T12:00:00Z" } ], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "post": { "operationId": "skillsSave", "summary": "Publish a skill version", "description": "Validate the Skill and store it as a new immutable version that is active immediately. Clears the working copy.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "skill_id", "in": "path", "required": true, "description": "Resource identifier: skill_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "skills.save", "x-required-scope": "skills:write", "x-badges": [ { "name": "skills:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "201": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsSaveResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "slug": "customer-documents", "kind": "PLATFORM", "name": "Customer documents", "summary": "Extracts totals and due dates from supplier invoices.", "status": "ACTIVE", "visibility": "PRIVATE", "categories": [], "tags": [], "is_template": false, "current_version": 0, "has_draft": false, "draft_revision": 0, "draft_updated_at": "2026-09-04T12:00:00Z", "created_by_id": "123e4567-e89b-42d3-a456-426614174000", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "access_mode": "example", "share_count": 0, "access": { "share_role": "example", "is_creator": false, "access_mode": "example", "can_view": false, "can_run": false, "can_edit": false, "can_share": false, "can_archive": false }, "updated_at": "2026-09-04T12:00:00Z", "version": { "id": "123e4567-e89b-42d3-a456-426614174000", "version": 0, "definition": {}, "content_hash": "3f786850e387550fdab836ed7e6dc881de23001b", "change_note": "Initial version", "created_at": "2026-09-04T12:00:00Z" }, "draft": {} } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsSaveRequest" }, "example": { "expected_revision": 0, "name": "Customer documents", "summary": "Extracts totals and due dates from supplier invoices.", "definition": { "instructions": "example", "capabilities": [], "outputs": [ { "key": "summary", "type": "doc", "nameTemplate": "example", "mode": "new" } ] } } } } } } }, "/skills/{skill_id}/versions/{version}/restore": { "post": { "operationId": "skillsRestore", "summary": "Restore a skill version", "description": "Create a new active version from the definition of an earlier version. Drops any working copy.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "skill_id", "in": "path", "required": true, "description": "Resource identifier: skill_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "version", "in": "path", "required": true, "description": "Resource identifier: version.", "schema": { "type": "integer", "minimum": 1 }, "example": 1 }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "skills.restore", "x-required-scope": "skills:write", "x-badges": [ { "name": "skills:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsRestoreResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "slug": "customer-documents", "kind": "PLATFORM", "name": "Customer documents", "summary": "Extracts totals and due dates from supplier invoices.", "status": "ACTIVE", "visibility": "PRIVATE", "categories": [], "tags": [], "is_template": false, "current_version": 0, "has_draft": false, "draft_revision": 0, "draft_updated_at": "2026-09-04T12:00:00Z", "created_by_id": "123e4567-e89b-42d3-a456-426614174000", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "access_mode": "example", "share_count": 0, "access": { "share_role": "example", "is_creator": false, "access_mode": "example", "can_view": false, "can_run": false, "can_edit": false, "can_share": false, "can_archive": false }, "updated_at": "2026-09-04T12:00:00Z", "version": { "id": "123e4567-e89b-42d3-a456-426614174000", "version": 0, "definition": {}, "content_hash": "3f786850e387550fdab836ed7e6dc881de23001b", "change_note": "Initial version", "created_at": "2026-09-04T12:00:00Z" }, "draft": {} } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/spaces/{space_id}/skills/{skill_id}/automation": { "get": { "operationId": "skillsAutomationGet", "summary": "Get skill automation", "description": "Get the schedule (recurring or one-off), platform-event trigger, stored run request and firing status of a Skill in a Space.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "skill_id", "in": "path", "required": true, "description": "Resource identifier: skill_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "skills.automation.get", "x-required-scope": "skills:read", "x-badges": [ { "name": "skills:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsAutomationGetResponse" }, "example": { "schedule": null, "event": null, "run": null, "status": { "schedule": null, "event": null } } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "put": { "operationId": "skillsAutomationSet", "summary": "Configure skill automation", "description": "Replace the schedule, platform-event trigger and stored run request of a Skill in a Space. Automated runs execute on behalf of the caller.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "skill_id", "in": "path", "required": true, "description": "Resource identifier: skill_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "skills.automation.set", "x-required-scope": "skills:write", "x-badges": [ { "name": "skills:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsAutomationSetResponse" }, "example": { "schedule": { "cron": "0 8 * * 1", "timezone": "Europe/Berlin", "active": true }, "event": null, "run": { "inputs": {}, "scope": { "include_all_processed_documents": true } }, "status": { "schedule": { "active": true, "next_fire_at": "2026-09-04T12:00:00Z" }, "event": null } } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsAutomationSetRequest" }, "example": { "schedule": { "kind": "cron", "timezone": "example", "active": false }, "event": { "event_type": "example", "entity_id": "123e4567-e89b-42d3-a456-426614174000", "severity": "info", "filters": [], "active": false }, "run": { "inputs": {}, "scope": {} } } } } } } }, "/spaces/{space_id}/skill-bindings": { "get": { "operationId": "skillsIntegrationBindingsList", "summary": "List integration bindings", "description": "List the current user's personal integration bindings in a Space and, for one Skill, every logical requirement with its binding status.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "skill_id", "in": "query", "required": false, "description": "Filter or parameter: skill_id.", "schema": { "type": "string", "format": "uuid" } } ], "x-operation-key": "skills.integration_bindings.list", "x-required-scope": "skills:read", "x-badges": [ { "name": "skills:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsIntegrationBindingsListResponse" }, "example": { "items": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "skill_id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "requirement_key": "example", "provider_key": "klaviyo", "grant_id": "123e4567-e89b-42d3-a456-426614174000", "connection_id": "123e4567-e89b-42d3-a456-426614174000", "connection_label": "example", "allowed_operations": [], "active": false } ], "requirements": [ { "key": "summary", "provider_key": "klaviyo", "operations": [], "binding": {} } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/spaces/{space_id}/skills/{skill_id}/bindings/{requirement_key}": { "put": { "operationId": "skillsIntegrationBindingsSet", "summary": "Bind an integration to a skill", "description": "Bind one logical Skill requirement to one of your own active Space grants. Definitions never store this choice; it is personal to you.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "skill_id", "in": "path", "required": true, "description": "Resource identifier: skill_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "requirement_key", "in": "path", "required": true, "description": "Resource identifier: requirement_key.", "schema": { "type": "string", "maxLength": 80 }, "example": "example" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "skills.integration_bindings.set", "x-required-scope": "skills:write", "x-badges": [ { "name": "skills:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsIntegrationBindingsSetResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "skill_id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "requirement_key": "example", "provider_key": "klaviyo", "grant_id": "123e4567-e89b-42d3-a456-426614174000", "connection_id": "123e4567-e89b-42d3-a456-426614174000", "connection_label": "example", "allowed_operations": [], "active": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsIntegrationBindingsSetRequest" }, "example": { "grant_id": "123e4567-e89b-42d3-a456-426614174000" } } } } } }, "/skill-bindings/{binding_id}": { "delete": { "operationId": "skillsIntegrationBindingsRevoke", "summary": "Remove an integration binding", "description": "Revoke one of your personal Skill integration bindings.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "binding_id", "in": "path", "required": true, "description": "Resource identifier: binding_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "skills.integration_bindings.revoke", "x-required-scope": "skills:write", "x-badges": [ { "name": "skills:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsIntegrationBindingsRevokeResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "skill_id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "requirement_key": "example", "provider_key": "klaviyo", "grant_id": "123e4567-e89b-42d3-a456-426614174000", "connection_id": "123e4567-e89b-42d3-a456-426614174000", "connection_label": "example", "allowed_operations": [], "active": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/ai-models": { "get": { "operationId": "skillsModels", "summary": "List AI models", "description": "List the AI models available for Skill runs.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" } ], "x-operation-key": "skills.models", "x-required-scope": "skills:read", "x-badges": [ { "name": "skills:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsModelsResponse" }, "example": { "items": [ { "id": "claude-sonnet-5", "label": "Claude Sonnet 5", "provider": "anthropic", "efforts": [ "low", "medium", "high" ], "default_effort": "medium", "context_window": 200000, "web_search": true } ], "default_model": "claude-sonnet-5" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/spaces/{space_id}/record-types": { "get": { "operationId": "recordsTypes", "summary": "List record types", "description": "List the record types defined in a Space.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "records.types", "x-required-scope": "skills:read", "x-badges": [ { "name": "skills:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordsTypesResponse" }, "example": { "items": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/spaces/{space_id}/mailbox-connections": { "get": { "operationId": "mailboxConnections", "summary": "List mailbox connections", "description": "List the mailbox connections available to a Space.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "mailbox.connections", "x-required-scope": "skills:read", "x-badges": [ { "name": "skills:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailboxConnectionsResponse" }, "example": { "items": [ { "grant_id": "123e4567-e89b-42d3-a456-426614174000", "connection_id": "123e4567-e89b-42d3-a456-426614174001", "provider_key": "imap", "label": "Support mailbox", "allowed_operations": [ "integrations.imap.messages.search" ] } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/spaces/{space_id}/integration-credentials": { "get": { "operationId": "integrationsCredentials", "summary": "List integration credentials", "description": "List the integration credentials available to a Space.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "path", "required": true, "description": "Resource identifier: space_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.credentials", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsCredentialsResponse" }, "example": { "items": [ { "grant_id": "123e4567-e89b-42d3-a456-426614174000", "connection_id": "123e4567-e89b-42d3-a456-426614174001", "provider_key": "imap", "label": "Support mailbox", "allowed_operations": [ "integrations.imap.messages.search" ] } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/skill-runs": { "post": { "operationId": "skillsRunsStart", "summary": "Start a skill run", "description": "Start one immutable native Skill run.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "skills.runs.start", "x-required-scope": "skills:write", "x-badges": [ { "name": "skills:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsRunsStartResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "installation_id": "123e4567-e89b-42d3-a456-426614174000", "skill_id": "123e4567-e89b-42d3-a456-426614174000", "skill_name": "Invoice extractor", "version_id": "123e4567-e89b-42d3-a456-426614174000", "version": 0, "requested_by_id": "123e4567-e89b-42d3-a456-426614174000", "requested_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "actor_type": "api", "origin": "manual", "trigger": { "id": "123e4567-e89b-42d3-a456-426614174000", "kind": "schedule" }, "status": "ACTIVE", "model": "claude-sonnet-5", "reasoning_effort": "medium", "effective_max_turns": 0, "review_max_rounds": 0, "instruction": "example", "cost_micro_usd": 0, "micro_credits": 0, "turns_used": 0, "step_progress": { "done": 0, "total": 0 }, "pages": [ { "key": "summary", "name": "Customer documents", "page_id": "123e4567-e89b-42d3-a456-426614174000", "url": "https://api.adlass.io/v1/workflows/hooks/example" } ], "error_code": "example", "error_message": "example", "started_at": "2026-09-04T12:00:00Z", "completed_at": "2026-09-04T12:00:00Z", "created_at": "2026-09-04T12:00:00Z", "reversal": { "id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "requested_by_id": "123e4567-e89b-42d3-a456-426614174000", "skip_conflicts": false, "summary": {}, "error_code": "example", "created_at": "2026-09-04T12:00:00Z", "started_at": "2026-09-04T12:00:00Z", "completed_at": "2026-09-04T12:00:00Z" }, "undo": { "available": false, "blocked_reason": "example" } } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsRunsStartRequest" }, "example": { "skill_id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "inputs": {}, "scope": {} } } } } }, "get": { "operationId": "skillsRunsList", "summary": "List skill runs", "description": "List authorized Skill runs in one Space.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "query", "required": true, "description": "Filter or parameter: space_id.", "schema": { "type": "string", "format": "uuid" } }, { "name": "skill_id", "in": "query", "required": false, "description": "Filter or parameter: skill_id.", "schema": { "type": "string", "format": "uuid" } }, { "name": "status", "in": "query", "required": false, "description": "Filter or parameter: status.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } } ], "x-operation-key": "skills.runs.list", "x-required-scope": "skills:read", "x-badges": [ { "name": "skills:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsRunsListResponse" }, "example": { "items": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "installation_id": "123e4567-e89b-42d3-a456-426614174000", "skill_id": "123e4567-e89b-42d3-a456-426614174000", "skill_name": "Invoice extractor", "version_id": "123e4567-e89b-42d3-a456-426614174000", "version": 0, "requested_by_id": "123e4567-e89b-42d3-a456-426614174000", "requested_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "actor_type": "api", "origin": "manual", "trigger": { "id": "123e4567-e89b-42d3-a456-426614174000", "kind": "schedule" }, "status": "ACTIVE", "model": "claude-sonnet-5", "reasoning_effort": "medium", "effective_max_turns": 0, "review_max_rounds": 0, "instruction": "example", "cost_micro_usd": 0, "micro_credits": 0, "turns_used": 0, "step_progress": { "done": 0, "total": 0 }, "pages": [], "error_code": "example", "error_message": "example", "started_at": "2026-09-04T12:00:00Z", "completed_at": "2026-09-04T12:00:00Z", "created_at": "2026-09-04T12:00:00Z", "reversal": { "id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "requested_by_id": "123e4567-e89b-42d3-a456-426614174000", "skip_conflicts": false, "summary": {}, "error_code": "example", "created_at": "2026-09-04T12:00:00Z", "started_at": "2026-09-04T12:00:00Z", "completed_at": "2026-09-04T12:00:00Z" }, "undo": { "available": false, "blocked_reason": "example" } } ], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/skill-runs/{run_id}": { "get": { "operationId": "skillsRunsGet", "summary": "Get a skill run", "description": "Get one authorized Skill run with its decrypted results.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "run_id", "in": "path", "required": true, "description": "Resource identifier: run_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "skills.runs.get", "x-required-scope": "skills:read", "x-badges": [ { "name": "skills:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsRunsGetResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "installation_id": "123e4567-e89b-42d3-a456-426614174000", "skill_id": "123e4567-e89b-42d3-a456-426614174000", "skill_name": "Invoice extractor", "version_id": "123e4567-e89b-42d3-a456-426614174000", "version": 0, "requested_by_id": "123e4567-e89b-42d3-a456-426614174000", "requested_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "actor_type": "api", "origin": "manual", "trigger": { "id": "123e4567-e89b-42d3-a456-426614174000", "kind": "schedule" }, "status": "ACTIVE", "model": "claude-sonnet-5", "reasoning_effort": "medium", "effective_max_turns": 0, "review_max_rounds": 0, "instruction": "example", "cost_micro_usd": 0, "micro_credits": 0, "turns_used": 0, "step_progress": { "done": 0, "total": 0 }, "pages": [ { "key": "summary", "name": "Customer documents", "page_id": "123e4567-e89b-42d3-a456-426614174000", "url": "https://api.adlass.io/v1/workflows/hooks/example" } ], "error_code": "example", "error_message": "example", "started_at": "2026-09-04T12:00:00Z", "completed_at": "2026-09-04T12:00:00Z", "created_at": "2026-09-04T12:00:00Z", "reversal": { "id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "requested_by_id": "123e4567-e89b-42d3-a456-426614174000", "skip_conflicts": false, "summary": {}, "error_code": "example", "created_at": "2026-09-04T12:00:00Z", "started_at": "2026-09-04T12:00:00Z", "completed_at": "2026-09-04T12:00:00Z" }, "undo": { "available": false, "blocked_reason": "example" }, "parent_workflow_run": { "id": "123e4567-e89b-42d3-a456-426614174000", "workflow_id": "123e4567-e89b-42d3-a456-426614174000", "workflow_name": "Invoice approval" }, "execution": { "attempt": 0, "status": "ACTIVE", "last_activity_at": "2026-09-04T12:00:00Z" }, "definition": {}, "inputs": {}, "scope": {}, "usage": {}, "open_points": [], "review": {}, "result_summary": "example", "ai_calls": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "purpose": "extraction", "model": "claude-sonnet-5", "input_tokens": 0, "cached_tokens": 0, "output_tokens": 0, "reasoning_tokens": 0, "cost_micro_usd": 0, "latency_ms": 0, "created_at": "2026-09-04T12:00:00Z" } ], "steps": [ { "index": 0, "title": "Approve supplier payment", "status": "ACTIVE", "summary": "Extracts totals and due dates from supplier invoices.", "evidence": [], "completed_at": "2026-09-04T12:00:00Z" } ], "outputs": [ { "key": "summary", "type": "run.completed", "name": "Customer documents", "revision": 0, "content": {}, "content_hash": "3f786850e387550fdab836ed7e6dc881de23001b", "byte_size": 0, "page_id": "123e4567-e89b-42d3-a456-426614174000", "url": "https://api.adlass.io/v1/workflows/hooks/example" } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/skill-runs/{run_id}/events": { "get": { "operationId": "skillsRunsEvents", "summary": "Poll skill run events", "description": "Poll sanitized events after a monotonic run cursor.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "run_id", "in": "path", "required": true, "description": "Resource identifier: run_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "after_event_id", "in": "query", "required": false, "description": "Filter or parameter: after_event_id.", "schema": { "type": "integer", "minimum": 0 } } ], "x-operation-key": "skills.runs.events", "x-required-scope": "skills:read", "x-badges": [ { "name": "skills:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsRunsEventsResponse" }, "example": { "items": [ { "id": 0, "type": "run.completed", "payload": {}, "actor": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "created_at": "2026-09-04T12:00:00Z" } ], "cursor": 0 } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/skill-runs/{run_id}/cancel": { "post": { "operationId": "skillsRunsCancel", "summary": "Cancel a skill run", "description": "Cancel a queued run or request cooperative cancellation.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "run_id", "in": "path", "required": true, "description": "Resource identifier: run_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "skills.runs.cancel", "x-required-scope": "skills:write", "x-badges": [ { "name": "skills:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsRunsCancelResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "installation_id": "123e4567-e89b-42d3-a456-426614174000", "skill_id": "123e4567-e89b-42d3-a456-426614174000", "skill_name": "Invoice extractor", "version_id": "123e4567-e89b-42d3-a456-426614174000", "version": 0, "requested_by_id": "123e4567-e89b-42d3-a456-426614174000", "requested_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "actor_type": "api", "origin": "manual", "trigger": { "id": "123e4567-e89b-42d3-a456-426614174000", "kind": "schedule" }, "status": "ACTIVE", "model": "claude-sonnet-5", "reasoning_effort": "medium", "effective_max_turns": 0, "review_max_rounds": 0, "instruction": "example", "cost_micro_usd": 0, "micro_credits": 0, "turns_used": 0, "step_progress": { "done": 0, "total": 0 }, "pages": [ { "key": "summary", "name": "Customer documents", "page_id": "123e4567-e89b-42d3-a456-426614174000", "url": "https://api.adlass.io/v1/workflows/hooks/example" } ], "error_code": "example", "error_message": "example", "started_at": "2026-09-04T12:00:00Z", "completed_at": "2026-09-04T12:00:00Z", "created_at": "2026-09-04T12:00:00Z", "reversal": { "id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "requested_by_id": "123e4567-e89b-42d3-a456-426614174000", "skip_conflicts": false, "summary": {}, "error_code": "example", "created_at": "2026-09-04T12:00:00Z", "started_at": "2026-09-04T12:00:00Z", "completed_at": "2026-09-04T12:00:00Z" }, "undo": { "available": false, "blocked_reason": "example" } } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/skill-runs/{run_id}/revert-preview": { "get": { "operationId": "skillsRunsRevertPreview", "summary": "Preview reverting a skill run", "description": "Preview what taking back one finished Skill run would change: pages and links are reverted, integration calls are listed for manual follow-up.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "run_id", "in": "path", "required": true, "description": "Resource identifier: run_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "skills.runs.revert_preview", "x-required-scope": "skills:read", "x-badges": [ { "name": "skills:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsRunsRevertPreviewResponse" }, "example": { "units": [ { "key": "summary", "target_kind": "example", "target_id": "example", "label": "Customer documents", "reversibility": "example", "outcome": "example", "reason": "example", "warnings": {}, "effects": [] } ], "counts": {}, "warnings": { "pending_invocations": 0 }, "undo": { "available": false, "blocked_reason": "example" }, "reversal": { "id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "requested_by_id": "123e4567-e89b-42d3-a456-426614174000", "skip_conflicts": false, "summary": {}, "error_code": "example", "created_at": "2026-09-04T12:00:00Z", "started_at": "2026-09-04T12:00:00Z", "completed_at": "2026-09-04T12:00:00Z" } } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/skill-runs/{run_id}/revert": { "post": { "operationId": "skillsRunsRevert", "summary": "Revert a skill run", "description": "Take back the pages and links one finished Skill run created. Changes made by others since the run are skipped only with skip_conflicts.", "tags": [ "Skills" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "run_id", "in": "path", "required": true, "description": "Resource identifier: run_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "skills.runs.revert", "x-required-scope": "skills:destroy", "x-badges": [ { "name": "skills:destroy", "position": "before" } ], "x-risk-level": "irreversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsRunsRevertResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "requested_by_id": "123e4567-e89b-42d3-a456-426614174000", "skip_conflicts": false, "summary": {}, "error_code": "example", "created_at": "2026-09-04T12:00:00Z", "started_at": "2026-09-04T12:00:00Z", "completed_at": "2026-09-04T12:00:00Z" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsRunsRevertRequest" }, "example": {} } } } } }, "/workflows": { "get": { "operationId": "workflowsList", "summary": "List workflows", "description": "List the workflows (automations) of one Space with status, version, trigger kinds, last run and the caller's access.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "query", "required": true, "description": "Filter or parameter: space_id.", "schema": { "type": "string", "format": "uuid" } }, { "name": "q", "in": "query", "required": false, "description": "Name or summary text", "schema": { "type": "string", "maxLength": 200, "description": "Name or summary text" } }, { "name": "status", "in": "query", "required": false, "description": "Filter or parameter: status.", "schema": { "type": "string", "enum": [ "DRAFT", "ACTIVE", "ARCHIVED" ] } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } } ], "x-operation-key": "workflows.list", "x-required-scope": "workflows:read", "x-badges": [ { "name": "workflows:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsListResponse" }, "example": { "items": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "name": "Customer documents", "summary": "Extracts totals and due dates from supplier invoices.", "status": "ACTIVE", "enabled": false, "has_draft": false, "draft_revision": 0, "current_version": { "id": "123e4567-e89b-42d3-a456-426614174000", "version": 0, "created_at": "2026-09-04T12:00:00Z" }, "node_count": 0, "trigger_kinds": [], "last_run": { "id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "created_at": "2026-09-04T12:00:00Z" }, "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z", "draft_differs": false, "access": { "space_role": "example", "share_role": "example", "access_mode": "example", "is_creator": false, "can_view": false, "can_edit": false, "can_run": false, "can_publish": false, "can_share": false, "can_archive": false, "can_approve": false }, "access_mode": "example", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "share_count": 0 } ], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "post": { "operationId": "workflowsCreate", "summary": "Create a workflow", "description": "Create a workflow draft in a Space. It starts with one manual trigger node; edit it with workflows.draft.save and publish it with workflows.publish.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "workflows.create", "x-required-scope": "workflows:write", "x-badges": [ { "name": "workflows:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "201": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsCreateResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "name": "Customer documents", "summary": "Extracts totals and due dates from supplier invoices.", "status": "ACTIVE", "enabled": false, "has_draft": false, "draft_revision": 0, "current_version": { "id": "123e4567-e89b-42d3-a456-426614174000", "version": 0, "change_note": "Initial version", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "created_at": "2026-09-04T12:00:00Z", "definition": {} }, "node_count": 0, "trigger_kinds": [], "last_run": { "id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "created_at": "2026-09-04T12:00:00Z" }, "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z", "draft_differs": false, "access": { "space_role": "example", "share_role": "example", "access_mode": "example", "is_creator": false, "can_view": false, "can_edit": false, "can_run": false, "can_publish": false, "can_share": false, "can_archive": false, "can_approve": false }, "access_mode": "example", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "share_count": 0, "draft": {}, "draft_updated_at": "2026-09-04T12:00:00Z", "webhooks": [ { "node_id": "trigger", "url": "https://api.adlass.io/v1/workflows/hooks/example", "auth_mode": "signature", "methods": [], "active": false } ], "triggers": [ { "node_id": "trigger", "kind": "schedule", "active": false, "next_fire_at": "2026-09-04T12:00:00Z", "last_fired_at": "2026-09-04T12:00:00Z", "last_error_code": "example", "last_error_message": "example" } ], "shares": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "user": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "role": "ADMIN", "created_at": "2026-09-04T12:00:00Z" } ], "published_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "pins": [ { "node_id": "trigger", "item_counts": {}, "updated_at": "2026-09-04T12:00:00Z" } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsCreateRequest" }, "example": { "space_id": "123e4567-e89b-42d3-a456-426614174000" } } } } } }, "/workflows/{workflow_id}": { "get": { "operationId": "workflowsGet", "summary": "Get a workflow", "description": "Get one workflow with its draft definition, published version, webhooks, trigger status, shares and the caller's access.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "workflow_id", "in": "path", "required": true, "description": "Resource identifier: workflow_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "workflows.get", "x-required-scope": "workflows:read", "x-badges": [ { "name": "workflows:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsGetResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "name": "Customer documents", "summary": "Extracts totals and due dates from supplier invoices.", "status": "ACTIVE", "enabled": false, "has_draft": false, "draft_revision": 0, "current_version": { "id": "123e4567-e89b-42d3-a456-426614174000", "version": 0, "change_note": "Initial version", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "created_at": "2026-09-04T12:00:00Z", "definition": {} }, "node_count": 0, "trigger_kinds": [], "last_run": { "id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "created_at": "2026-09-04T12:00:00Z" }, "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z", "draft_differs": false, "access": { "space_role": "example", "share_role": "example", "access_mode": "example", "is_creator": false, "can_view": false, "can_edit": false, "can_run": false, "can_publish": false, "can_share": false, "can_archive": false, "can_approve": false }, "access_mode": "example", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "share_count": 0, "draft": {}, "draft_updated_at": "2026-09-04T12:00:00Z", "webhooks": [ { "node_id": "trigger", "url": "https://api.adlass.io/v1/workflows/hooks/example", "auth_mode": "signature", "methods": [], "active": false } ], "triggers": [ { "node_id": "trigger", "kind": "schedule", "active": false, "next_fire_at": "2026-09-04T12:00:00Z", "last_fired_at": "2026-09-04T12:00:00Z", "last_error_code": "example", "last_error_message": "example" } ], "shares": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "user": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "role": "ADMIN", "created_at": "2026-09-04T12:00:00Z" } ], "published_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "pins": [ { "node_id": "trigger", "item_counts": {}, "updated_at": "2026-09-04T12:00:00Z" } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "patch": { "operationId": "workflowsRename", "summary": "Rename a workflow", "description": "Rename a workflow and optionally change its summary.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "workflow_id", "in": "path", "required": true, "description": "Resource identifier: workflow_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "workflows.rename", "x-required-scope": "workflows:write", "x-badges": [ { "name": "workflows:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsRenameResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "name": "Customer documents", "summary": "Extracts totals and due dates from supplier invoices.", "status": "ACTIVE", "enabled": false, "has_draft": false, "draft_revision": 0, "current_version": { "id": "123e4567-e89b-42d3-a456-426614174000", "version": 0, "change_note": "Initial version", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "created_at": "2026-09-04T12:00:00Z", "definition": {} }, "node_count": 0, "trigger_kinds": [], "last_run": { "id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "created_at": "2026-09-04T12:00:00Z" }, "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z", "draft_differs": false, "access": { "space_role": "example", "share_role": "example", "access_mode": "example", "is_creator": false, "can_view": false, "can_edit": false, "can_run": false, "can_publish": false, "can_share": false, "can_archive": false, "can_approve": false }, "access_mode": "example", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "share_count": 0, "draft": {}, "draft_updated_at": "2026-09-04T12:00:00Z", "webhooks": [ { "node_id": "trigger", "url": "https://api.adlass.io/v1/workflows/hooks/example", "auth_mode": "signature", "methods": [], "active": false } ], "triggers": [ { "node_id": "trigger", "kind": "schedule", "active": false, "next_fire_at": "2026-09-04T12:00:00Z", "last_fired_at": "2026-09-04T12:00:00Z", "last_error_code": "example", "last_error_message": "example" } ], "shares": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "user": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "role": "ADMIN", "created_at": "2026-09-04T12:00:00Z" } ], "published_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "pins": [ { "node_id": "trigger", "item_counts": {}, "updated_at": "2026-09-04T12:00:00Z" } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsRenameRequest" }, "example": { "name": "Customer documents" } } } } }, "delete": { "operationId": "workflowsDelete", "summary": "Delete a workflow", "description": "Delete an archived workflow with its versions, shares and webhooks. Fails with 409 while the workflow is not archived or still has runs.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "workflow_id", "in": "path", "required": true, "description": "Resource identifier: workflow_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "workflows.delete", "x-required-scope": "workflows:destroy", "x-badges": [ { "name": "workflows:destroy", "position": "before" } ], "x-risk-level": "irreversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsDeleteResponse" }, "example": { "outcome": "deleted" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/workflows/{workflow_id}/draft": { "put": { "operationId": "workflowsDraftSave", "summary": "Save the workflow draft", "description": "Store the working copy (draft definition) of a workflow without publishing. Returns non-blocking validation issues. Rejects stale expected_revision with 409.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "workflow_id", "in": "path", "required": true, "description": "Resource identifier: workflow_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "workflows.draft.save", "x-required-scope": "workflows:write", "x-badges": [ { "name": "workflows:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsDraftSaveResponse" }, "example": { "workflow_id": "123e4567-e89b-42d3-a456-426614174000", "draft_revision": 0, "draft_updated_at": "2026-09-04T12:00:00Z", "issues": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsDraftSaveRequest" }, "example": { "expected_revision": 0, "draft": {} } } } } }, "delete": { "operationId": "workflowsDraftDiscard", "summary": "Discard the workflow draft", "description": "Drop the working copy of a published workflow; the published version stays.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "workflow_id", "in": "path", "required": true, "description": "Resource identifier: workflow_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "workflows.draft.discard", "x-required-scope": "workflows:write", "x-badges": [ { "name": "workflows:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsDraftDiscardResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "name": "Customer documents", "summary": "Extracts totals and due dates from supplier invoices.", "status": "ACTIVE", "enabled": false, "has_draft": false, "draft_revision": 0, "current_version": { "id": "123e4567-e89b-42d3-a456-426614174000", "version": 0, "change_note": "Initial version", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "created_at": "2026-09-04T12:00:00Z", "definition": {} }, "node_count": 0, "trigger_kinds": [], "last_run": { "id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "created_at": "2026-09-04T12:00:00Z" }, "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z", "draft_differs": false, "access": { "space_role": "example", "share_role": "example", "access_mode": "example", "is_creator": false, "can_view": false, "can_edit": false, "can_run": false, "can_publish": false, "can_share": false, "can_archive": false, "can_approve": false }, "access_mode": "example", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "share_count": 0, "draft": {}, "draft_updated_at": "2026-09-04T12:00:00Z", "webhooks": [ { "node_id": "trigger", "url": "https://api.adlass.io/v1/workflows/hooks/example", "auth_mode": "signature", "methods": [], "active": false } ], "triggers": [ { "node_id": "trigger", "kind": "schedule", "active": false, "next_fire_at": "2026-09-04T12:00:00Z", "last_fired_at": "2026-09-04T12:00:00Z", "last_error_code": "example", "last_error_message": "example" } ], "shares": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "user": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "role": "ADMIN", "created_at": "2026-09-04T12:00:00Z" } ], "published_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "pins": [ { "node_id": "trigger", "item_counts": {}, "updated_at": "2026-09-04T12:00:00Z" } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsDraftDiscardRequest" }, "example": { "expected_revision": 0 } } } } } }, "/workflows/validate": { "post": { "operationId": "workflowsValidate", "summary": "Validate a workflow definition", "description": "Validate a workflow definition without saving: pass workflow_id to check its draft (or published version), or a definition together with space_id. Returns issues with severity error (blocks publishing) or warning.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" } ], "x-operation-key": "workflows.validate", "x-required-scope": "workflows:read", "x-badges": [ { "name": "workflows:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsValidateResponse" }, "example": { "issues": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsValidateRequest" }, "example": {} } } } } }, "/workflows/{workflow_id}/publish": { "post": { "operationId": "workflowsPublish", "summary": "Publish a workflow version", "description": "Validate the draft and publish it as a new immutable version that becomes active immediately: schedule and event triggers are registered, webhooks created. Fails with workflow_invalid and the list of issues when errors remain.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "workflow_id", "in": "path", "required": true, "description": "Resource identifier: workflow_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "workflows.publish", "x-required-scope": "workflows:write", "x-badges": [ { "name": "workflows:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsPublishResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "name": "Customer documents", "summary": "Extracts totals and due dates from supplier invoices.", "status": "ACTIVE", "enabled": false, "has_draft": false, "draft_revision": 0, "current_version": { "id": "123e4567-e89b-42d3-a456-426614174000", "version": 0, "change_note": "Initial version", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "created_at": "2026-09-04T12:00:00Z", "definition": {} }, "node_count": 0, "trigger_kinds": [], "last_run": { "id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "created_at": "2026-09-04T12:00:00Z" }, "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z", "draft_differs": false, "access": { "space_role": "example", "share_role": "example", "access_mode": "example", "is_creator": false, "can_view": false, "can_edit": false, "can_run": false, "can_publish": false, "can_share": false, "can_archive": false, "can_approve": false }, "access_mode": "example", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "share_count": 0, "draft": {}, "draft_updated_at": "2026-09-04T12:00:00Z", "webhooks": [ { "node_id": "trigger", "url": "https://api.adlass.io/v1/workflows/hooks/example", "auth_mode": "signature", "methods": [], "active": false } ], "triggers": [ { "node_id": "trigger", "kind": "schedule", "active": false, "next_fire_at": "2026-09-04T12:00:00Z", "last_fired_at": "2026-09-04T12:00:00Z", "last_error_code": "example", "last_error_message": "example" } ], "shares": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "user": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "role": "ADMIN", "created_at": "2026-09-04T12:00:00Z" } ], "published_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "pins": [ { "node_id": "trigger", "item_counts": {}, "updated_at": "2026-09-04T12:00:00Z" } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsPublishRequest" }, "example": { "expected_revision": 0 } } } } } }, "/workflows/{workflow_id}/versions": { "get": { "operationId": "workflowsVersions", "summary": "List workflow versions", "description": "List every published version of one workflow, newest first.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "workflow_id", "in": "path", "required": true, "description": "Resource identifier: workflow_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "x-operation-key": "workflows.versions", "x-required-scope": "workflows:read", "x-badges": [ { "name": "workflows:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsVersionsResponse" }, "example": { "items": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "version": 0, "change_note": "Initial version", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "created_at": "2026-09-04T12:00:00Z" } ], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/workflows/{workflow_id}/versions/{version_id}/restore": { "post": { "operationId": "workflowsRestore", "summary": "Restore a workflow version", "description": "Copy the definition of an earlier version into the draft. Publish afterwards to make it active.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "workflow_id", "in": "path", "required": true, "description": "Resource identifier: workflow_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "version_id", "in": "path", "required": true, "description": "Resource identifier: version_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "workflows.restore", "x-required-scope": "workflows:write", "x-badges": [ { "name": "workflows:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsRestoreResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "name": "Customer documents", "summary": "Extracts totals and due dates from supplier invoices.", "status": "ACTIVE", "enabled": false, "has_draft": false, "draft_revision": 0, "current_version": { "id": "123e4567-e89b-42d3-a456-426614174000", "version": 0, "change_note": "Initial version", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "created_at": "2026-09-04T12:00:00Z", "definition": {} }, "node_count": 0, "trigger_kinds": [], "last_run": { "id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "created_at": "2026-09-04T12:00:00Z" }, "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z", "draft_differs": false, "access": { "space_role": "example", "share_role": "example", "access_mode": "example", "is_creator": false, "can_view": false, "can_edit": false, "can_run": false, "can_publish": false, "can_share": false, "can_archive": false, "can_approve": false }, "access_mode": "example", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "share_count": 0, "draft": {}, "draft_updated_at": "2026-09-04T12:00:00Z", "webhooks": [ { "node_id": "trigger", "url": "https://api.adlass.io/v1/workflows/hooks/example", "auth_mode": "signature", "methods": [], "active": false } ], "triggers": [ { "node_id": "trigger", "kind": "schedule", "active": false, "next_fire_at": "2026-09-04T12:00:00Z", "last_fired_at": "2026-09-04T12:00:00Z", "last_error_code": "example", "last_error_message": "example" } ], "shares": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "user": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "role": "ADMIN", "created_at": "2026-09-04T12:00:00Z" } ], "published_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "pins": [ { "node_id": "trigger", "item_counts": {}, "updated_at": "2026-09-04T12:00:00Z" } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsRestoreRequest" }, "example": { "expected_revision": 0 } } } } } }, "/workflows/{workflow_id}/enable": { "post": { "operationId": "workflowsSetEnabledEnable", "summary": "Enable a workflow", "description": "Pause (enabled=false) or resume (enabled=true) the schedule, event and webhook triggers of a published workflow. Manual runs stay possible.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "workflow_id", "in": "path", "required": true, "description": "Resource identifier: workflow_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "workflows.set_enabled", "x-required-scope": "workflows:write", "x-badges": [ { "name": "workflows:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsSetEnabledEnableResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "name": "Customer documents", "summary": "Extracts totals and due dates from supplier invoices.", "status": "ACTIVE", "enabled": false, "has_draft": false, "draft_revision": 0, "current_version": { "id": "123e4567-e89b-42d3-a456-426614174000", "version": 0, "change_note": "Initial version", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "created_at": "2026-09-04T12:00:00Z", "definition": {} }, "node_count": 0, "trigger_kinds": [], "last_run": { "id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "created_at": "2026-09-04T12:00:00Z" }, "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z", "draft_differs": false, "access": { "space_role": "example", "share_role": "example", "access_mode": "example", "is_creator": false, "can_view": false, "can_edit": false, "can_run": false, "can_publish": false, "can_share": false, "can_archive": false, "can_approve": false }, "access_mode": "example", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "share_count": 0, "draft": {}, "draft_updated_at": "2026-09-04T12:00:00Z", "webhooks": [ { "node_id": "trigger", "url": "https://api.adlass.io/v1/workflows/hooks/example", "auth_mode": "signature", "methods": [], "active": false } ], "triggers": [ { "node_id": "trigger", "kind": "schedule", "active": false, "next_fire_at": "2026-09-04T12:00:00Z", "last_fired_at": "2026-09-04T12:00:00Z", "last_error_code": "example", "last_error_message": "example" } ], "shares": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "user": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "role": "ADMIN", "created_at": "2026-09-04T12:00:00Z" } ], "published_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "pins": [ { "node_id": "trigger", "item_counts": {}, "updated_at": "2026-09-04T12:00:00Z" } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/workflows/{workflow_id}/disable": { "post": { "operationId": "workflowsSetEnabledDisable", "summary": "Disable a workflow", "description": "Pause (enabled=false) or resume (enabled=true) the schedule, event and webhook triggers of a published workflow. Manual runs stay possible.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "workflow_id", "in": "path", "required": true, "description": "Resource identifier: workflow_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "workflows.set_enabled", "x-required-scope": "workflows:write", "x-badges": [ { "name": "workflows:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsSetEnabledDisableResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "name": "Customer documents", "summary": "Extracts totals and due dates from supplier invoices.", "status": "ACTIVE", "enabled": false, "has_draft": false, "draft_revision": 0, "current_version": { "id": "123e4567-e89b-42d3-a456-426614174000", "version": 0, "change_note": "Initial version", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "created_at": "2026-09-04T12:00:00Z", "definition": {} }, "node_count": 0, "trigger_kinds": [], "last_run": { "id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "created_at": "2026-09-04T12:00:00Z" }, "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z", "draft_differs": false, "access": { "space_role": "example", "share_role": "example", "access_mode": "example", "is_creator": false, "can_view": false, "can_edit": false, "can_run": false, "can_publish": false, "can_share": false, "can_archive": false, "can_approve": false }, "access_mode": "example", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "share_count": 0, "draft": {}, "draft_updated_at": "2026-09-04T12:00:00Z", "webhooks": [ { "node_id": "trigger", "url": "https://api.adlass.io/v1/workflows/hooks/example", "auth_mode": "signature", "methods": [], "active": false } ], "triggers": [ { "node_id": "trigger", "kind": "schedule", "active": false, "next_fire_at": "2026-09-04T12:00:00Z", "last_fired_at": "2026-09-04T12:00:00Z", "last_error_code": "example", "last_error_message": "example" } ], "shares": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "user": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "role": "ADMIN", "created_at": "2026-09-04T12:00:00Z" } ], "published_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "pins": [ { "node_id": "trigger", "item_counts": {}, "updated_at": "2026-09-04T12:00:00Z" } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/workflows/{workflow_id}/archive": { "post": { "operationId": "workflowsArchive", "summary": "Archive a workflow", "description": "Archive a workflow: its triggers are removed and webhooks deactivated, run history stays. Archived workflows cannot be edited, published or run.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "workflow_id", "in": "path", "required": true, "description": "Resource identifier: workflow_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "workflows.archive", "x-required-scope": "workflows:write", "x-badges": [ { "name": "workflows:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsArchiveResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "name": "Customer documents", "summary": "Extracts totals and due dates from supplier invoices.", "status": "ACTIVE", "enabled": false, "has_draft": false, "draft_revision": 0, "current_version": { "id": "123e4567-e89b-42d3-a456-426614174000", "version": 0, "change_note": "Initial version", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "created_at": "2026-09-04T12:00:00Z", "definition": {} }, "node_count": 0, "trigger_kinds": [], "last_run": { "id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "created_at": "2026-09-04T12:00:00Z" }, "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z", "draft_differs": false, "access": { "space_role": "example", "share_role": "example", "access_mode": "example", "is_creator": false, "can_view": false, "can_edit": false, "can_run": false, "can_publish": false, "can_share": false, "can_archive": false, "can_approve": false }, "access_mode": "example", "created_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "share_count": 0, "draft": {}, "draft_updated_at": "2026-09-04T12:00:00Z", "webhooks": [ { "node_id": "trigger", "url": "https://api.adlass.io/v1/workflows/hooks/example", "auth_mode": "signature", "methods": [], "active": false } ], "triggers": [ { "node_id": "trigger", "kind": "schedule", "active": false, "next_fire_at": "2026-09-04T12:00:00Z", "last_fired_at": "2026-09-04T12:00:00Z", "last_error_code": "example", "last_error_message": "example" } ], "shares": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "user": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "role": "ADMIN", "created_at": "2026-09-04T12:00:00Z" } ], "published_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "pins": [ { "node_id": "trigger", "item_counts": {}, "updated_at": "2026-09-04T12:00:00Z" } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/workflows/{workflow_id}/shares": { "get": { "operationId": "workflowsSharesList", "summary": "List workflow shares", "description": "List the users a workflow is shared with and their roles.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "workflow_id", "in": "path", "required": true, "description": "Resource identifier: workflow_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "x-operation-key": "workflows.shares_list", "x-required-scope": "workflows:read", "x-badges": [ { "name": "workflows:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsSharesListResponse" }, "example": { "items": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "user": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "role": "ADMIN", "created_at": "2026-09-04T12:00:00Z" } ], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "post": { "operationId": "workflowsShare", "summary": "Share a workflow", "description": "Share a workflow with a user of the same tenant who already has access to the Space, by user_id or email. An existing share gets the new role.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "workflow_id", "in": "path", "required": true, "description": "Resource identifier: workflow_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "workflows.share", "x-required-scope": "workflows:write", "x-badges": [ { "name": "workflows:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "201": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsShareResponse" }, "example": { "items": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "user": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "role": "ADMIN", "created_at": "2026-09-04T12:00:00Z" } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsShareRequest" }, "example": { "role": "VIEWER" } } } } } }, "/workflows/{workflow_id}/shares/{share_id}": { "patch": { "operationId": "workflowsShareUpdate", "summary": "Update a share role", "description": "Change the role of an existing workflow share.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "workflow_id", "in": "path", "required": true, "description": "Resource identifier: workflow_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "share_id", "in": "path", "required": true, "description": "Resource identifier: share_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "workflows.share_update", "x-required-scope": "workflows:write", "x-badges": [ { "name": "workflows:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsShareUpdateResponse" }, "example": { "items": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "user": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "role": "ADMIN", "created_at": "2026-09-04T12:00:00Z" } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsShareUpdateRequest" }, "example": { "role": "VIEWER" } } } } }, "delete": { "operationId": "workflowsShareRevoke", "summary": "Revoke a share", "description": "Remove a workflow share. Users may remove their own share; removing someone else's requires share permission.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "workflow_id", "in": "path", "required": true, "description": "Resource identifier: workflow_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "share_id", "in": "path", "required": true, "description": "Resource identifier: share_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "workflows.share_revoke", "x-required-scope": "workflows:write", "x-badges": [ { "name": "workflows:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsShareRevokeResponse" }, "example": { "items": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "user": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "role": "ADMIN", "created_at": "2026-09-04T12:00:00Z" } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/workflows/{workflow_id}/webhooks/{node_id}/rotate": { "post": { "operationId": "workflowsWebhooksRotate", "summary": "Rotate a webhook secret", "description": "Issue a new URL and secret for the webhook trigger node of a published workflow. The old URL stops working; the secret is only returned here.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "workflow_id", "in": "path", "required": true, "description": "Resource identifier: workflow_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "node_id", "in": "path", "required": true, "description": "Resource identifier: node_id.", "schema": { "type": "string", "maxLength": 80 }, "example": "example" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "workflows.webhooks.rotate", "x-required-scope": "workflows:destroy", "x-badges": [ { "name": "workflows:destroy", "position": "before" } ], "x-risk-level": "irreversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsWebhooksRotateResponse" }, "example": { "url": "https://api.adlass.io/v1/workflows/hooks/example", "secret": "whsec_example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/workflow-node-kinds": { "get": { "operationId": "workflowsNodeKinds", "summary": "List node kinds", "description": "Catalog of workflow node kinds (triggers, skill, integration, transform, if, filter, switch, join, loop, wait, approval). Call it with detail=summary first (keys, descriptions and ports of every kind), then with kinds=[...] and detail=full for the kinds you add to get their JSON config schema, default config and output schema. Never guess config fields. Without arguments it returns the full catalog.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "kinds", "in": "query", "required": false, "description": "Node kind keys to return; omit for every kind.", "schema": { "type": "array", "items": { "type": "string" }, "minItems": 1, "maxItems": 50, "description": "Node kind keys to return; omit for every kind." }, "style": "form", "explode": true }, { "name": "detail", "in": "query", "required": false, "description": "summary: key, category, description, ports; full: adds schemas.", "schema": { "type": "string", "enum": [ "summary", "full" ], "description": "summary: key, category, description, ports; full: adds schemas." } } ], "x-operation-key": "workflows.node_kinds", "x-required-scope": "workflows:read", "x-badges": [ { "name": "workflows:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsNodeKindsResponse" }, "example": { "items": [ { "key": "summary", "category": "example", "description": "example", "inputs": [], "outputs": [], "dynamic_outputs": false } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/workflow-runs": { "post": { "operationId": "workflowsRunsStart", "summary": "Start a workflow run", "description": "Start a run of a published workflow from its manual trigger with an optional instruction, declared inputs and documents. Returns the queued run; poll workflows.runs.get for progress.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "workflows.runs.start", "x-required-scope": "workflows:write", "x-badges": [ { "name": "workflows:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsRunsStartResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "workflow_id": "123e4567-e89b-42d3-a456-426614174000", "workflow_name": "Invoice approval", "space_id": "123e4567-e89b-42d3-a456-426614174000", "version": { "id": "123e4567-e89b-42d3-a456-426614174000", "version": 0 }, "origin": "manual", "actor_type": "api", "trigger_id": "123e4567-e89b-42d3-a456-426614174000", "webhook_id": "123e4567-e89b-42d3-a456-426614174000", "parent_run_id": "123e4567-e89b-42d3-a456-426614174000", "trigger_node_id": "example", "status": "ACTIVE", "error_code": "example", "error_message": "example", "error_details": {}, "retry_of": "123e4567-e89b-42d3-a456-426614174000", "activations_total": 0, "cost_micro_usd": 0, "requested_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "created_at": "2026-09-04T12:00:00Z", "started_at": "2026-09-04T12:00:00Z", "completed_at": "2026-09-04T12:00:00Z", "wake_at": "2026-09-04T12:00:00Z" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsRunsStartRequest" }, "example": { "workflow_id": "123e4567-e89b-42d3-a456-426614174000" } } } } }, "get": { "operationId": "workflowsRunsList", "summary": "List workflow runs", "description": "List workflow runs in a Space, newest first, optionally filtered by workflow and status. Pass the created_at of the last item as before to page.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "query", "required": true, "description": "Filter or parameter: space_id.", "schema": { "type": "string", "format": "uuid" } }, { "name": "workflow_id", "in": "query", "required": false, "description": "Filter or parameter: workflow_id.", "schema": { "type": "string", "format": "uuid" } }, { "name": "status", "in": "query", "required": false, "description": "Filter or parameter: status.", "schema": { "type": "string", "enum": [ "QUEUED", "RUNNING", "WAITING", "CANCEL_REQUESTED", "SUCCEEDED", "FAILED", "CANCELLED" ] } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "include_tests", "in": "query", "required": false, "description": "Also list runs that tested a single node from the editor.", "schema": { "type": "boolean", "description": "Also list runs that tested a single node from the editor." } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } } ], "x-operation-key": "workflows.runs.list", "x-required-scope": "workflows:read", "x-badges": [ { "name": "workflows:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsRunsListResponse" }, "example": { "items": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "workflow_id": "123e4567-e89b-42d3-a456-426614174000", "workflow_name": "Invoice approval", "space_id": "123e4567-e89b-42d3-a456-426614174000", "version": { "id": "123e4567-e89b-42d3-a456-426614174000", "version": 0 }, "origin": "manual", "actor_type": "api", "trigger_id": "123e4567-e89b-42d3-a456-426614174000", "webhook_id": "123e4567-e89b-42d3-a456-426614174000", "parent_run_id": "123e4567-e89b-42d3-a456-426614174000", "trigger_node_id": "example", "status": "ACTIVE", "error_code": "example", "error_message": "example", "error_details": {}, "retry_of": "123e4567-e89b-42d3-a456-426614174000", "activations_total": 0, "cost_micro_usd": 0, "requested_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "created_at": "2026-09-04T12:00:00Z", "started_at": "2026-09-04T12:00:00Z", "completed_at": "2026-09-04T12:00:00Z", "wake_at": "2026-09-04T12:00:00Z" } ], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/workflow-runs/{run_id}": { "get": { "operationId": "workflowsRunsGet", "summary": "Get a workflow run", "description": "Get one workflow run with the definition it executes, every node activation (status, item counts, errors, waits) and the events cursor. Items are read with workflows.runs.node_items.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "run_id", "in": "path", "required": true, "description": "Resource identifier: run_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "workflows.runs.get", "x-required-scope": "workflows:read", "x-badges": [ { "name": "workflows:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsRunsGetResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "workflow_id": "123e4567-e89b-42d3-a456-426614174000", "workflow_name": "Invoice approval", "space_id": "123e4567-e89b-42d3-a456-426614174000", "version": { "id": "123e4567-e89b-42d3-a456-426614174000", "version": 0 }, "origin": "manual", "actor_type": "api", "trigger_id": "123e4567-e89b-42d3-a456-426614174000", "webhook_id": "123e4567-e89b-42d3-a456-426614174000", "parent_run_id": "123e4567-e89b-42d3-a456-426614174000", "trigger_node_id": "example", "status": "ACTIVE", "error_code": "example", "error_message": "example", "error_details": {}, "retry_of": "123e4567-e89b-42d3-a456-426614174000", "activations_total": 0, "cost_micro_usd": 0, "requested_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "created_at": "2026-09-04T12:00:00Z", "started_at": "2026-09-04T12:00:00Z", "completed_at": "2026-09-04T12:00:00Z", "wake_at": "2026-09-04T12:00:00Z", "definition": {}, "settings": {}, "trace_id": "0af7651916cd43dd8448eb211c80319c", "node_runs": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "node_id": "trigger", "node_kind": "manual_trigger", "node_name": "Manual trigger", "context_key": "example", "iteration_path": [], "attempt": 0, "sequence": 0, "status": "ACTIVE", "input_count": 0, "output_counts": {}, "error_code": "example", "error_message": "example", "error_details": {}, "retryable": false, "cost_micro_usd": 0, "duration_ms": 0, "wake_at": "2026-09-04T12:00:00Z", "started_at": "2026-09-04T12:00:00Z", "completed_at": "2026-09-04T12:00:00Z", "wait": {} } ], "events_cursor": 0 } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/workflow-runs/{run_id}/events": { "get": { "operationId": "workflowsRunsEvents", "summary": "Poll workflow run events", "description": "Poll workflow run events after a monotonic cursor.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "run_id", "in": "path", "required": true, "description": "Resource identifier: run_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "after_event_id", "in": "query", "required": false, "description": "Filter or parameter: after_event_id.", "schema": { "type": "integer", "minimum": 0 } } ], "x-operation-key": "workflows.runs.events", "x-required-scope": "workflows:read", "x-badges": [ { "name": "workflows:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsRunsEventsResponse" }, "example": { "items": [ { "id": 0, "type": "run.completed", "node_id": "trigger", "payload": {}, "actor": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "created_at": "2026-09-04T12:00:00Z" } ], "cursor": 0 } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/workflow-runs/{run_id}/cancel": { "post": { "operationId": "workflowsRunsCancel", "summary": "Cancel a workflow run", "description": "Cancel a queued workflow run or request cooperative cancellation of a running or waiting one.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "run_id", "in": "path", "required": true, "description": "Resource identifier: run_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "workflows.runs.cancel", "x-required-scope": "workflows:write", "x-badges": [ { "name": "workflows:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsRunsCancelResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "workflow_id": "123e4567-e89b-42d3-a456-426614174000", "workflow_name": "Invoice approval", "space_id": "123e4567-e89b-42d3-a456-426614174000", "version": { "id": "123e4567-e89b-42d3-a456-426614174000", "version": 0 }, "origin": "manual", "actor_type": "api", "trigger_id": "123e4567-e89b-42d3-a456-426614174000", "webhook_id": "123e4567-e89b-42d3-a456-426614174000", "parent_run_id": "123e4567-e89b-42d3-a456-426614174000", "trigger_node_id": "example", "status": "ACTIVE", "error_code": "example", "error_message": "example", "error_details": {}, "retry_of": "123e4567-e89b-42d3-a456-426614174000", "activations_total": 0, "cost_micro_usd": 0, "requested_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "created_at": "2026-09-04T12:00:00Z", "started_at": "2026-09-04T12:00:00Z", "completed_at": "2026-09-04T12:00:00Z", "wake_at": "2026-09-04T12:00:00Z" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/workflow-runs/{run_id}/retry": { "post": { "operationId": "workflowsRunsRetry", "summary": "Retry a workflow run", "description": "Start a new run with the same version and trigger items as a finished run. The new run references the original via retry_of.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "run_id", "in": "path", "required": true, "description": "Resource identifier: run_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "workflows.runs.retry", "x-required-scope": "workflows:write", "x-badges": [ { "name": "workflows:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsRunsRetryResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "workflow_id": "123e4567-e89b-42d3-a456-426614174000", "workflow_name": "Invoice approval", "space_id": "123e4567-e89b-42d3-a456-426614174000", "version": { "id": "123e4567-e89b-42d3-a456-426614174000", "version": 0 }, "origin": "manual", "actor_type": "api", "trigger_id": "123e4567-e89b-42d3-a456-426614174000", "webhook_id": "123e4567-e89b-42d3-a456-426614174000", "parent_run_id": "123e4567-e89b-42d3-a456-426614174000", "trigger_node_id": "example", "status": "ACTIVE", "error_code": "example", "error_message": "example", "error_details": {}, "retry_of": "123e4567-e89b-42d3-a456-426614174000", "activations_total": 0, "cost_micro_usd": 0, "requested_by": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "created_at": "2026-09-04T12:00:00Z", "started_at": "2026-09-04T12:00:00Z", "completed_at": "2026-09-04T12:00:00Z", "wake_at": "2026-09-04T12:00:00Z" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/workflow-node-runs/{node_run_id}/items": { "get": { "operationId": "workflowsRunsNodeItems", "summary": "List node run items", "description": "Read the input or output items of one node activation of a workflow run, paged. Output items are read per port (default main).", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "node_run_id", "in": "path", "required": true, "description": "Resource identifier: node_run_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "side", "in": "query", "required": true, "description": "Filter or parameter: side.", "schema": { "type": "string", "enum": [ "input", "output" ] } }, { "name": "port", "in": "query", "required": false, "description": "Filter or parameter: port.", "schema": { "type": "string", "maxLength": 40 } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } } ], "x-operation-key": "workflows.runs.node_items", "x-required-scope": "workflows:read", "x-badges": [ { "name": "workflows:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsRunsNodeItemsResponse" }, "example": { "items": [], "total": 0, "offset": 0, "limit": 0, "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/workflow-node-runs/{node_run_id}/resume": { "post": { "operationId": "workflowsRunsResume", "summary": "Resume a waiting node", "description": "Decide an open approval of a waiting workflow node: approve or reject with an optional comment and the form values the approval node declares.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "node_run_id", "in": "path", "required": true, "description": "Resource identifier: node_run_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "workflows.runs.resume", "x-required-scope": "workflows:write", "x-badges": [ { "name": "workflows:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsRunsResumeResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "node_id": "trigger", "node_kind": "manual_trigger", "node_name": "Manual trigger", "context_key": "example", "iteration_path": [], "attempt": 0, "sequence": 0, "status": "ACTIVE", "input_count": 0, "output_counts": {}, "error_code": "example", "error_message": "example", "error_details": {}, "retryable": false, "cost_micro_usd": 0, "duration_ms": 0, "wake_at": "2026-09-04T12:00:00Z", "started_at": "2026-09-04T12:00:00Z", "completed_at": "2026-09-04T12:00:00Z", "wait": {} } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsRunsResumeRequest" }, "example": { "decision": "approved" } } } } } }, "/workflow-approvals": { "get": { "operationId": "workflowsApprovalsList", "summary": "List pending approvals", "description": "List approvals of workflow runs in a Space that the caller may decide, open ones by default.", "tags": [ "Workflows" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "query", "required": true, "description": "Filter or parameter: space_id.", "schema": { "type": "string", "format": "uuid" } }, { "name": "status", "in": "query", "required": false, "description": "Filter or parameter: status.", "schema": { "type": "string", "enum": [ "OPEN", "RESOLVED", "EXPIRED", "CANCELLED" ] } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "x-operation-key": "workflows.approvals.list", "x-required-scope": "workflows:read", "x-badges": [ { "name": "workflows:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowsApprovalsListResponse" }, "example": { "items": [ { "wait_id": "123e4567-e89b-42d3-a456-426614174000", "run_id": "123e4567-e89b-42d3-a456-426614174000", "node_run_id": "123e4567-e89b-42d3-a456-426614174000", "node_id": "trigger", "workflow": { "id": "123e4567-e89b-42d3-a456-426614174000", "name": "Customer documents" }, "title": "Approve supplier payment", "message": "Please review the extracted totals.", "form": [] } ], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/pages": { "get": { "operationId": "pagesList", "summary": "List pages", "description": "List the pages of a space with link, visit and submission counters.", "tags": [ "Pages" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "space_id", "in": "query", "required": true, "description": "Filter or parameter: space_id.", "schema": { "format": "uuid", "title": "Space Id", "type": "string" } }, { "name": "kind", "in": "query", "required": false, "description": "Filter or parameter: kind.", "schema": { "anyOf": [ { "enum": [ "blocks", "live_document", "html" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Kind" } }, { "name": "status", "in": "query", "required": false, "description": "Filter or parameter: status.", "schema": { "anyOf": [ { "enum": [ "DRAFT", "PUBLISHED", "ARCHIVED" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } } ], "x-operation-key": "pages.list", "x-required-scope": "pages:read", "x-badges": [ { "name": "pages:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesListResponse" }, "example": { "items": [], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "post": { "operationId": "pagesCreate", "summary": "Create a page", "description": "Create a public page as a draft inside a space. Flow: pages.create → pages.publish → pages.links_create → send the returned url → pages.submissions_list to read answers. Kind 'blocks' takes a block definition (headings, text, tables, downloads, fields, choices, uploads). Use {{ variable }} placeholders in texts and declare them under 'variables'; each link freezes its own values via 'context'. Kind 'live_document' shares a native live document by source_document_id; links with permissions.live = 'write' let visitors edit it in real time. Kind 'html' takes a self-contained HTML document in 'html' (max 5 MiB, rendered in a sandboxed frame without network access) plus an optional 'definition.fields' declaration so window.adlass.submit(values) is validated.", "tags": [ "Pages" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "pages.create", "x-required-scope": "pages:write", "x-badges": [ { "name": "pages:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "201": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesCreateResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174002", "kind": "html", "name": "Quarterly report", "status": "PUBLISHED", "source_type": "USER", "source_id": null, "current_version": { "id": "123e4567-e89b-42d3-a456-426614174001", "number": 3, "content_hash": "3f786850e387550fdab836ed7e6dc881de23001b", "created_at": "2026-09-04T12:00:00Z" }, "submission_count": 0, "link_count": 1, "visit_count": 12, "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z", "source_document_id": null, "source_metadata": {}, "draft_definition": {}, "draft_settings": {}, "draft_assets": [], "created_by": { "id": "123e4567-e89b-42d3-a456-426614174002", "name": "Ada Lovelace", "email": "ada@example.com" } } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesCreateRequest" }, "example": { "space_id": "123e4567-e89b-42d3-a456-426614174000", "name": "Customer documents" } } } } } }, "/pages/{page_id}": { "get": { "operationId": "pagesGet", "summary": "Get a page", "description": "Read a page with its draft, current version summary and counters.", "tags": [ "Pages" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "page_id", "in": "path", "required": true, "description": "Resource identifier: page_id.", "schema": { "format": "uuid", "title": "Page Id", "type": "string" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "pages.get", "x-required-scope": "pages:read", "x-badges": [ { "name": "pages:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesGetResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174002", "kind": "html", "name": "Quarterly report", "status": "PUBLISHED", "source_type": "USER", "source_id": null, "current_version": { "id": "123e4567-e89b-42d3-a456-426614174001", "number": 3, "content_hash": "3f786850e387550fdab836ed7e6dc881de23001b", "created_at": "2026-09-04T12:00:00Z" }, "submission_count": 0, "link_count": 1, "visit_count": 12, "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z", "source_document_id": null, "source_metadata": {}, "draft_definition": {}, "draft_settings": {}, "draft_assets": [], "created_by": { "id": "123e4567-e89b-42d3-a456-426614174002", "name": "Ada Lovelace", "email": "ada@example.com" } } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "delete": { "operationId": "pagesDelete", "summary": "Delete a page", "description": "Soft-delete a page: every link is revoked, visitor sessions are removed and visitor personal data is anonymised. Submissions and uploaded documents remain.", "tags": [ "Pages" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "page_id", "in": "path", "required": true, "description": "Resource identifier: page_id.", "schema": { "format": "uuid", "title": "Page Id", "type": "string" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "pages.delete", "x-required-scope": "pages:destroy", "x-badges": [ { "name": "pages:destroy", "position": "before" } ], "x-risk-level": "irreversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesDeleteResponse" }, "example": { "page_id": "123e4567-e89b-42d3-a456-426614174000", "outcome": "deleted" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/pages/{page_id}/draft": { "put": { "operationId": "pagesUpdateDraft", "summary": "Update the page draft", "description": "Replace the draft definition, name or settings of a page. Published links keep showing their frozen version until pages.publish runs again.", "tags": [ "Pages" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "page_id", "in": "path", "required": true, "description": "Resource identifier: page_id.", "schema": { "format": "uuid", "title": "Page Id", "type": "string" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "pages.update_draft", "x-required-scope": "pages:write", "x-badges": [ { "name": "pages:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesUpdateDraftResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174002", "kind": "html", "name": "Quarterly report", "status": "PUBLISHED", "source_type": "USER", "source_id": null, "current_version": { "id": "123e4567-e89b-42d3-a456-426614174001", "number": 3, "content_hash": "3f786850e387550fdab836ed7e6dc881de23001b", "created_at": "2026-09-04T12:00:00Z" }, "submission_count": 0, "link_count": 1, "visit_count": 12, "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z", "source_document_id": null, "source_metadata": {}, "draft_definition": {}, "draft_settings": {}, "draft_assets": [], "created_by": { "id": "123e4567-e89b-42d3-a456-426614174002", "name": "Ada Lovelace", "email": "ada@example.com" } } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesUpdateDraftRequest" }, "example": { "name": "Quarterly report", "settings": { "locale": "en" }, "assets": [ { "key": "report", "resource_id": "123e4567-e89b-42d3-a456-426614174005" } ], "expected_updated_at": "2026-01-01T00:00:00Z" } } } } } }, "/pages/{page_id}/publish": { "post": { "operationId": "pagesPublish", "summary": "Publish a page", "description": "Freeze the draft into a new immutable version and mark the page PUBLISHED. Existing links stay pinned to their version; new links use the new one. The response lists input keys added, removed or changed versus the previous version.", "tags": [ "Pages" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "page_id", "in": "path", "required": true, "description": "Resource identifier: page_id.", "schema": { "format": "uuid", "title": "Page Id", "type": "string" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "pages.publish", "x-required-scope": "pages:write", "x-badges": [ { "name": "pages:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesPublishResponse" }, "example": { "page": { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174002", "kind": "html", "name": "Quarterly report", "status": "PUBLISHED", "source_type": "USER", "source_id": null, "current_version": { "id": "123e4567-e89b-42d3-a456-426614174001", "number": 3, "content_hash": "3f786850e387550fdab836ed7e6dc881de23001b", "created_at": "2026-09-04T12:00:00Z" }, "submission_count": 0, "link_count": 1, "visit_count": 12, "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z", "source_document_id": null, "source_metadata": {}, "draft_definition": {}, "draft_settings": {}, "draft_assets": [], "created_by": { "id": "123e4567-e89b-42d3-a456-426614174002", "name": "Ada Lovelace", "email": "ada@example.com" } }, "version": { "id": "123e4567-e89b-42d3-a456-426614174001", "number": 3, "content_hash": "3f786850e387550fdab836ed7e6dc881de23001b", "created_at": "2026-09-04T12:00:00Z", "page_id": "123e4567-e89b-42d3-a456-426614174000", "kind": "html", "definition": {}, "settings": {}, "output_schema": null, "artifact_size": 2048, "assets": [], "created_by": { "id": "123e4567-e89b-42d3-a456-426614174002", "name": "Ada Lovelace", "email": "ada@example.com" } }, "changed_keys": [ "definition" ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/pages/{page_id}/html": { "get": { "operationId": "pagesHtmlGet", "summary": "Get the published HTML", "description": "Read the HTML artifact of an HTML page: the current draft or a published version.", "tags": [ "Pages" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "page_id", "in": "path", "required": true, "description": "Resource identifier: page_id.", "schema": { "format": "uuid", "title": "Page Id", "type": "string" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "version_id", "in": "query", "required": false, "description": "Published version; omitted for the current draft.", "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "Published version; omitted for the current draft.", "title": "Version Id" } } ], "x-operation-key": "pages.html_get", "x-required-scope": "pages:read", "x-badges": [ { "name": "pages:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesHtmlGetResponse" }, "example": { "page_id": "123e4567-e89b-42d3-a456-426614174000", "version_id": "123e4567-e89b-42d3-a456-426614174001", "html": "Quarterly report", "size": 2048, "sha256": "3f786850e387550fdab836ed7e6dc881de23001b3f786850e387550fdab836ed" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/pages/{page_id}/versions": { "get": { "operationId": "pagesVersionsList", "summary": "List page versions", "description": "List all published versions of a page, newest first.", "tags": [ "Pages" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "page_id", "in": "path", "required": true, "description": "Resource identifier: page_id.", "schema": { "format": "uuid", "title": "Page Id", "type": "string" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } } ], "x-operation-key": "pages.versions_list", "x-required-scope": "pages:read", "x-badges": [ { "name": "pages:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesVersionsListResponse" }, "example": { "items": [], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/pages/{page_id}/archive": { "post": { "operationId": "pagesArchive", "summary": "Archive a page", "description": "Archive a page and disable all of its links. Reversible: pages.publish restores PUBLISHED, links are re-enabled individually via pages.links_update.", "tags": [ "Pages" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "page_id", "in": "path", "required": true, "description": "Resource identifier: page_id.", "schema": { "format": "uuid", "title": "Page Id", "type": "string" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "pages.archive", "x-required-scope": "pages:write", "x-badges": [ { "name": "pages:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesArchiveResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174002", "kind": "html", "name": "Quarterly report", "status": "ARCHIVED", "source_type": "USER", "source_id": null, "current_version": { "id": "123e4567-e89b-42d3-a456-426614174001", "number": 3, "content_hash": "3f786850e387550fdab836ed7e6dc881de23001b", "created_at": "2026-09-04T12:00:00Z" }, "submission_count": 0, "link_count": 1, "visit_count": 12, "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z", "source_document_id": null, "source_metadata": {}, "draft_definition": {}, "draft_settings": {}, "draft_assets": [], "created_by": { "id": "123e4567-e89b-42d3-a456-426614174002", "name": "Ada Lovelace", "email": "ada@example.com" } } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/pages/{page_id}/assets": { "put": { "operationId": "pagesAssetsSet", "summary": "Set page assets", "description": "Replace the draft's downloadable assets. Each asset maps a machine key (referenced by download blocks) to a document of the same space.", "tags": [ "Pages" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "page_id", "in": "path", "required": true, "description": "Resource identifier: page_id.", "schema": { "format": "uuid", "title": "Page Id", "type": "string" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "pages.assets_set", "x-required-scope": "pages:write", "x-badges": [ { "name": "pages:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesAssetsSetResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174002", "kind": "html", "name": "Quarterly report", "status": "PUBLISHED", "source_type": "USER", "source_id": null, "current_version": { "id": "123e4567-e89b-42d3-a456-426614174001", "number": 3, "content_hash": "3f786850e387550fdab836ed7e6dc881de23001b", "created_at": "2026-09-04T12:00:00Z" }, "submission_count": 0, "link_count": 1, "visit_count": 12, "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z", "source_document_id": null, "source_metadata": {}, "draft_definition": {}, "draft_settings": {}, "draft_assets": [], "created_by": { "id": "123e4567-e89b-42d3-a456-426614174002", "name": "Ada Lovelace", "email": "ada@example.com" } } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesAssetsSetRequest" }, "example": {} } } } } }, "/pages/{page_id}/links": { "get": { "operationId": "pagesLinksList", "summary": "List page links", "description": "List the links of a page with their derived state and counters.", "tags": [ "Pages" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "page_id", "in": "path", "required": true, "description": "Resource identifier: page_id.", "schema": { "format": "uuid", "title": "Page Id", "type": "string" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "status", "in": "query", "required": false, "description": "Filter or parameter: status.", "schema": { "anyOf": [ { "enum": [ "ACTIVE", "DISABLED", "REVOKED" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } } ], "x-operation-key": "pages.links_list", "x-required-scope": "pages:read", "x-badges": [ { "name": "pages:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesLinksListResponse" }, "example": { "items": [], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "post": { "operationId": "pagesLinksCreate", "summary": "Create a page link", "description": "Create a share link for the page's current version and return its url. Gates: optional password, access_mode EMAIL (asks for an email) or EMAIL_VERIFIED (sends a code; allowlists apply). submission_mode SINGLE closes the link after the first submission. 'context' freezes variable values into the texts of this link.", "tags": [ "Pages" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "page_id", "in": "path", "required": true, "description": "Resource identifier: page_id.", "schema": { "format": "uuid", "title": "Page Id", "type": "string" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "pages.links_create", "x-required-scope": "pages:write", "x-badges": [ { "name": "pages:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "201": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesLinksCreateResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "page_id": "123e4567-e89b-42d3-a456-426614174001", "page_version_id": "123e4567-e89b-42d3-a456-426614174002", "page_version_number": 3, "label": "Customer review", "status": "ACTIVE", "state": "active", "auth_version": 1, "expires_at": null, "max_visits": null, "visit_count": 4, "has_password": false, "access_mode": "ANONYMOUS", "allowed_emails": [], "allowed_domains": [], "submission_mode": "NONE", "submission_count": 0, "last_visited_at": "2026-09-04T12:00:00Z", "locale": null, "permissions": {}, "context": {}, "source_type": "USER", "source_id": null, "source_metadata": {}, "created_by": { "id": "123e4567-e89b-42d3-a456-426614174002", "name": "Ada Lovelace", "email": "ada@example.com" }, "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesLinksCreateRequest" }, "example": {} } } } } }, "/page-links/{link_id}": { "get": { "operationId": "pagesLinksGet", "summary": "Get a page link", "description": "Read one link including its url (space managers only).", "tags": [ "Pages" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "link_id", "in": "path", "required": true, "description": "Resource identifier: link_id.", "schema": { "format": "uuid", "title": "Link Id", "type": "string" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "pages.links_get", "x-required-scope": "pages:read", "x-badges": [ { "name": "pages:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesLinksGetResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "page_id": "123e4567-e89b-42d3-a456-426614174001", "page_version_id": "123e4567-e89b-42d3-a456-426614174002", "page_version_number": 3, "label": "Customer review", "status": "ACTIVE", "state": "active", "auth_version": 1, "expires_at": null, "max_visits": null, "visit_count": 4, "has_password": false, "access_mode": "ANONYMOUS", "allowed_emails": [], "allowed_domains": [], "submission_mode": "NONE", "submission_count": 0, "last_visited_at": "2026-09-04T12:00:00Z", "locale": null, "permissions": {}, "context": {}, "source_type": "USER", "source_id": null, "source_metadata": {}, "created_by": { "id": "123e4567-e89b-42d3-a456-426614174002", "name": "Ada Lovelace", "email": "ada@example.com" }, "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "patch": { "operationId": "pagesLinksUpdate", "summary": "Update a page link", "description": "Change a link's label, expiry, visit limit, gates, submission mode, locale, permissions or status (ACTIVE/DISABLED). Changing a gate invalidates open sessions.", "tags": [ "Pages" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "link_id", "in": "path", "required": true, "description": "Resource identifier: link_id.", "schema": { "format": "uuid", "title": "Link Id", "type": "string" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "pages.links_update", "x-required-scope": "pages:write", "x-badges": [ { "name": "pages:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesLinksUpdateResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "page_id": "123e4567-e89b-42d3-a456-426614174001", "page_version_id": "123e4567-e89b-42d3-a456-426614174002", "page_version_number": 3, "label": "Customer review", "status": "ACTIVE", "state": "active", "auth_version": 1, "expires_at": null, "max_visits": null, "visit_count": 4, "has_password": false, "access_mode": "ANONYMOUS", "allowed_emails": [], "allowed_domains": [], "submission_mode": "NONE", "submission_count": 0, "last_visited_at": "2026-09-04T12:00:00Z", "locale": null, "permissions": {}, "context": {}, "source_type": "USER", "source_id": null, "source_metadata": {}, "created_by": { "id": "123e4567-e89b-42d3-a456-426614174002", "name": "Ada Lovelace", "email": "ada@example.com" }, "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesLinksUpdateRequest" }, "example": {} } } } }, "delete": { "operationId": "pagesLinksRevoke", "summary": "Revoke a page link", "description": "Permanently revoke a link. Cannot be undone; create a new link instead.", "tags": [ "Pages" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "link_id", "in": "path", "required": true, "description": "Resource identifier: link_id.", "schema": { "format": "uuid", "title": "Link Id", "type": "string" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "pages.links_revoke", "x-required-scope": "pages:destroy", "x-badges": [ { "name": "pages:destroy", "position": "before" } ], "x-risk-level": "irreversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesLinksRevokeResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "page_id": "123e4567-e89b-42d3-a456-426614174001", "page_version_id": "123e4567-e89b-42d3-a456-426614174002", "page_version_number": 3, "label": "Customer review", "status": "REVOKED", "state": "revoked", "auth_version": 1, "expires_at": null, "max_visits": null, "visit_count": 4, "has_password": false, "access_mode": "ANONYMOUS", "allowed_emails": [], "allowed_domains": [], "submission_mode": "NONE", "submission_count": 0, "last_visited_at": "2026-09-04T12:00:00Z", "locale": null, "permissions": {}, "context": {}, "source_type": "USER", "source_id": null, "source_metadata": {}, "created_by": { "id": "123e4567-e89b-42d3-a456-426614174002", "name": "Ada Lovelace", "email": "ada@example.com" }, "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/page-links/{link_id}/rotate": { "post": { "operationId": "pagesLinksRotate", "summary": "Rotate a page link", "description": "Issue a new token for a link; the old url stops working immediately.", "tags": [ "Pages" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "link_id", "in": "path", "required": true, "description": "Resource identifier: link_id.", "schema": { "format": "uuid", "title": "Link Id", "type": "string" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "pages.links_rotate", "x-required-scope": "pages:write", "x-badges": [ { "name": "pages:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesLinksRotateResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "page_id": "123e4567-e89b-42d3-a456-426614174001", "page_version_id": "123e4567-e89b-42d3-a456-426614174002", "page_version_number": 3, "label": "Customer review", "status": "ACTIVE", "state": "active", "auth_version": 2, "expires_at": null, "max_visits": null, "visit_count": 4, "has_password": false, "access_mode": "ANONYMOUS", "allowed_emails": [], "allowed_domains": [], "submission_mode": "NONE", "submission_count": 0, "last_visited_at": "2026-09-04T12:00:00Z", "locale": null, "permissions": {}, "context": {}, "source_type": "USER", "source_id": null, "source_metadata": {}, "created_by": { "id": "123e4567-e89b-42d3-a456-426614174002", "name": "Ada Lovelace", "email": "ada@example.com" }, "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/page-links/{link_id}/retarget": { "post": { "operationId": "pagesLinksRetarget", "summary": "Retarget a page link", "description": "Point a link at another published version of the same page.", "tags": [ "Pages" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "link_id", "in": "path", "required": true, "description": "Resource identifier: link_id.", "schema": { "format": "uuid", "title": "Link Id", "type": "string" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "pages.links_retarget", "x-required-scope": "pages:write", "x-badges": [ { "name": "pages:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesLinksRetargetResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "page_id": "123e4567-e89b-42d3-a456-426614174001", "page_version_id": "123e4567-e89b-42d3-a456-426614174002", "page_version_number": 3, "label": "Customer review", "status": "ACTIVE", "state": "active", "auth_version": 1, "expires_at": null, "max_visits": null, "visit_count": 4, "has_password": false, "access_mode": "ANONYMOUS", "allowed_emails": [], "allowed_domains": [], "submission_mode": "NONE", "submission_count": 0, "last_visited_at": "2026-09-04T12:00:00Z", "locale": null, "permissions": {}, "context": {}, "source_type": "USER", "source_id": null, "source_metadata": {}, "created_by": { "id": "123e4567-e89b-42d3-a456-426614174002", "name": "Ada Lovelace", "email": "ada@example.com" }, "created_at": "2026-09-04T12:00:00Z", "updated_at": "2026-09-04T12:00:00Z" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesLinksRetargetRequest" }, "example": { "page_version_id": "123e4567-e89b-42d3-a456-426614174000" } } } } } }, "/pages/{page_id}/submissions": { "get": { "operationId": "pagesSubmissionsList", "summary": "List submissions", "description": "List submissions of a page, newest first, with attachments resolved to documents. Values follow the version's output_schema. Visitor email/name only for space managers.", "tags": [ "Pages" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "page_id", "in": "path", "required": true, "description": "Resource identifier: page_id.", "schema": { "format": "uuid", "title": "Page Id", "type": "string" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "link_id", "in": "query", "required": false, "description": "Filter or parameter: link_id.", "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "title": "Link Id" } }, { "name": "status", "in": "query", "required": false, "description": "Filter or parameter: status.", "schema": { "anyOf": [ { "enum": [ "RECEIVED", "PROCESSING", "PROCESSED", "FAILED" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } } ], "x-operation-key": "pages.submissions_list", "x-required-scope": "pages:read", "x-badges": [ { "name": "pages:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesSubmissionsListResponse" }, "example": { "items": [], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/page-submissions/{submission_id}": { "get": { "operationId": "pagesSubmissionsGet", "summary": "Get a submission", "description": "Read one submission with values, attachments and visitor.", "tags": [ "Pages" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "submission_id", "in": "path", "required": true, "description": "Resource identifier: submission_id.", "schema": { "format": "uuid", "title": "Submission Id", "type": "string" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "pages.submissions_get", "x-required-scope": "pages:read", "x-badges": [ { "name": "pages:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesSubmissionsGetResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "page_id": "123e4567-e89b-42d3-a456-426614174001", "page_version_id": "123e4567-e89b-42d3-a456-426614174002", "link_id": "123e4567-e89b-42d3-a456-426614174000", "visit_id": "123e4567-e89b-42d3-a456-426614174001", "values": { "email": "customer@example.com", "message": "Looks good." }, "attachments": {}, "viewer": { "id": "123e4567-e89b-42d3-a456-426614174002", "verified": true, "first_seen_at": "2026-09-04T12:00:00Z", "last_seen_at": "2026-09-04T12:00:00Z" }, "status": "RECEIVED", "failure_code": null, "processed_at": null, "submitted_at": "2026-09-04T12:00:00Z" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "patch": { "operationId": "pagesSubmissionsSetStatus", "summary": "Set the submission status", "description": "Mark a submission as PROCESSING, PROCESSED or FAILED after handling it.", "tags": [ "Pages" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "submission_id", "in": "path", "required": true, "description": "Resource identifier: submission_id.", "schema": { "format": "uuid", "title": "Submission Id", "type": "string" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "pages.submissions_set_status", "x-required-scope": "pages:write", "x-badges": [ { "name": "pages:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesSubmissionsSetStatusResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "page_id": "123e4567-e89b-42d3-a456-426614174001", "page_version_id": "123e4567-e89b-42d3-a456-426614174002", "link_id": "123e4567-e89b-42d3-a456-426614174000", "visit_id": "123e4567-e89b-42d3-a456-426614174001", "values": { "email": "customer@example.com", "message": "Looks good." }, "attachments": {}, "viewer": { "id": "123e4567-e89b-42d3-a456-426614174002", "verified": true, "first_seen_at": "2026-09-04T12:00:00Z", "last_seen_at": "2026-09-04T12:00:00Z" }, "status": "PROCESSED", "failure_code": null, "processed_at": "2026-09-04T12:00:00Z", "submitted_at": "2026-09-04T12:00:00Z" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesSubmissionsSetStatusRequest" }, "example": { "status": "RECEIVED" } } } } } }, "/pages/{page_id}/stats": { "get": { "operationId": "pagesStats", "summary": "Get page statistics", "description": "Aggregate statistics for a page or one of its links over the last N days: visits, unique visitors, median duration, submissions, downloads and a daily series.", "tags": [ "Pages" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "page_id", "in": "path", "required": true, "description": "Resource identifier: page_id.", "schema": { "format": "uuid", "title": "Page Id", "type": "string" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "link_id", "in": "query", "required": false, "description": "Filter or parameter: link_id.", "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "title": "Link Id" } }, { "name": "days", "in": "query", "required": false, "description": "Window ending today (UTC).", "schema": { "default": 30, "description": "Window ending today (UTC).", "maximum": 365, "minimum": 1, "title": "Days", "type": "integer" } } ], "x-operation-key": "pages.stats", "x-required-scope": "pages:read", "x-badges": [ { "name": "pages:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesStatsResponse" }, "example": { "page_id": "123e4567-e89b-42d3-a456-426614174000", "link_id": null, "days": 30, "totals": { "visits": 120, "unique_visitors": 87, "duration_median_seconds": 42, "duration_total_seconds": 5040, "submissions": 6, "downloads": 3 }, "daily": [ { "date": "2026-09-04", "visits": 12, "unique_visitors": 9, "submissions": 1, "downloads": 0, "duration_seconds_sum": 480 } ], "links": [ { "link_id": "123e4567-e89b-42d3-a456-426614174001", "label": "Customer review", "visit_count": 120, "submission_count": 6 } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/pages/{page_id}/visits": { "get": { "operationId": "pagesVisitsList", "summary": "List page visits", "description": "List visits of a page (newest first) with device, geo, duration and events. Visitor email/name only for space managers.", "tags": [ "Pages" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "page_id", "in": "path", "required": true, "description": "Resource identifier: page_id.", "schema": { "format": "uuid", "title": "Page Id", "type": "string" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "link_id", "in": "query", "required": false, "description": "Filter or parameter: link_id.", "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "title": "Link Id" } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } } ], "x-operation-key": "pages.visits_list", "x-required-scope": "pages:read", "x-badges": [ { "name": "pages:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagesVisitsListResponse" }, "example": { "items": [], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/integrations/catalog": { "get": { "operationId": "integrationsCatalogList", "summary": "List available providers", "description": "Catalog list", "tags": [ "Integrations" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "x-operation-key": "integrations.catalog.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsCatalogListResponse" }, "example": { "items": [ { "key": "summary", "contract_digest": "example", "display_name": "example", "description": "example", "category": "example", "icon_key": "example", "auth_schemes": [], "operations": [] } ], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/integrations/catalog/{provider_key}": { "get": { "operationId": "integrationsCatalogGet", "summary": "Get a provider", "description": "Catalog get", "tags": [ "Integrations" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "provider_key", "in": "path", "required": true, "description": "Resource identifier: provider_key.", "schema": { "type": "string" }, "example": "example" } ], "x-operation-key": "integrations.catalog.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsCatalogGetResponse" }, "example": { "key": "summary", "contract_digest": "example", "display_name": "example", "description": "example", "category": "example", "icon_key": "example", "auth_schemes": [ { "key": "summary", "strategy": "example", "public_config_schema": {}, "credential_schema": {}, "ui_schema": {}, "form_contract": { "profile_version": "example", "public_config": {} } } ], "operations": [ { "key": "summary", "resource": "example", "operation": "example", "description": "example", "input_schema": {}, "output_schema": {}, "effect": "example", "execution_mode": "example", "risk_level": "example", "requires_space": false, "timeout_seconds": 0, "max_retries": 0, "rate_limit_requests": 0, "rate_limit_window_seconds": 0, "max_payload_bytes": 0, "audit_fields": [], "value_sources": {} } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/integrations/status": { "get": { "operationId": "integrationsFoundationStatus", "summary": "Get integration platform status", "description": "Foundation status", "tags": [ "Integrations" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" } ], "x-operation-key": "integrations.foundation.status", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsFoundationStatusResponse" }, "example": { "status": "ACTIVE", "generated_at": "example", "build_revision": "example", "artifact_digests": {}, "gates": [ { "key": "summary", "passed": false, "reason": "example" } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/integrations/connections": { "get": { "operationId": "integrationsConnectionsList", "summary": "List connections", "description": "Connections list", "tags": [ "Integrations" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "x-operation-key": "integrations.connections.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsConnectionsListResponse" }, "example": { "items": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "provider_key": "klaviyo", "auth_scheme": "example", "label": "Customer documents", "external_identity": "example", "public_config": {}, "status": "ACTIVE", "enabled": false, "safe_error_code": "example", "test_summary": {}, "provider_contract_digest": "example", "last_tested_at": "example", "created_at": "example", "updated_at": "example" } ], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "post": { "operationId": "integrationsConnectionsCreate", "summary": "Create a connection", "description": "Connections create", "tags": [ "Integrations" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.connections.create", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "201": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsConnectionsCreateResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "provider_key": "klaviyo", "auth_scheme": "example", "label": "Customer documents", "external_identity": "example", "public_config": {}, "status": "ACTIVE", "enabled": false, "safe_error_code": "example", "test_summary": {}, "provider_contract_digest": "example", "last_tested_at": "example", "created_at": "example", "updated_at": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsConnectionsCreateRequest" }, "example": { "provider_key": "klaviyo", "label": "Customer documents", "credentials": {} } } } } } }, "/integrations/connections/{connection_id}": { "get": { "operationId": "integrationsConnectionsGet", "summary": "Get a connection", "description": "Connections get", "tags": [ "Integrations" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.connections.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsConnectionsGetResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "provider_key": "klaviyo", "auth_scheme": "example", "label": "Customer documents", "external_identity": "example", "public_config": {}, "status": "ACTIVE", "enabled": false, "safe_error_code": "example", "test_summary": {}, "provider_contract_digest": "example", "last_tested_at": "example", "created_at": "example", "updated_at": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "patch": { "operationId": "integrationsConnectionsUpdate", "summary": "Update a connection", "description": "Connections update", "tags": [ "Integrations" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.connections.update", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsConnectionsUpdateResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "provider_key": "klaviyo", "auth_scheme": "example", "label": "Customer documents", "external_identity": "example", "public_config": {}, "status": "ACTIVE", "enabled": false, "safe_error_code": "example", "test_summary": {}, "provider_contract_digest": "example", "last_tested_at": "example", "created_at": "example", "updated_at": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsConnectionsUpdateRequest" }, "example": {} } } } }, "delete": { "operationId": "integrationsConnectionsDelete", "summary": "Delete a connection", "description": "Connections delete", "tags": [ "Integrations" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.connections.delete", "x-required-scope": "integrations:destroy", "x-badges": [ { "name": "integrations:destroy", "position": "before" } ], "x-risk-level": "irreversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsConnectionsDeleteResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "deleted": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/integrations/connections/{connection_id}/credentials/rotate": { "post": { "operationId": "integrationsConnectionsCredentialsRotate", "summary": "Rotate connection credentials", "description": "Connections credentials rotate", "tags": [ "Integrations" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.connections.credentials.rotate", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsConnectionsCredentialsRotateResponse" }, "example": { "connection_id": "123e4567-e89b-42d3-a456-426614174000", "version": 0 } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsConnectionsCredentialsRotateRequest" }, "example": { "credentials": {} } } } } } }, "/integrations/connections/{connection_id}/test": { "post": { "operationId": "integrationsConnectionsTest", "summary": "Test a connection", "description": "Connections test", "tags": [ "Integrations" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.connections.test", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsConnectionsTestResponse" }, "example": { "connection_id": "123e4567-e89b-42d3-a456-426614174000", "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/integrations/connections/{connection_id}/disconnect": { "post": { "operationId": "integrationsConnectionsDisconnect", "summary": "Disconnect a connection", "description": "Connections disconnect", "tags": [ "Integrations" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.connections.disconnect", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsConnectionsDisconnectResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "provider_key": "klaviyo", "auth_scheme": "example", "label": "Customer documents", "external_identity": "example", "public_config": {}, "status": "ACTIVE", "enabled": false, "safe_error_code": "example", "test_summary": {}, "provider_contract_digest": "example", "last_tested_at": "example", "created_at": "example", "updated_at": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/integrations/usage": { "get": { "operationId": "integrationsConnectionsUsage", "summary": "Get connection usage", "description": "Connections usage", "tags": [ "Integrations" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "query", "required": false, "description": "Filter or parameter: connection_id.", "schema": { "type": "string", "format": "uuid" } }, { "name": "connection_ids", "in": "query", "required": false, "description": "Filter or parameter: connection_ids.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "style": "form", "explode": true }, { "name": "days", "in": "query", "required": false, "description": "Filter or parameter: days.", "schema": { "type": "integer", "minimum": 1, "maximum": 90 } } ], "x-operation-key": "integrations.connections.usage", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsConnectionsUsageResponse" }, "example": { "items": [ { "connection_id": "123e4567-e89b-42d3-a456-426614174000", "series": [] } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/integrations/connections/{connection_id}/dependencies": { "get": { "operationId": "integrationsConnectionsDependencies", "summary": "List connection dependencies", "description": "Connections dependencies", "tags": [ "Integrations" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.connections.dependencies", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsConnectionsDependenciesResponse" }, "example": { "items": [ { "consumer": "example", "id": "example", "name": "Customer documents", "space_id": "example" } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/integrations/authorizations": { "post": { "operationId": "integrationsAuthorizationsBegin", "summary": "Start an OAuth authorization", "description": "Authorizations begin", "tags": [ "Integrations" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.authorizations.begin", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "201": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAuthorizationsBeginResponse" }, "example": { "connection": { "id": "123e4567-e89b-42d3-a456-426614174000", "provider_key": "klaviyo", "auth_scheme": "example", "label": "Customer documents", "external_identity": "example", "public_config": {}, "status": "ACTIVE", "enabled": false, "safe_error_code": "example", "test_summary": {}, "provider_contract_digest": "example", "last_tested_at": "example", "created_at": "example", "updated_at": "example" } } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAuthorizationsBeginRequest" }, "example": { "provider_key": "klaviyo", "auth_scheme": "example", "label": "Customer documents" } } } } } }, "/integrations/authorizations/{session_id}": { "get": { "operationId": "integrationsAuthorizationsStatus", "summary": "Get authorization status", "description": "Authorizations status", "tags": [ "Integrations" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "session_id", "in": "path", "required": true, "description": "Resource identifier: session_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.authorizations.status", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAuthorizationsStatusResponse" }, "example": { "session_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "expires_at": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/integrations/authorizations/{session_id}/cancel": { "post": { "operationId": "integrationsAuthorizationsCancel", "summary": "Cancel an authorization", "description": "Authorizations cancel", "tags": [ "Integrations" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "session_id", "in": "path", "required": true, "description": "Resource identifier: session_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.authorizations.cancel", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAuthorizationsCancelResponse" }, "example": { "session_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "expires_at": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/integrations/grants": { "get": { "operationId": "integrationsGrantsList", "summary": "List grants", "description": "Grants list", "tags": [ "Integrations" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "x-operation-key": "integrations.grants.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGrantsListResponse" }, "example": { "items": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "connection_id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "allowed_operations": [], "safe_constraints": {}, "status": "ACTIVE", "provider_contract_digest": "example", "risk_acknowledgements": {}, "requires_reapproval": false, "contract_current": false } ], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "post": { "operationId": "integrationsGrantsCreate", "summary": "Create a grant", "description": "Grants create", "tags": [ "Integrations" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.grants.create", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "201": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGrantsCreateResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGrantsCreateRequest" }, "example": { "connection_id": "123e4567-e89b-42d3-a456-426614174000", "space_id": "123e4567-e89b-42d3-a456-426614174000", "allowed_operations": [] } } } } } }, "/integrations/grants/{grant_id}": { "patch": { "operationId": "integrationsGrantsUpdate", "summary": "Update a grant", "description": "Grants update", "tags": [ "Integrations" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "grant_id", "in": "path", "required": true, "description": "Resource identifier: grant_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.grants.update", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGrantsUpdateResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGrantsUpdateRequest" }, "example": {} } } } }, "delete": { "operationId": "integrationsGrantsRevoke", "summary": "Revoke a grant", "description": "Grants revoke", "tags": [ "Integrations" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "grant_id", "in": "path", "required": true, "description": "Resource identifier: grant_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.grants.revoke", "x-required-scope": "integrations:destroy", "x-badges": [ { "name": "integrations:destroy", "position": "before" } ], "x-risk-level": "irreversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGrantsRevokeResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/integrations/audit": { "get": { "operationId": "integrationsAuditList", "summary": "List integration audit events", "description": "Audit list", "tags": [ "Integrations" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "x-operation-key": "integrations.audit.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAuditListResponse" }, "example": { "items": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "connection_id": "123e4567-e89b-42d3-a456-426614174000", "provider_key": "klaviyo", "event_type": "example", "safe_details": {}, "origin": "manual", "created_at": "example" } ], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/integrations/invocations": { "get": { "operationId": "integrationsInvocationsList", "summary": "List invocations", "description": "Invocations list", "tags": [ "Integrations" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "x-operation-key": "integrations.invocations.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsInvocationsListResponse" }, "example": { "items": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "connection_id": "example", "provider_key": "klaviyo", "operation_key": "spaces.get", "source": "example", "effect": "example", "execution_mode": "example", "status": "ACTIVE", "safe_error_code": "example", "safe_summary": {}, "item_count": 0, "byte_count": 0, "retry_count": 0, "actor": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "space_id": "example", "consumer_kind": "example", "consumer_id": "example", "change_set_id": "example", "created_at": "example", "completed_at": "example" } ], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/integrations/invocations/{invocation_id}": { "get": { "operationId": "integrationsInvocationsGet", "summary": "Get an invocation", "description": "Invocations get", "tags": [ "Integrations" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "invocation_id", "in": "path", "required": true, "description": "Resource identifier: invocation_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.invocations.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsInvocationsGetResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "connection_id": "example", "provider_key": "klaviyo", "operation_key": "spaces.get", "source": "example", "effect": "example", "execution_mode": "example", "status": "ACTIVE", "safe_error_code": "example", "safe_summary": {}, "item_count": 0, "byte_count": 0, "retry_count": 0, "actor": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "space_id": "example", "consumer_kind": "example", "consumer_id": "example", "change_set_id": "example", "created_at": "example", "completed_at": "example", "output": {} } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/users/me": { "get": { "operationId": "usersMe", "summary": "Get the current user", "description": "Get your user profile.", "tags": [ "Users" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" } ], "x-operation-key": "users.me", "x-required-scope": "users:read", "x-badges": [ { "name": "users:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsersMeResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "developer@example.com", "name": "Customer documents", "image_url": "https://storage.example.com/invoice-2026-09.pdf?signature=example", "role": "ADMIN", "locale": "en", "tenant_id": "123e4567-e89b-42d3-a456-426614174000", "created_at": "2026-09-04T12:00:00Z", "is_platform_operator": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "patch": { "operationId": "usersMeUpdate", "summary": "Update the current user", "description": "Update your name or locale.", "tags": [ "Users" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "users.me.update", "x-required-scope": "users:write", "x-badges": [ { "name": "users:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsersMeUpdateResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "developer@example.com", "name": "Customer documents", "image_url": "https://storage.example.com/invoice-2026-09.pdf?signature=example", "role": "ADMIN", "locale": "en", "tenant_id": "123e4567-e89b-42d3-a456-426614174000", "created_at": "2026-09-04T12:00:00Z", "is_platform_operator": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsersMeUpdateRequest" }, "example": {} } } } } }, "/users": { "get": { "operationId": "usersList", "summary": "List users", "description": "List users in your tenant. Requires an admin.", "tags": [ "Users" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "x-operation-key": "users.list", "x-required-scope": "users:read", "x-badges": [ { "name": "users:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsersListResponse" }, "example": { "items": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "developer@example.com", "name": "Customer documents", "image_url": "https://storage.example.com/invoice-2026-09.pdf?signature=example", "role": "ADMIN", "locale": "en", "tenant_id": "123e4567-e89b-42d3-a456-426614174000", "created_at": "2026-09-04T12:00:00Z" } ], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/users/{user_id}": { "get": { "operationId": "usersGet", "summary": "Get a user", "description": "Get a user in your tenant.", "tags": [ "Users" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "user_id", "in": "path", "required": true, "description": "Resource identifier: user_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "users.get", "x-required-scope": "users:read", "x-badges": [ { "name": "users:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsersGetResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "developer@example.com", "name": "Customer documents", "image_url": "https://storage.example.com/invoice-2026-09.pdf?signature=example", "role": "ADMIN", "locale": "en", "tenant_id": "123e4567-e89b-42d3-a456-426614174000", "created_at": "2026-09-04T12:00:00Z" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "patch": { "operationId": "usersUpdateRole", "summary": "Update a user's role", "description": "Update a tenant user's role. Requires an admin.", "tags": [ "Users" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "user_id", "in": "path", "required": true, "description": "Resource identifier: user_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "users.update_role", "x-required-scope": "users:write", "x-badges": [ { "name": "users:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsersUpdateRoleResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "developer@example.com", "name": "Customer documents", "image_url": "https://storage.example.com/invoice-2026-09.pdf?signature=example", "role": "ADMIN", "locale": "en", "tenant_id": "123e4567-e89b-42d3-a456-426614174000", "created_at": "2026-09-04T12:00:00Z" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsersUpdateRoleRequest" }, "example": { "role": "ADMIN" } } } } }, "delete": { "operationId": "usersRemove", "summary": "Remove a user", "description": "Remove a tenant user. Requires an admin; users referenced by audit history cannot be removed.", "tags": [ "Users" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "user_id", "in": "path", "required": true, "description": "Resource identifier: user_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "users.remove", "x-required-scope": "users:destroy", "x-badges": [ { "name": "users:destroy", "position": "before" } ], "x-risk-level": "irreversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsersRemoveResponse" }, "example": { "user_id": "123e4567-e89b-42d3-a456-426614174000", "outcome": "deleted" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/tenant": { "get": { "operationId": "tenantsGet", "summary": "Get the tenant", "description": "Get your tenant. Requires an admin.", "tags": [ "Users" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" } ], "x-operation-key": "tenants.get", "x-required-scope": "tenant:read", "x-badges": [ { "name": "tenant:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantsGetResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "name": "Customer documents", "status": "ACTIVE", "created_at": "2026-09-04T12:00:00Z" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "patch": { "operationId": "tenantsUpdate", "summary": "Rename the tenant", "description": "Update your tenant name. Requires an admin.", "tags": [ "Users" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "tenants.update", "x-required-scope": "tenant:write", "x-badges": [ { "name": "tenant:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantsUpdateResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "name": "Customer documents", "status": "ACTIVE", "created_at": "2026-09-04T12:00:00Z" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantsUpdateRequest" }, "example": {} } } } } }, "/audit/events": { "get": { "operationId": "auditEventsList", "summary": "List audit events", "description": "List your tenant's immutable operation events. Requires an admin.", "tags": [ "Audit" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "from", "in": "query", "required": false, "description": "Filter or parameter: from.", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "description": "Filter or parameter: to.", "schema": { "type": "string", "format": "date-time" } }, { "name": "domain", "in": "query", "required": false, "description": "Filter or parameter: domain.", "schema": { "type": "string" } }, { "name": "operation_key", "in": "query", "required": false, "description": "Filter or parameter: operation_key.", "schema": { "type": "string" } }, { "name": "entity_type", "in": "query", "required": false, "description": "Filter or parameter: entity_type.", "schema": { "type": "string" } }, { "name": "entity_id", "in": "query", "required": false, "description": "Filter or parameter: entity_id.", "schema": { "type": "string" } }, { "name": "actor_id", "in": "query", "required": false, "description": "Filter or parameter: actor_id.", "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "x-operation-key": "audit.events.list", "x-required-scope": "audit:read", "x-badges": [ { "name": "audit:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditEventsListResponse" }, "example": { "items": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "sequence": 0, "operation_key": "spaces.get", "entity_type": "space", "entity_id": "123e4567-e89b-42d3-a456-426614174000", "actor_id": "123e4567-e89b-42d3-a456-426614174000", "actor": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "actor_type": "api", "credential_id": "123e4567-e89b-42d3-a456-426614174000", "origin_kind": "example", "origin_id": "example", "space_id": "123e4567-e89b-42d3-a456-426614174000", "payload": {}, "created_at": "2026-09-04T12:00:00Z", "event_hash": "3f786850e387550fdab836ed7e6dc881de23001b3f786850e387550fdab836ed" } ], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/audit/events/{event_id}": { "get": { "operationId": "auditEventsGet", "summary": "Get an audit event", "description": "Get one tenant operation event. Requires an admin.", "tags": [ "Audit" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "event_id", "in": "path", "required": true, "description": "Resource identifier: event_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "audit.events.get", "x-required-scope": "audit:read", "x-badges": [ { "name": "audit:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditEventsGetResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "sequence": 0, "operation_key": "spaces.get", "entity_type": "space", "entity_id": "123e4567-e89b-42d3-a456-426614174000", "actor_id": "123e4567-e89b-42d3-a456-426614174000", "actor": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "actor_type": "api", "credential_id": "123e4567-e89b-42d3-a456-426614174000", "origin_kind": "example", "origin_id": "example", "space_id": "123e4567-e89b-42d3-a456-426614174000", "payload": {}, "created_at": "2026-09-04T12:00:00Z", "event_hash": "3f786850e387550fdab836ed7e6dc881de23001b3f786850e387550fdab836ed" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/audit/changes/{change_set_id}": { "get": { "operationId": "auditChangeSetsGet", "summary": "Get a change set", "description": "Get the sanitized request and snapshots of a tenant change. Requires an admin.", "tags": [ "Audit" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "change_set_id", "in": "path", "required": true, "description": "Resource identifier: change_set_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "audit.change_sets.get", "x-required-scope": "audit:read", "x-badges": [ { "name": "audit:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditChangeSetsGetResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "operation_key": "spaces.get", "actor_id": "123e4567-e89b-42d3-a456-426614174000", "actor": { "id": "123e4567-e89b-42d3-a456-426614174000", "email": "ada@example.com", "name": "Customer documents", "image_url": "example" }, "actor_type": "api", "credential_id": "123e4567-e89b-42d3-a456-426614174000", "origin_kind": "example", "origin_id": "example", "space_id": "123e4567-e89b-42d3-a456-426614174000", "entity_type": "space", "entity_id": "123e4567-e89b-42d3-a456-426614174000", "request_data": {}, "before_snapshot": {}, "after_snapshot": {}, "result_data": {}, "created_at": "2026-09-04T12:00:00Z" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/audit/verify": { "get": { "operationId": "auditChainVerify", "summary": "Verify the audit chain", "description": "Verify tenant audit event signatures and chain continuity. Requires an admin.", "tags": [ "Audit" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "from_sequence", "in": "query", "required": false, "description": "Filter or parameter: from_sequence.", "schema": { "type": "integer", "minimum": 1 } }, { "name": "to_sequence", "in": "query", "required": false, "description": "Filter or parameter: to_sequence.", "schema": { "type": "integer", "minimum": 1 } } ], "x-operation-key": "audit.chain.verify", "x-required-scope": "audit:read", "x-badges": [ { "name": "audit:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditChainVerifyResponse" }, "example": { "valid": false, "checked_events": 0, "errors": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/audit/api-requests": { "get": { "operationId": "auditApiRequestsList", "summary": "List API requests", "description": "List tenant API request metadata. Requires an admin.", "tags": [ "Audit" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "from", "in": "query", "required": false, "description": "Filter or parameter: from.", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "description": "Filter or parameter: to.", "schema": { "type": "string", "format": "date-time" } }, { "name": "api_key_id", "in": "query", "required": false, "description": "Filter or parameter: api_key_id.", "schema": { "type": "string", "format": "uuid" } }, { "name": "status", "in": "query", "required": false, "description": "Filter or parameter: status.", "schema": { "type": "integer", "minimum": 100, "maximum": 599 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "x-operation-key": "audit.api_requests.list", "x-required-scope": "audit:read", "x-badges": [ { "name": "audit:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditApiRequestsListResponse" }, "example": { "items": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "api_key_id": "123e4567-e89b-42d3-a456-426614174000", "user_id": "123e4567-e89b-42d3-a456-426614174000", "request_id": "req_01J8ZK2M7Q3N5X9V4B6C8D0E2F", "method": "GET", "path_template": "/spaces/{space_id}", "operation_key": "spaces.get", "status": 0, "duration_ms": 0, "ip": "203.0.113.10", "user_agent": "adlass-python/1.0.0", "created_at": "2026-09-04T12:00:00Z" } ], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/api-keys": { "get": { "operationId": "apiKeysList", "summary": "List API keys", "description": "List your API keys, or all tenant keys for an administrator.", "tags": [ "API keys" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque continuation cursor from the previous response.", "schema": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, { "name": "limit", "in": "query", "required": false, "description": "Filter or parameter: limit.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "x-operation-key": "api_keys.list", "x-required-scope": "api_keys:read", "x-badges": [ { "name": "api_keys:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeysListResponse" }, "example": { "items": [ { "id": "123e4567-e89b-42d3-a456-426614174000", "user_id": "123e4567-e89b-42d3-a456-426614174000", "label": "Customer documents", "prefix": "adl_live_a1", "scopes": [], "expires_at": "2026-09-04T12:00:00Z", "last_used_at": "2026-09-04T12:00:00Z", "revoked_at": "2026-09-04T12:00:00Z", "grace_until": "2026-09-04T12:00:00Z", "created_at": "2026-09-04T12:00:00Z", "rate_limit_per_minute": 0, "rotated_from": "123e4567-e89b-42d3-a456-426614174000", "status": "active" } ], "next_cursor": null } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/api-keys/{key_id}": { "get": { "operationId": "apiKeysGet", "summary": "Get an API key", "description": "Get API key metadata without its secret.", "tags": [ "API keys" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "key_id", "in": "path", "required": true, "description": "Resource identifier: key_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "api_keys.get", "x-required-scope": "api_keys:read", "x-badges": [ { "name": "api_keys:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeysGetResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "user_id": "123e4567-e89b-42d3-a456-426614174000", "label": "Customer documents", "prefix": "adl_live_a1", "scopes": [], "expires_at": "2026-09-04T12:00:00Z", "last_used_at": "2026-09-04T12:00:00Z", "revoked_at": "2026-09-04T12:00:00Z", "grace_until": "2026-09-04T12:00:00Z", "created_at": "2026-09-04T12:00:00Z", "rate_limit_per_minute": 0, "rotated_from": "123e4567-e89b-42d3-a456-426614174000", "status": "active" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } }, "patch": { "operationId": "apiKeysUpdate", "summary": "Update an API key", "description": "Rename your API key or narrow its scopes.", "tags": [ "API keys" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "key_id", "in": "path", "required": true, "description": "Resource identifier: key_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "api_keys.update", "x-required-scope": "api_keys:write", "x-badges": [ { "name": "api_keys:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeysUpdateResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "user_id": "123e4567-e89b-42d3-a456-426614174000", "label": "Customer documents", "prefix": "adl_live_a1", "scopes": [], "expires_at": "2026-09-04T12:00:00Z", "last_used_at": "2026-09-04T12:00:00Z", "revoked_at": "2026-09-04T12:00:00Z", "grace_until": "2026-09-04T12:00:00Z", "created_at": "2026-09-04T12:00:00Z", "rate_limit_per_minute": 0, "rotated_from": "123e4567-e89b-42d3-a456-426614174000", "status": "active" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeysUpdateRequest" }, "example": {} } } } }, "delete": { "operationId": "apiKeysRevoke", "summary": "Revoke an API key", "description": "Permanently revoke your API key, or any tenant key for an administrator.", "tags": [ "API keys" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "key_id", "in": "path", "required": true, "description": "Resource identifier: key_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "api_keys.revoke", "x-required-scope": "api_keys:destroy", "x-badges": [ { "name": "api_keys:destroy", "position": "before" } ], "x-risk-level": "irreversible", "x-effect": "write", "x-execution-mode": "sync", "x-idempotent": false, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeysRevokeResponse" }, "example": { "id": "123e4567-e89b-42d3-a456-426614174000", "user_id": "123e4567-e89b-42d3-a456-426614174000", "label": "Customer documents", "prefix": "adl_live_a1", "scopes": [], "expires_at": "2026-09-04T12:00:00Z", "last_used_at": "2026-09-04T12:00:00Z", "revoked_at": "2026-09-04T12:00:00Z", "grace_until": "2026-09-04T12:00:00Z", "created_at": "2026-09-04T12:00:00Z", "rate_limit_per_minute": 0, "rotated_from": "123e4567-e89b-42d3-a456-426614174000", "status": "active" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/api-keys/{key_id}/usage": { "get": { "operationId": "apiKeysUsage", "summary": "Get API key usage", "description": "Get request totals and daily usage for an API key over the last 1 to 90 days.", "tags": [ "API keys" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "key_id", "in": "path", "required": true, "description": "Resource identifier: key_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "name": "days", "in": "query", "required": false, "description": "Filter or parameter: days.", "schema": { "type": "integer", "minimum": 1, "maximum": 90, "default": 30 } } ], "x-operation-key": "api_keys.usage", "x-required-scope": "api_keys:read", "x-badges": [ { "name": "api_keys:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeysUsageResponse" }, "example": { "key_id": "123e4567-e89b-42d3-a456-426614174000", "days": 0, "total_requests": 0, "successful_requests": 0, "error_requests": 0, "items": [ { "date": "2026-09-04", "requests": 0, "errors": 0 } ] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } } } }, "/integrations/connections/{connection_id}/providers/attio/attributes/list": { "post": { "operationId": "integrationsAttioAttributesList", "summary": "List the attributes of an object or a list, including type and options config.", "description": "List the attributes of an object or a list, including type and options config.", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.attributes.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioAttributesListResponse" }, "example": { "items": [], "has_more": false, "next_offset": 0 } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioAttributesListRequest" }, "example": { "identifier": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/attio/emails/list": { "post": { "operationId": "integrationsAttioEmailsList", "summary": "List email metadata (subject, participants, direction); email content is never exposed.", "description": "List email metadata (subject, participants, direction); email content is never exposed.", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.emails.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioEmailsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioEmailsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/attio/entries/get": { "post": { "operationId": "integrationsAttioEntriesGet", "summary": "Get one list entry with its current values.", "description": "Get one list entry with its current values.", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.entries.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioEntriesGetResponse" }, "example": { "entry_id": "example", "list_id": "example", "parent_object": "example", "parent_record_id": "example", "created_at": "example", "values": {} } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioEntriesGetRequest" }, "example": { "list": "example", "entry_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/attio/entries/query": { "post": { "operationId": "integrationsAttioEntriesQuery", "summary": "Query the entries of a list with Attio filters and sorts; entry values are flattened.", "description": "Query the entries of a list with Attio filters and sorts; entry values are flattened.", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.entries.query", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioEntriesQueryResponse" }, "example": { "items": [], "has_more": false, "next_offset": 0 } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioEntriesQueryRequest" }, "example": { "list": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/attio/lists/get": { "post": { "operationId": "integrationsAttioListsGet", "summary": "Get one list by slug or ID.", "description": "Get one list by slug or ID.", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.lists.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioListsGetResponse" }, "example": { "list_id": "example", "api_slug": "example", "name": "Customer documents", "parent_object": [], "workspace_access": "example", "created_by": { "type": "run.completed", "id": "example" }, "created_at": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioListsGetRequest" }, "example": { "list": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/attio/lists/list": { "post": { "operationId": "integrationsAttioListsList", "summary": "List the lists (pipelines, collections) of the workspace.", "description": "List the lists (pipelines, collections) of the workspace.", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.lists.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioListsListResponse" }, "example": { "items": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioListsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/attio/meetings/get": { "post": { "operationId": "integrationsAttioMeetingsGet", "summary": "Get one meeting.", "description": "Get one meeting.", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.meetings.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioMeetingsGetResponse" }, "example": { "meeting_id": "example", "title": "Approve supplier payment", "description": "example", "is_all_day": false, "start": { "datetime": "example", "date": "example", "timezone": "example" }, "end": { "datetime": "example", "date": "example", "timezone": "example" }, "participants": [], "linked_records": [], "created_by": { "type": "run.completed", "id": "example" }, "created_at": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioMeetingsGetRequest" }, "example": { "meeting_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/attio/meetings/list": { "post": { "operationId": "integrationsAttioMeetingsList", "summary": "List meetings with optional filters by linked record, participants, and time window.", "description": "List meetings with optional filters by linked record, participants, and time window.", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.meetings.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioMeetingsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioMeetingsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/attio/notes/get": { "post": { "operationId": "integrationsAttioNotesGet", "summary": "Get one note with plaintext and markdown content.", "description": "Get one note with plaintext and markdown content.", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.notes.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioNotesGetResponse" }, "example": { "note_id": "example", "parent_object": "example", "parent_record_id": "example", "title": "Approve supplier payment", "content_plaintext": "example", "created_by": { "type": "run.completed", "id": "example" }, "created_at": "example", "content_markdown": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioNotesGetRequest" }, "example": { "note_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/attio/notes/list": { "post": { "operationId": "integrationsAttioNotesList", "summary": "List notes, optionally scoped to one parent record.", "description": "List notes, optionally scoped to one parent record.", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.notes.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioNotesListResponse" }, "example": { "items": [], "has_more": false, "next_offset": 0 } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioNotesListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/attio/objects/get": { "post": { "operationId": "integrationsAttioObjectsGet", "summary": "Get one object by slug or ID.", "description": "Get one object by slug or ID.", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.objects.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioObjectsGetResponse" }, "example": { "object_id": "example", "api_slug": "example", "singular_noun": "example", "plural_noun": "example", "created_at": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioObjectsGetRequest" }, "example": { "object": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/attio/objects/list": { "post": { "operationId": "integrationsAttioObjectsList", "summary": "List the objects (people, companies, deals, custom objects) of the workspace.", "description": "List the objects (people, companies, deals, custom objects) of the workspace.", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.objects.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioObjectsListResponse" }, "example": { "items": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioObjectsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/attio/record-entries/list": { "post": { "operationId": "integrationsAttioRecordEntriesList", "summary": "List the list entries that reference a record.", "description": "List the list entries that reference a record.", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.record_entries.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioRecordEntriesListResponse" }, "example": { "items": [], "has_more": false, "next_offset": 0 } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioRecordEntriesListRequest" }, "example": { "object": "example", "record_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/attio/record-values/list": { "post": { "operationId": "integrationsAttioRecordValuesList", "summary": "List the values of one attribute on a record, optionally including history.", "description": "List the values of one attribute on a record, optionally including history.", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.record_values.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioRecordValuesListResponse" }, "example": { "items": [], "has_more": false, "next_offset": 0 } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioRecordValuesListRequest" }, "example": { "object": "example", "record_id": "example", "attribute": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/attio/records/get": { "post": { "operationId": "integrationsAttioRecordsGet", "summary": "Get one record with its current attribute values.", "description": "Get one record with its current attribute values.", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.records.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioRecordsGetResponse" }, "example": { "record_id": "example", "object": "example", "web_url": "example", "created_at": "example", "values": {} } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioRecordsGetRequest" }, "example": { "object": "example", "record_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/attio/records/query": { "post": { "operationId": "integrationsAttioRecordsQuery", "summary": "Query the records of an object with Attio filters and sorts; values are flattened per attribute.", "description": "Query the records of an object with Attio filters and sorts; values are flattened per attribute.", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.records.query", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioRecordsQueryResponse" }, "example": { "items": [], "has_more": false, "next_offset": 0 } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioRecordsQueryRequest" }, "example": { "object": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/attio/records/search": { "post": { "operationId": "integrationsAttioRecordsSearch", "summary": "Full-text search across one or more objects (eventually consistent).", "description": "Full-text search across one or more objects (eventually consistent).", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.records.search", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioRecordsSearchResponse" }, "example": { "items": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioRecordsSearchRequest" }, "example": { "query": "example", "objects": [ "example" ] } } } } } }, "/integrations/connections/{connection_id}/providers/attio/select-options/list": { "post": { "operationId": "integrationsAttioSelectOptionsList", "summary": "List the options of a select attribute on an object or a list.", "description": "List the options of a select attribute on an object or a list.", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.select_options.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioSelectOptionsListResponse" }, "example": { "items": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioSelectOptionsListRequest" }, "example": { "identifier": "example", "attribute": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/attio/statuses/list": { "post": { "operationId": "integrationsAttioStatusesList", "summary": "List the statuses of a status attribute on an object or a list.", "description": "List the statuses of a status attribute on an object or a list.", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.statuses.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioStatusesListResponse" }, "example": { "items": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioStatusesListRequest" }, "example": { "identifier": "example", "attribute": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/attio/tasks/get": { "post": { "operationId": "integrationsAttioTasksGet", "summary": "Get one task.", "description": "Get one task.", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.tasks.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioTasksGetResponse" }, "example": { "task_id": "example", "content_plaintext": "example", "deadline_at": "example", "is_completed": false, "completed_at": "example", "linked_records": [], "assignees": [], "created_by": { "type": "run.completed", "id": "example" }, "created_at": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioTasksGetRequest" }, "example": { "task_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/attio/tasks/list": { "post": { "operationId": "integrationsAttioTasksList", "summary": "List tasks with optional filters by linked record, assignee, and completion.", "description": "List tasks with optional filters by linked record, assignee, and completion.", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.tasks.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioTasksListResponse" }, "example": { "items": [], "has_more": false, "next_offset": 0 } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioTasksListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/attio/threads/get": { "post": { "operationId": "integrationsAttioThreadsGet", "summary": "Get one comment thread with all comments.", "description": "Get one comment thread with all comments.", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.threads.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioThreadsGetResponse" }, "example": { "thread_id": "example", "comments": [], "created_at": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioThreadsGetRequest" }, "example": { "thread_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/attio/threads/list": { "post": { "operationId": "integrationsAttioThreadsList", "summary": "List comment threads on a record or a list entry.", "description": "List comment threads on a record or a list entry.", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.threads.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioThreadsListResponse" }, "example": { "items": [], "has_more": false, "next_offset": 0 } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioThreadsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/attio/views/list": { "post": { "operationId": "integrationsAttioViewsList", "summary": "List the saved views of an object or a list; view IDs can filter record queries.", "description": "List the saved views of an object or a list; view IDs can filter record queries.", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.views.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioViewsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioViewsListRequest" }, "example": { "identifier": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/attio/workspace-members/get": { "post": { "operationId": "integrationsAttioWorkspaceMembersGet", "summary": "Get one workspace member.", "description": "Get one workspace member.", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.workspace_members.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioWorkspaceMembersGetResponse" }, "example": { "workspace_member_id": "example", "first_name": "example", "last_name": "example", "email_address": "example", "access_level": "example", "created_at": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioWorkspaceMembersGetRequest" }, "example": { "workspace_member_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/attio/workspace-members/list": { "post": { "operationId": "integrationsAttioWorkspaceMembersList", "summary": "List the members of the workspace.", "description": "List the members of the workspace.", "tags": [ "Attio" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.attio.workspace_members.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioWorkspaceMembersListResponse" }, "example": { "items": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsAttioWorkspaceMembersListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/facturacion/catalogs/list": { "post": { "operationId": "integrationsFacturacionCatalogsList", "summary": "List one DIAN reference table: identification types, unit codes, payment forms and methods, tax types, departments, municipalities or correction concepts for notes.", "description": "List one DIAN reference table: identification types, unit codes, payment forms and methods, tax types, departments, municipalities or correction concepts for notes.", "tags": [ "Facturación" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.facturacion.catalogs.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsFacturacionCatalogsListResponse" }, "example": { "table": "identification_types", "items": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsFacturacionCatalogsListRequest" }, "example": { "table": "identification_types" } } } } } }, "/integrations/connections/{connection_id}/providers/facturacion/company/get": { "post": { "operationId": "integrationsFacturacionCompanyGet", "summary": "Read the issuing company as registered with the technology provider: DIAN habilitation status, certificate validity, email notifications and logo.", "description": "Read the issuing company as registered with the technology provider: DIAN habilitation status, certificate validity, email notifications and logo.", "tags": [ "Facturación" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.facturacion.company.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsFacturacionCompanyGetResponse" }, "example": { "provider_company_id": "example", "name": "Customer documents", "trade_name": "example", "nit": "example", "dv": "example", "government_status_invoices": "example", "government_status_payrolls": "example", "uses_alegra_certificate": false, "certificate_valid_until": "example", "notification_by_email_enabled": false, "email": "ada@example.com", "has_logo": false, "habilitated": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsFacturacionCompanyGetRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/facturacion/company/update": { "post": { "operationId": "integrationsFacturacionCompanyUpdate", "summary": "Update the issuing company at the technology provider: logo for the PDF representation, automatic email notifications and the profile stored in the connection.", "description": "Update the issuing company at the technology provider: logo for the PDF representation, automatic email notifications and the profile stored in the connection.", "tags": [ "Facturación" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.facturacion.company.update", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsFacturacionCompanyUpdateResponse" }, "example": { "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "job_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsFacturacionCompanyUpdateRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/facturacion/credit-notes/create": { "post": { "operationId": "integrationsFacturacionCreditNotesCreate", "summary": "Issue an electronic credit note (nota crédito) against an accepted invoice, with the DIAN correction concept, and archive the files into the Space.", "description": "Issue an electronic credit note (nota crédito) against an accepted invoice, with the DIAN correction concept, and archive the files into the Space.", "tags": [ "Facturación" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.facturacion.credit_notes.create", "x-required-scope": "integrations:destroy", "x-badges": [ { "name": "integrations:destroy", "position": "before" }, { "name": "External side effect" } ], "x-risk-level": "irreversible", "x-effect": "external_side_effect", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsFacturacionCreditNotesCreateResponse" }, "example": { "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "job_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsFacturacionCreditNotesCreateRequest" }, "example": { "number": 1, "payments": [ {} ], "concept_code": "1", "customer": { "name": "Customer documents", "identification_number": "example" }, "items": [ { "description": "example", "quantity": 1, "price": 0 } ] } } } } } }, "/integrations/connections/{connection_id}/providers/facturacion/debit-notes/create": { "post": { "operationId": "integrationsFacturacionDebitNotesCreate", "summary": "Issue an electronic debit note (nota débito) against an accepted invoice, with the DIAN concept, and archive the files into the Space.", "description": "Issue an electronic debit note (nota débito) against an accepted invoice, with the DIAN concept, and archive the files into the Space.", "tags": [ "Facturación" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.facturacion.debit_notes.create", "x-required-scope": "integrations:destroy", "x-badges": [ { "name": "integrations:destroy", "position": "before" }, { "name": "External side effect" } ], "x-risk-level": "irreversible", "x-effect": "external_side_effect", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsFacturacionDebitNotesCreateResponse" }, "example": { "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "job_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsFacturacionDebitNotesCreateRequest" }, "example": { "number": 1, "payments": [ {} ], "concept_code": "1", "affected_document": { "dian_uuid": "0000000000000000000000000000000000000000", "number": 0, "issue_date": "2026-09-04" }, "customer": { "name": "Customer documents", "identification_number": "example" }, "items": [ { "description": "example", "quantity": 1, "price": 0 } ] } } } } } }, "/integrations/connections/{connection_id}/providers/facturacion/dian/query": { "post": { "operationId": "integrationsFacturacionDianQuery", "summary": "Query the DIAN by CUFE, CUDE or CUDS: authorization status, document summary, related notes and events, optionally archiving the XML into the Space.", "description": "Query the DIAN by CUFE, CUDE or CUDS: authorization status, document summary, related notes and events, optionally archiving the XML into the Space.", "tags": [ "Facturación" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.facturacion.dian.query", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsFacturacionDianQueryResponse" }, "example": { "track_id": "example", "dian_status": "example", "document_date": "example", "document_number": "example", "status_description": "example", "status_message": "example", "currency_code": "example", "subtotal": 0, "tax_total": 0, "total": 0, "notifications": [], "notes": [], "events": [], "xml_available": false, "xml_document_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsFacturacionDianQueryRequest" }, "example": { "track_id": "0000000000000000000000000000000000000000" } } } } } }, "/integrations/connections/{connection_id}/providers/facturacion/documents/get": { "post": { "operationId": "integrationsFacturacionDocumentsGet", "summary": "Refresh one electronic document issued through this connection: DIAN status, legal status, government response and files (XML, DIAN response, ZIP) archived into the Space.", "description": "Refresh one electronic document issued through this connection: DIAN status, legal status, government response and files (XML, DIAN response, ZIP) archived into the Space.", "tags": [ "Facturación" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.facturacion.documents.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsFacturacionDocumentsGetResponse" }, "example": { "provider_document_id": "example", "kind": "invoice", "document_type": "example", "prefix": "adl_live_a1", "number": 0, "full_number": "example", "dian_uuid": "example", "status": "ACTIVE", "legal_status": "example", "issued_at": "example", "government_response": { "code": "example", "message": "Please review the extracted totals.", "error_messages": [] }, "errors": [], "qr_code_content": "example", "files": { "xml_url": "example", "attached_document_url": "example", "zip_url": "example" }, "documents": { "xml_document_id": "example", "attached_document_id": "example", "zip_document_id": "example" }, "counterparty_identification": "example", "counterparty_name": "example", "totals": { "gross_total": 0, "taxable_total": 0, "tax_total": 0, "payable_total": 0, "currency_code": "example" }, "concept_code": "example", "affected_document_uuid": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsFacturacionDocumentsGetRequest" }, "example": { "kind": "invoice", "provider_document_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/facturacion/documents/send-email": { "post": { "operationId": "integrationsFacturacionDocumentsSendEmail", "summary": "Send the DIAN-accepted electronic document by email to the customer (or to an explicit recipient) through the technology provider.", "description": "Send the DIAN-accepted electronic document by email to the customer (or to an explicit recipient) through the technology provider.", "tags": [ "Facturación" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.facturacion.documents.send_email", "x-required-scope": "integrations:destroy", "x-badges": [ { "name": "integrations:destroy", "position": "before" }, { "name": "External side effect" } ], "x-risk-level": "irreversible", "x-effect": "external_side_effect", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsFacturacionDocumentsSendEmailResponse" }, "example": { "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "job_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsFacturacionDocumentsSendEmailRequest" }, "example": { "kind": "invoice", "provider_document_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/facturacion/invoices/create": { "post": { "operationId": "integrationsFacturacionInvoicesCreate", "summary": "Issue an electronic sales invoice (factura electrónica de venta) to the DIAN through the technology provider and archive XML, DIAN response and ZIP into the Space.", "description": "Issue an electronic sales invoice (factura electrónica de venta) to the DIAN through the technology provider and archive XML, DIAN response and ZIP into the Space.", "tags": [ "Facturación" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.facturacion.invoices.create", "x-required-scope": "integrations:destroy", "x-badges": [ { "name": "integrations:destroy", "position": "before" }, { "name": "External side effect" } ], "x-risk-level": "irreversible", "x-effect": "external_side_effect", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsFacturacionInvoicesCreateResponse" }, "example": { "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "job_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsFacturacionInvoicesCreateRequest" }, "example": { "number": 1, "payments": [ {} ], "customer": { "name": "Customer documents", "identification_number": "example" }, "items": [ { "description": "example", "quantity": 1, "price": 0 } ] } } } } } }, "/integrations/connections/{connection_id}/providers/facturacion/resolutions/list": { "post": { "operationId": "integrationsFacturacionResolutionsList", "summary": "List the DIAN numbering resolutions (prefix, range, validity, technical key) of the issuing company; only available in production.", "description": "List the DIAN numbering resolutions (prefix, range, validity, technical key) of the issuing company; only available in production.", "tags": [ "Facturación" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.facturacion.resolutions.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsFacturacionResolutionsListResponse" }, "example": { "items": [], "available": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsFacturacionResolutionsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/facturacion/support-documents/create": { "post": { "operationId": "integrationsFacturacionSupportDocumentsCreate", "summary": "Issue an electronic support document (documento soporte) for purchases from suppliers not obliged to invoice and archive the files into the Space.", "description": "Issue an electronic support document (documento soporte) for purchases from suppliers not obliged to invoice and archive the files into the Space.", "tags": [ "Facturación" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.facturacion.support_documents.create", "x-required-scope": "integrations:destroy", "x-badges": [ { "name": "integrations:destroy", "position": "before" }, { "name": "External side effect" } ], "x-risk-level": "irreversible", "x-effect": "external_side_effect", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsFacturacionSupportDocumentsCreateResponse" }, "example": { "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "job_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsFacturacionSupportDocumentsCreateRequest" }, "example": { "number": 1, "payments": [ {} ], "supplier": { "name": "Customer documents", "identification_number": "example" }, "items": [ { "description": "example", "quantity": 1, "price": 0 } ] } } } } } }, "/integrations/connections/{connection_id}/providers/gdrive/drives/list": { "post": { "operationId": "integrationsGdriveDrivesList", "summary": "List shared Google Drives with cursor pagination; use root for My Drive.", "description": "List shared Google Drives with cursor pagination; use root for My Drive.", "tags": [ "Google Drive" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.gdrive.drives.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGdriveDrivesListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGdriveDrivesListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/gdrive/files/get": { "post": { "operationId": "integrationsGdriveFilesGet", "summary": "Read Google Drive file metadata and supported import format.", "description": "Read Google Drive file metadata and supported import format.", "tags": [ "Google Drive" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.gdrive.files.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGdriveFilesGetResponse" }, "example": { "file_id": "example", "name": "Customer documents", "mime_type": "example", "is_folder": false, "size": 0, "modified_at": "example", "content_hash": "3f786850e387550fdab836ed7e6dc881de23001b", "web_url": "example", "drive_id": "example", "importable": false, "export_mime_type": "example", "shortcut_target_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGdriveFilesGetRequest" }, "example": { "file_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/gdrive/files/import": { "post": { "operationId": "integrationsGdriveFilesImport", "summary": "Import a Google Drive file or supported Workspace export into a Space.", "description": "Import a Google Drive file or supported Workspace export into a Space.", "tags": [ "Google Drive" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.gdrive.files.import", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" }, { "name": "External side effect" } ], "x-risk-level": "reversible", "x-effect": "external_side_effect", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGdriveFilesImportResponse" }, "example": { "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "job_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGdriveFilesImportRequest" }, "example": { "file_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/gdrive/files/list": { "post": { "operationId": "integrationsGdriveFilesList", "summary": "List a Google Drive folder's children with cursor pagination.", "description": "List a Google Drive folder's children with cursor pagination.", "tags": [ "Google Drive" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.gdrive.files.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGdriveFilesListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGdriveFilesListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/gdrive/files/upload": { "post": { "operationId": "integrationsGdriveFilesUpload", "summary": "Upload a stored Space document into a Google Drive folder as a new file.", "description": "Upload a stored Space document into a Google Drive folder as a new file.", "tags": [ "Google Drive" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.gdrive.files.upload", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" }, { "name": "External side effect" } ], "x-risk-level": "reversible", "x-effect": "external_side_effect", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGdriveFilesUploadResponse" }, "example": { "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "job_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGdriveFilesUploadRequest" }, "example": { "document_id": "example", "folder_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/gmail/attachments/import": { "post": { "operationId": "integrationsGmailAttachmentsImport", "summary": "Import one bounded Gmail attachment into a Space as a new document.", "description": "Import one bounded Gmail attachment into a Space as a new document.", "tags": [ "Gmail" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.gmail.attachments.import", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" }, { "name": "External side effect" } ], "x-risk-level": "reversible", "x-effect": "external_side_effect", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGmailAttachmentsImportResponse" }, "example": { "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "job_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGmailAttachmentsImportRequest" }, "example": { "message_id": "example", "attachment_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/gmail/attachments/list": { "post": { "operationId": "integrationsGmailAttachmentsList", "summary": "List attachment metadata for one message without downloading content.", "description": "List attachment metadata for one message without downloading content.", "tags": [ "Gmail" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.gmail.attachments.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGmailAttachmentsListResponse" }, "example": { "items": [], "truncated": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGmailAttachmentsListRequest" }, "example": { "message_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/gmail/labels/list": { "post": { "operationId": "integrationsGmailLabelsList", "summary": "List the labels of the Gmail mailbox.", "description": "List the labels of the Gmail mailbox.", "tags": [ "Gmail" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.gmail.labels.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGmailLabelsListResponse" }, "example": { "items": [], "truncated": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGmailLabelsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/gmail/messages/get": { "post": { "operationId": "integrationsGmailMessagesGet", "summary": "Fetch one Gmail message's headers and bounded text and optional HTML bodies.", "description": "Fetch one Gmail message's headers and bounded text and optional HTML bodies.", "tags": [ "Gmail" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.gmail.messages.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGmailMessagesGetResponse" }, "example": { "message_id": "example", "thread_id": "example", "internet_message_id": "example", "subject": "example", "sender": "example", "recipients": [], "cc": [], "received_at": "example", "is_read": false, "label_ids": [], "text": "example", "text_truncated": false, "html": "example", "html_truncated": false, "has_attachments": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGmailMessagesGetRequest" }, "example": { "message_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/gmail/messages/reply": { "post": { "operationId": "integrationsGmailMessagesReply", "summary": "Reply to a Gmail message, optionally including its other recipients.", "description": "Reply to a Gmail message, optionally including its other recipients.", "tags": [ "Gmail" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.gmail.messages.reply", "x-required-scope": "integrations:destroy", "x-badges": [ { "name": "integrations:destroy", "position": "before" }, { "name": "External side effect" } ], "x-risk-level": "irreversible", "x-effect": "external_side_effect", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGmailMessagesReplyResponse" }, "example": { "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "job_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGmailMessagesReplyRequest" }, "example": { "message_id": "example", "text": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/gmail/messages/search": { "post": { "operationId": "integrationsGmailMessagesSearch", "summary": "Search a Gmail label by date, sender, subject, read state, and attachments; returns message summaries with cursor pagination.", "description": "Search a Gmail label by date, sender, subject, read state, and attachments; returns message summaries with cursor pagination.", "tags": [ "Gmail" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.gmail.messages.search", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGmailMessagesSearchResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGmailMessagesSearchRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/gsheets/spreadsheets/export": { "post": { "operationId": "integrationsGsheetsSpreadsheetsExport", "summary": "Export a Google spreadsheet into a Space as an XLSX, ODS, PDF, CSV, or TSV document, up to 10 MB", "description": "Export a Google spreadsheet into a Space as an XLSX, ODS, PDF, CSV, or TSV document, up to 10 MB. CSV and TSV include only the first sheet.", "tags": [ "Google Sheets" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.gsheets.spreadsheets.export", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" }, { "name": "External side effect" } ], "x-risk-level": "reversible", "x-effect": "external_side_effect", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGsheetsSpreadsheetsExportResponse" }, "example": { "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "job_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGsheetsSpreadsheetsExportRequest" }, "example": { "spreadsheet_id": "123e4567-e89b-42d3-a456-426614174000" } } } } } }, "/integrations/connections/{connection_id}/providers/gsheets/spreadsheets/list": { "post": { "operationId": "integrationsGsheetsSpreadsheetsList", "summary": "List Google spreadsheets by name with newest-first cursor pagination.", "description": "List Google spreadsheets by name with newest-first cursor pagination.", "tags": [ "Google Sheets" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.gsheets.spreadsheets.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGsheetsSpreadsheetsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGsheetsSpreadsheetsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/gsheets/values/append": { "post": { "operationId": "integrationsGsheetsValuesAppend", "summary": "Append rows after the table found in an A1 or named range", "description": "Append rows after the table found in an A1 or named range. Defaults to USER_ENTERED values and OVERWRITE insertion; retries can duplicate rows.", "tags": [ "Google Sheets" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.gsheets.values.append", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" }, { "name": "External side effect" } ], "x-risk-level": "reversible", "x-effect": "external_side_effect", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGsheetsValuesAppendResponse" }, "example": { "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "job_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGsheetsValuesAppendRequest" }, "example": { "spreadsheet_id": "123e4567-e89b-42d3-a456-426614174000", "range": "example", "rows": [ [] ] } } } } } }, "/integrations/connections/{connection_id}/providers/gsheets/values/read": { "post": { "operationId": "integrationsGsheetsValuesRead", "summary": "Read a bounded Google Sheets A1 or named range with selectable value and date rendering", "description": "Read a bounded Google Sheets A1 or named range with selectable value and date rendering. A range without a sheet name uses the first visible sheet.", "tags": [ "Google Sheets" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.gsheets.values.read", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGsheetsValuesReadResponse" }, "example": { "range": "example", "rows": [], "row_count": 0, "truncated": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsGsheetsValuesReadRequest" }, "example": { "spreadsheet_id": "123e4567-e89b-42d3-a456-426614174000", "range": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/imap/attachments/import": { "post": { "operationId": "integrationsImapAttachmentsImport", "summary": "Import one bounded attachment into a Space as a new document.", "description": "Import one bounded attachment into a Space as a new document.", "tags": [ "Email (IMAP)" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.imap.attachments.import", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" }, { "name": "External side effect" } ], "x-risk-level": "reversible", "x-effect": "external_side_effect", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsImapAttachmentsImportResponse" }, "example": { "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "job_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsImapAttachmentsImportRequest" }, "example": { "uid": 1, "part_id": "1" } } } } } }, "/integrations/connections/{connection_id}/providers/imap/attachments/list": { "post": { "operationId": "integrationsImapAttachmentsList", "summary": "List attachment metadata for one message without downloading content.", "description": "List attachment metadata for one message without downloading content.", "tags": [ "Email (IMAP)" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.imap.attachments.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsImapAttachmentsListResponse" }, "example": { "items": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsImapAttachmentsListRequest" }, "example": { "uid": 1 } } } } } }, "/integrations/connections/{connection_id}/providers/imap/mailboxes/list": { "post": { "operationId": "integrationsImapMailboxesList", "summary": "List the mailboxes (folders) available on the account.", "description": "List the mailboxes (folders) available on the account.", "tags": [ "Email (IMAP)" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.imap.mailboxes.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsImapMailboxesListResponse" }, "example": { "items": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsImapMailboxesListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/imap/messages/get": { "post": { "operationId": "integrationsImapMessagesGet", "summary": "Fetch one message's headers and a bounded plain-text/HTML rendering.", "description": "Fetch one message's headers and a bounded plain-text/HTML rendering.", "tags": [ "Email (IMAP)" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.imap.messages.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsImapMessagesGetResponse" }, "example": { "uid": 0, "message_id": "example", "subject": "example", "sender": "example", "recipients": [], "cc": [], "date": "example", "size": 0, "seen": false, "flags": [], "text": "example", "text_truncated": false, "html": "example", "html_truncated": false, "has_attachments": false, "attachment_count": 0, "truncated": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsImapMessagesGetRequest" }, "example": { "uid": 1 } } } } } }, "/integrations/connections/{connection_id}/providers/imap/messages/search": { "post": { "operationId": "integrationsImapMessagesSearch", "summary": "Search a mailbox within a bounded date window and return newest-first message summaries with cursor pagination.", "description": "Search a mailbox within a bounded date window and return newest-first message summaries with cursor pagination.", "tags": [ "Email (IMAP)" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.imap.messages.search", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsImapMessagesSearchResponse" }, "example": { "items": [], "next_cursor": "example", "uid_validity": 0, "truncated": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsImapMessagesSearchRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/account/get": { "post": { "operationId": "integrationsKlaviyoAccountGet", "summary": "Get the Klaviyo account behind the API key: organization, timezone, currency, default sender.", "description": "Get the Klaviyo account behind the API key: organization, timezone, currency, default sender.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.account.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoAccountGetResponse" }, "example": { "account_id": "example", "organization_name": "example", "default_sender_name": "example", "default_sender_email": "example", "website_url": "example", "timezone": "example", "preferred_currency": "example", "locale": "example", "industry": "example", "test_account": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoAccountGetRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/campaign-messages/assign-template": { "post": { "operationId": "integrationsKlaviyoCampaignMessagesAssignTemplate", "summary": "Assign a template to a campaign email message (Klaviyo clones it into the message).", "description": "Assign a template to a campaign email message (Klaviyo clones it into the message).", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.klaviyo.campaign_messages.assign_template", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignMessagesAssignTemplateResponse" }, "example": { "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "job_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignMessagesAssignTemplateRequest" }, "example": { "campaign_message_id": "example", "template_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/campaign-messages/get": { "post": { "operationId": "integrationsKlaviyoCampaignMessagesGet", "summary": "Get one campaign message.", "description": "Get one campaign message.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.campaign_messages.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignMessagesGetResponse" }, "example": { "campaign_message_id": "example", "campaign_id": "example", "channel": "example", "label": "Customer documents", "content": { "subject": "example", "preview_text": "example", "from_email": "example", "from_label": "example", "reply_to_email": "example", "cc_email": "example", "bcc_email": "example", "body": "example", "media_url": "example", "title": "Approve supplier payment" }, "render_options": { "shorten_links": false, "add_org_prefix": false, "add_info_link": false, "add_opt_out_language": false }, "template_id": "example", "send_times": [], "created_at": "example", "updated_at": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignMessagesGetRequest" }, "example": { "campaign_message_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/campaign-messages/list": { "post": { "operationId": "integrationsKlaviyoCampaignMessagesList", "summary": "List the messages of a campaign with their template IDs.", "description": "List the messages of a campaign with their template IDs.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.campaign_messages.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignMessagesListResponse" }, "example": { "items": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignMessagesListRequest" }, "example": { "campaign_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/campaign-messages/update": { "post": { "operationId": "integrationsKlaviyoCampaignMessagesUpdate", "summary": "Update label, subject, preview text, sender, reply-to or body of a campaign message.", "description": "Update label, subject, preview text, sender, reply-to or body of a campaign message.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.klaviyo.campaign_messages.update", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignMessagesUpdateResponse" }, "example": { "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "job_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignMessagesUpdateRequest" }, "example": { "campaign_message_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/campaign-reports/values": { "post": { "operationId": "integrationsKlaviyoCampaignReportsValues", "summary": "Campaign statistics (recipients, opens, clicks, conversions, revenue, unsubscribes) totalled over a timeframe, grouped per campaign message and channel.", "description": "Campaign statistics (recipients, opens, clicks, conversions, revenue, unsubscribes) totalled over a timeframe, grouped per campaign message and channel.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.campaign_reports.values", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignReportsValuesResponse" }, "example": { "rows": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignReportsValuesRequest" }, "example": { "statistics": [ "average_order_value" ], "timeframe": {} } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/campaigns/create": { "post": { "operationId": "integrationsKlaviyoCampaignsCreate", "summary": "Create a draft campaign for existing list/segment audiences with its messages, send strategy, tracking and smart-sending options; optionally assign a template to the email messages", "description": "Create a draft campaign for existing list/segment audiences with its messages, send strategy, tracking and smart-sending options; optionally assign a template to the email messages. Never sends: the draft is scheduled or sent in Klaviyo.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.klaviyo.campaigns.create", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsCreateResponse" }, "example": { "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "job_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsCreateRequest" }, "example": { "name": "Customer documents", "audiences": { "included": [ "example" ] }, "messages": [ {} ] } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/campaigns/get": { "post": { "operationId": "integrationsKlaviyoCampaignsGet", "summary": "Get one campaign including its messages.", "description": "Get one campaign including its messages.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.campaigns.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsGetResponse" }, "example": { "campaign_id": "example", "name": "Customer documents", "status": "ACTIVE", "archived": false, "audiences": { "included": [], "excluded": [] }, "send_strategy": { "method": "GET", "datetime": "example", "date": "example", "throttle_percentage": 0, "is_local": false, "send_past_recipients_immediately": false }, "use_smart_sending": false, "tracking_options": { "add_tracking_params": false, "custom_tracking_params": [], "is_tracking_opens": false, "is_tracking_clicks": false }, "created_at": "example", "scheduled_at": "example", "updated_at": "example", "send_time": "example", "campaign_message_ids": [], "tag_ids": [], "messages": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsGetRequest" }, "example": { "campaign_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/campaigns/list": { "post": { "operationId": "integrationsKlaviyoCampaignsList", "summary": "List campaigns of one channel with status, archive and time filters.", "description": "List campaigns of one channel with status, archive and time filters.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.campaigns.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/campaigns/update": { "post": { "operationId": "integrationsKlaviyoCampaignsUpdate", "summary": "Update name, audiences, send strategy, smart sending or tracking of a campaign.", "description": "Update name, audiences, send strategy, smart sending or tracking of a campaign.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.klaviyo.campaigns.update", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsUpdateResponse" }, "example": { "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "job_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsUpdateRequest" }, "example": { "campaign_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/flow-actions/list": { "post": { "operationId": "integrationsKlaviyoFlowActionsList", "summary": "List the actions (steps) of a flow with their message IDs.", "description": "List the actions (steps) of a flow with their message IDs.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.flow_actions.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoFlowActionsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoFlowActionsListRequest" }, "example": { "flow_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/flow-messages/get": { "post": { "operationId": "integrationsKlaviyoFlowMessagesGet", "summary": "Get one flow message.", "description": "Get one flow message.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.flow_messages.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoFlowMessagesGetResponse" }, "example": { "flow_message_id": "example", "name": "Customer documents", "channel": "example", "subject_line": "example", "preview_text": "example", "from_email": "example", "from_label": "example", "template_id": "example", "created": "example", "updated": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoFlowMessagesGetRequest" }, "example": { "flow_message_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/flow-messages/list": { "post": { "operationId": "integrationsKlaviyoFlowMessagesList", "summary": "List the messages of a flow action (subject, sender, template).", "description": "List the messages of a flow action (subject, sender, template).", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.flow_messages.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoFlowMessagesListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoFlowMessagesListRequest" }, "example": { "flow_action_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/flow-reports/series": { "post": { "operationId": "integrationsKlaviyoFlowReportsSeries", "summary": "Flow statistics as a time series (hourly/daily/weekly/monthly) over a timeframe.", "description": "Flow statistics as a time series (hourly/daily/weekly/monthly) over a timeframe.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.flow_reports.series", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoFlowReportsSeriesResponse" }, "example": { "date_times": [], "rows": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoFlowReportsSeriesRequest" }, "example": { "statistics": [ "average_order_value" ], "timeframe": {} } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/flow-reports/values": { "post": { "operationId": "integrationsKlaviyoFlowReportsValues", "summary": "Flow statistics totalled over a timeframe, grouped per flow message and channel.", "description": "Flow statistics totalled over a timeframe, grouped per flow message and channel.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.flow_reports.values", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoFlowReportsValuesResponse" }, "example": { "rows": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoFlowReportsValuesRequest" }, "example": { "statistics": [ "average_order_value" ], "timeframe": {} } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/flows/get": { "post": { "operationId": "integrationsKlaviyoFlowsGet", "summary": "Get one flow.", "description": "Get one flow.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.flows.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoFlowsGetResponse" }, "example": { "flow_id": "example", "name": "Customer documents", "status": "ACTIVE", "archived": false, "trigger_type": "example", "created": "example", "updated": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoFlowsGetRequest" }, "example": { "flow_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/flows/list": { "post": { "operationId": "integrationsKlaviyoFlowsList", "summary": "List flows (automations) with status, trigger type and time filters.", "description": "List flows (automations) with status, trigger type and time filters.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.flows.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoFlowsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoFlowsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/form-reports/series": { "post": { "operationId": "integrationsKlaviyoFormReportsSeries", "summary": "Sign-up form statistics as a time series over a timeframe.", "description": "Sign-up form statistics as a time series over a timeframe.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.form_reports.series", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoFormReportsSeriesResponse" }, "example": { "date_times": [], "rows": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoFormReportsSeriesRequest" }, "example": { "statistics": [ "closed_form" ], "timeframe": {} } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/form-reports/values": { "post": { "operationId": "integrationsKlaviyoFormReportsValues", "summary": "Sign-up form statistics (views, submits, submit rate) totalled over a timeframe.", "description": "Sign-up form statistics (views, submits, submit rate) totalled over a timeframe.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.form_reports.values", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoFormReportsValuesResponse" }, "example": { "rows": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoFormReportsValuesRequest" }, "example": { "statistics": [ "closed_form" ], "timeframe": {} } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/forms/get": { "post": { "operationId": "integrationsKlaviyoFormsGet", "summary": "Get one sign-up form.", "description": "Get one sign-up form.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.forms.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoFormsGetResponse" }, "example": { "form_id": "example", "name": "Customer documents", "status": "ACTIVE", "ab_test": false, "created_at": "example", "updated_at": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoFormsGetRequest" }, "example": { "form_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/forms/list": { "post": { "operationId": "integrationsKlaviyoFormsList", "summary": "List sign-up forms with status and time filters.", "description": "List sign-up forms with status and time filters.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.forms.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoFormsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoFormsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/lists/get": { "post": { "operationId": "integrationsKlaviyoListsGet", "summary": "Get one list, by default with its current profile count (snapshot of the list size).", "description": "Get one list, by default with its current profile count (snapshot of the list size).", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.lists.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoListsGetResponse" }, "example": { "list_id": "example", "name": "Customer documents", "created": "example", "updated": "example", "opt_in_process": "example", "profile_count": 0 } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoListsGetRequest" }, "example": { "list_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/lists/list": { "post": { "operationId": "integrationsKlaviyoListsList", "summary": "List the lists (subscriber lists) of the account with their opt-in process.", "description": "List the lists (subscriber lists) of the account with their opt-in process.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.lists.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoListsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoListsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/metric-aggregates/query": { "post": { "operationId": "integrationsKlaviyoMetricAggregatesQuery", "summary": "Aggregate a metric's events per hour/day/week/month in a time range, optionally grouped by dimensions such as List (e.g", "description": "Aggregate a metric's events per hour/day/week/month in a time range, optionally grouped by dimensions such as List (e.g. Subscribed to List per day per list for list growth).", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.metric_aggregates.query", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoMetricAggregatesQueryResponse" }, "example": { "dates": [], "rows": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoMetricAggregatesQueryRequest" }, "example": { "metric_id": "example", "measurements": [ "count" ], "start": "example", "end": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/metrics/get": { "post": { "operationId": "integrationsKlaviyoMetricsGet", "summary": "Get one metric.", "description": "Get one metric.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.metrics.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoMetricsGetResponse" }, "example": { "metric_id": "example", "name": "Customer documents", "integration_name": "example", "integration_category": "example", "created": "example", "updated": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoMetricsGetRequest" }, "example": { "metric_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/metrics/list": { "post": { "operationId": "integrationsKlaviyoMetricsList", "summary": "List metrics (event types such as Placed Order, Subscribed to List) with their integration.", "description": "List metrics (event types such as Placed Order, Subscribed to List) with their integration.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.metrics.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoMetricsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoMetricsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/segment-reports/series": { "post": { "operationId": "integrationsKlaviyoSegmentReportsSeries", "summary": "Segment membership statistics as a time series (segment growth) over a timeframe.", "description": "Segment membership statistics as a time series (segment growth) over a timeframe.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.segment_reports.series", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoSegmentReportsSeriesResponse" }, "example": { "date_times": [], "rows": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoSegmentReportsSeriesRequest" }, "example": { "statistics": [ "members_added" ], "timeframe": {} } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/segment-reports/values": { "post": { "operationId": "integrationsKlaviyoSegmentReportsValues", "summary": "Segment membership statistics (members added/removed, net change, total) over a timeframe.", "description": "Segment membership statistics (members added/removed, net change, total) over a timeframe.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.segment_reports.values", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoSegmentReportsValuesResponse" }, "example": { "rows": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoSegmentReportsValuesRequest" }, "example": { "statistics": [ "members_added" ], "timeframe": {} } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/segments/get": { "post": { "operationId": "integrationsKlaviyoSegmentsGet", "summary": "Get one segment, by default with its current profile count (snapshot of the segment size).", "description": "Get one segment, by default with its current profile count (snapshot of the segment size).", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.segments.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoSegmentsGetResponse" }, "example": { "segment_id": "example", "name": "Customer documents", "created": "example", "updated": "example", "is_active": false, "is_processing": false, "is_starred": false, "profile_count": 0 } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoSegmentsGetRequest" }, "example": { "segment_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/segments/list": { "post": { "operationId": "integrationsKlaviyoSegmentsList", "summary": "List the segments (dynamic groups) of the account.", "description": "List the segments (dynamic groups) of the account.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.segments.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoSegmentsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoSegmentsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/tags/list": { "post": { "operationId": "integrationsKlaviyoTagsList", "summary": "List tags; tag IDs filter campaign and flow reports.", "description": "List tags; tag IDs filter campaign and flow reports.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.tags.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoTagsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoTagsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/templates/create": { "post": { "operationId": "integrationsKlaviyoTemplatesCreate", "summary": "Create a code (HTML) email template with optional plain text and AMP versions.", "description": "Create a code (HTML) email template with optional plain text and AMP versions.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.klaviyo.templates.create", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoTemplatesCreateResponse" }, "example": { "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "job_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoTemplatesCreateRequest" }, "example": { "name": "Customer documents", "html": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/templates/get": { "post": { "operationId": "integrationsKlaviyoTemplatesGet", "summary": "Get one template with its HTML, plain text and AMP source.", "description": "Get one template with its HTML, plain text and AMP source.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.templates.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoTemplatesGetResponse" }, "example": { "template_id": "example", "name": "Customer documents", "editor_type": "example", "created": "example", "updated": "example", "html": "example", "text": "example", "amp": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoTemplatesGetRequest" }, "example": { "template_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/templates/list": { "post": { "operationId": "integrationsKlaviyoTemplatesList", "summary": "List email templates (metadata only, no HTML).", "description": "List email templates (metadata only, no HTML).", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.templates.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoTemplatesListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoTemplatesListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/templates/render": { "post": { "operationId": "integrationsKlaviyoTemplatesRender", "summary": "Render a template with a context of variables and return the resulting HTML.", "description": "Render a template with a context of variables and return the resulting HTML.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.klaviyo.templates.render", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoTemplatesRenderResponse" }, "example": { "template_id": "example", "name": "Customer documents", "html": "example", "text": "example", "amp": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoTemplatesRenderRequest" }, "example": { "template_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/klaviyo/templates/update": { "post": { "operationId": "integrationsKlaviyoTemplatesUpdate", "summary": "Update the name, HTML, plain text or AMP source of an existing template.", "description": "Update the name, HTML, plain text or AMP source of an existing template.", "tags": [ "Klaviyo" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.klaviyo.templates.update", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" } ], "x-risk-level": "reversible", "x-effect": "write", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoTemplatesUpdateResponse" }, "example": { "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "job_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsKlaviyoTemplatesUpdateRequest" }, "example": { "template_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/metaads/ad-accounts/get": { "post": { "operationId": "integrationsMetaadsAdAccountsGet", "summary": "Get one ad account with spend cap, balance, funding source and capabilities.", "description": "Get one ad account with spend cap, balance, funding source and capabilities.", "tags": [ "Meta Ads" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.metaads.ad_accounts.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsAdAccountsGetResponse" }, "example": { "id": "example", "account_id": "example", "name": "Customer documents", "account_status": 0, "account_status_label": "example", "currency": "example", "timezone_name": "example", "amount_spent": 0, "business": { "id": "example", "name": "Customer documents" }, "spend_cap": 0, "balance": 0, "disable_reason": 0, "created_time": "example", "funding_source_details": {}, "capabilities": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsAdAccountsGetRequest" }, "example": { "ad_account_id": "1" } } } } } }, "/integrations/connections/{connection_id}/providers/metaads/ad-accounts/list": { "post": { "operationId": "integrationsMetaadsAdAccountsList", "summary": "List the ad accounts the system user can reach: status, currency, time zone, amount spent and business.", "description": "List the ad accounts the system user can reach: status, currency, time zone, amount spent and business.", "tags": [ "Meta Ads" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.metaads.ad_accounts.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsAdAccountsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsAdAccountsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/metaads/ad-creatives/get": { "post": { "operationId": "integrationsMetaadsAdCreativesGet", "summary": "Get one creative by ID.", "description": "Get one creative by ID.", "tags": [ "Meta Ads" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.metaads.ad_creatives.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsAdCreativesGetResponse" }, "example": { "id": "example", "name": "Customer documents", "title": "Approve supplier payment", "body": "example", "object_story_spec": {}, "asset_feed_spec": {}, "image_url": "example", "image_hash": "example", "thumbnail_url": "example", "video_id": "example", "call_to_action_type": "example", "link_url": "example", "object_type": "example", "status": "ACTIVE", "effective_object_story_id": "example", "instagram_permalink_url": "example", "url_tags": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsAdCreativesGetRequest" }, "example": { "ad_account_id": "1", "creative_id": "1" } } } } } }, "/integrations/connections/{connection_id}/providers/metaads/ad-creatives/list": { "post": { "operationId": "integrationsMetaadsAdCreativesList", "summary": "List creatives of an ad account or of one ad: texts, story spec, image, video, call to action and link.", "description": "List creatives of an ad account or of one ad: texts, story spec, image, video, call to action and link.", "tags": [ "Meta Ads" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.metaads.ad_creatives.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsAdCreativesListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsAdCreativesListRequest" }, "example": { "ad_account_id": "1" } } } } } }, "/integrations/connections/{connection_id}/providers/metaads/ad-images/list": { "post": { "operationId": "integrationsMetaadsAdImagesList", "summary": "List images of an ad account with hash, temporary URLs, dimensions and status.", "description": "List images of an ad account with hash, temporary URLs, dimensions and status.", "tags": [ "Meta Ads" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.metaads.ad_images.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsAdImagesListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsAdImagesListRequest" }, "example": { "ad_account_id": "1" } } } } } }, "/integrations/connections/{connection_id}/providers/metaads/ad-sets/get": { "post": { "operationId": "integrationsMetaadsAdSetsGet", "summary": "Get one ad set with the full targeting spec, promoted object, attribution spec, bid and learning stage.", "description": "Get one ad set with the full targeting spec, promoted object, attribution spec, bid and learning stage.", "tags": [ "Meta Ads" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.metaads.ad_sets.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsAdSetsGetResponse" }, "example": { "id": "example", "name": "Customer documents", "campaign_id": "example", "status": "ACTIVE", "effective_status": "example", "daily_budget": 0, "lifetime_budget": 0, "optimization_goal": "example", "billing_event": "example", "bid_strategy": "example", "start_time": "example", "end_time": "example", "created_time": "example", "updated_time": "example", "targeting": {}, "promoted_object": {}, "attribution_spec": [], "bid_amount": 0, "destination_type": "example", "learning_stage_info": {}, "issues_info": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsAdSetsGetRequest" }, "example": { "ad_account_id": "1", "ad_set_id": "1" } } } } } }, "/integrations/connections/{connection_id}/providers/metaads/ad-sets/list": { "post": { "operationId": "integrationsMetaadsAdSetsList", "summary": "List ad sets of an ad account or of one campaign with status, budgets, optimization goal and schedule.", "description": "List ad sets of an ad account or of one campaign with status, budgets, optimization goal and schedule.", "tags": [ "Meta Ads" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.metaads.ad_sets.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsAdSetsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsAdSetsListRequest" }, "example": { "ad_account_id": "1" } } } } } }, "/integrations/connections/{connection_id}/providers/metaads/ad-videos/list": { "post": { "operationId": "integrationsMetaadsAdVideosList", "summary": "List videos of an ad account with title, length, processing status and permalink.", "description": "List videos of an ad account with title, length, processing status and permalink.", "tags": [ "Meta Ads" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.metaads.ad_videos.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsAdVideosListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsAdVideosListRequest" }, "example": { "ad_account_id": "1" } } } } } }, "/integrations/connections/{connection_id}/providers/metaads/ads/get": { "post": { "operationId": "integrationsMetaadsAdsGet", "summary": "Get one ad with tracking specs, conversion domain, review feedback, issues and a shareable preview link.", "description": "Get one ad with tracking specs, conversion domain, review feedback, issues and a shareable preview link.", "tags": [ "Meta Ads" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.metaads.ads.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsAdsGetResponse" }, "example": { "id": "example", "name": "Customer documents", "campaign_id": "example", "adset_id": "example", "status": "ACTIVE", "effective_status": "example", "creative_id": "example", "created_time": "example", "updated_time": "example", "tracking_specs": [], "conversion_domain": "example", "issues_info": [], "preview_shareable_link": "example", "ad_review_feedback": {} } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsAdsGetRequest" }, "example": { "ad_account_id": "1", "ad_id": "1" } } } } } }, "/integrations/connections/{connection_id}/providers/metaads/ads/list": { "post": { "operationId": "integrationsMetaadsAdsList", "summary": "List ads of an ad account, a campaign or an ad set with status and creative reference.", "description": "List ads of an ad account, a campaign or an ad set with status and creative reference.", "tags": [ "Meta Ads" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.metaads.ads.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsAdsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsAdsListRequest" }, "example": { "ad_account_id": "1" } } } } } }, "/integrations/connections/{connection_id}/providers/metaads/campaigns/get": { "post": { "operationId": "integrationsMetaadsCampaignsGet", "summary": "Get one campaign with budgets, bid strategy, spend cap, special ad categories and delivery issues.", "description": "Get one campaign with budgets, bid strategy, spend cap, special ad categories and delivery issues.", "tags": [ "Meta Ads" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.metaads.campaigns.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsCampaignsGetResponse" }, "example": { "id": "example", "name": "Customer documents", "objective": "example", "status": "ACTIVE", "effective_status": "example", "daily_budget": 0, "lifetime_budget": 0, "budget_remaining": 0, "bid_strategy": "example", "buying_type": "example", "start_time": "example", "stop_time": "example", "created_time": "example", "updated_time": "example", "spend_cap": 0, "special_ad_categories": [], "issues_info": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsCampaignsGetRequest" }, "example": { "ad_account_id": "1", "campaign_id": "1" } } } } } }, "/integrations/connections/{connection_id}/providers/metaads/campaigns/list": { "post": { "operationId": "integrationsMetaadsCampaignsList", "summary": "List campaigns of an ad account with objective, status, budgets and schedule; filter by delivery status, objective and creation date.", "description": "List campaigns of an ad account with objective, status, budgets and schedule; filter by delivery status, objective and creation date.", "tags": [ "Meta Ads" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.metaads.campaigns.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsCampaignsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsCampaignsListRequest" }, "example": { "ad_account_id": "1" } } } } } }, "/integrations/connections/{connection_id}/providers/metaads/custom-audiences/get": { "post": { "operationId": "integrationsMetaadsCustomAudiencesGet", "summary": "Get one custom audience with its rule, lookalike spec and sharing status.", "description": "Get one custom audience with its rule, lookalike spec and sharing status.", "tags": [ "Meta Ads" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.metaads.custom_audiences.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsCustomAudiencesGetResponse" }, "example": { "id": "example", "name": "Customer documents", "subtype": "example", "description": "example", "approximate_count_lower_bound": 0, "approximate_count_upper_bound": 0, "delivery_status": {}, "operation_status": {}, "retention_days": 0, "data_source": {}, "time_created": "example", "time_updated": "example", "rule": "example", "lookalike_spec": {}, "sharing_status": {} } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsCustomAudiencesGetRequest" }, "example": { "ad_account_id": "1", "audience_id": "1" } } } } } }, "/integrations/connections/{connection_id}/providers/metaads/custom-audiences/list": { "post": { "operationId": "integrationsMetaadsCustomAudiencesList", "summary": "List custom audiences of an ad account with subtype, approximate size, delivery and operation status.", "description": "List custom audiences of an ad account with subtype, approximate size, delivery and operation status.", "tags": [ "Meta Ads" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.metaads.custom_audiences.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsCustomAudiencesListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsCustomAudiencesListRequest" }, "example": { "ad_account_id": "1" } } } } } }, "/integrations/connections/{connection_id}/providers/metaads/insights/get-report": { "post": { "operationId": "integrationsMetaadsInsightsGetReport", "summary": "Status of an asynchronous insights report and, once completed, its rows; call again while completed is false.", "description": "Status of an asynchronous insights report and, once completed, its rows; call again while completed is false.", "tags": [ "Meta Ads" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.metaads.insights.get_report", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsInsightsGetReportResponse" }, "example": { "report_run_id": "example", "status": "ACTIVE", "percent_complete": 0, "completed": false, "rows": [], "next_cursor": "example", "currency": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsInsightsGetReportRequest" }, "example": { "ad_account_id": "1", "report_run_id": "1" } } } } } }, "/integrations/connections/{connection_id}/providers/metaads/insights/query": { "post": { "operationId": "integrationsMetaadsInsightsQuery", "summary": "Performance metrics per account, campaign, ad set or ad for a time range, optionally split by breakdowns and periods; one page per call.", "description": "Performance metrics per account, campaign, ad set or ad for a time range, optionally split by breakdowns and periods; one page per call.", "tags": [ "Meta Ads" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.metaads.insights.query", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsInsightsQueryResponse" }, "example": { "rows": [], "next_cursor": "example", "currency": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsInsightsQueryRequest" }, "example": { "ad_account_id": "1" } } } } } }, "/integrations/connections/{connection_id}/providers/metaads/insights/start-report": { "post": { "operationId": "integrationsMetaadsInsightsStartReport", "summary": "Start an asynchronous insights report for large ranges or many breakdowns; poll it with insights.get_report.", "description": "Start an asynchronous insights report for large ranges or many breakdowns; poll it with insights.get_report.", "tags": [ "Meta Ads" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.metaads.insights.start_report", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsInsightsStartReportResponse" }, "example": { "report_run_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsInsightsStartReportRequest" }, "example": { "ad_account_id": "1" } } } } } }, "/integrations/connections/{connection_id}/providers/metaads/lead-forms/get": { "post": { "operationId": "integrationsMetaadsLeadFormsGet", "summary": "Get one lead form with its questions.", "description": "Get one lead form with its questions.", "tags": [ "Meta Ads" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.metaads.lead_forms.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsLeadFormsGetResponse" }, "example": { "id": "example", "name": "Customer documents", "status": "ACTIVE", "locale": "example", "leads_count": 0, "expired_leads_count": 0, "organic_leads_count": 0, "created_time": "example", "privacy_policy_url": "example", "follow_up_action_url": "example", "questions": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsLeadFormsGetRequest" }, "example": { "page_id": "1", "form_id": "1" } } } } } }, "/integrations/connections/{connection_id}/providers/metaads/lead-forms/list": { "post": { "operationId": "integrationsMetaadsLeadFormsList", "summary": "List lead forms of a Facebook page with status, locale, lead counts and creation time.", "description": "List lead forms of a Facebook page with status, locale, lead counts and creation time.", "tags": [ "Meta Ads" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.metaads.lead_forms.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsLeadFormsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsLeadFormsListRequest" }, "example": { "page_id": "1" } } } } } }, "/integrations/connections/{connection_id}/providers/metaads/leads/list": { "post": { "operationId": "integrationsMetaadsLeadsList", "summary": "List submissions of a lead form", "description": "List submissions of a lead form. Returns personal data (name, email, phone) exactly as submitted; requires the leads_retrieval permission.", "tags": [ "Meta Ads" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.metaads.leads.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsLeadsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsLeadsListRequest" }, "example": { "page_id": "1", "form_id": "1" } } } } } }, "/integrations/connections/{connection_id}/providers/metaads/pages/list": { "post": { "operationId": "integrationsMetaadsPagesList", "summary": "List the Facebook pages assigned to the system user, with the tasks it may perform on each.", "description": "List the Facebook pages assigned to the system user, with the tasks it may perform on each.", "tags": [ "Meta Ads" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.metaads.pages.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsPagesListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsPagesListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/metaads/pixels/get": { "post": { "operationId": "integrationsMetaadsPixelsGet", "summary": "Get one pixel by ID.", "description": "Get one pixel by ID.", "tags": [ "Meta Ads" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.metaads.pixels.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsPixelsGetResponse" }, "example": { "id": "example", "name": "Customer documents", "creation_time": "example", "last_fired_time": "example", "is_created_by_business": false, "owner_business": { "id": "example", "name": "Customer documents" }, "data_use_setting": "example", "enable_automatic_matching": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsPixelsGetRequest" }, "example": { "ad_account_id": "1", "pixel_id": "1" } } } } } }, "/integrations/connections/{connection_id}/providers/metaads/pixels/list": { "post": { "operationId": "integrationsMetaadsPixelsList", "summary": "List pixels of an ad account with last fired time, owner business and matching settings.", "description": "List pixels of an ad account with last fired time, owner business and matching settings.", "tags": [ "Meta Ads" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.metaads.pixels.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsPixelsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsPixelsListRequest" }, "example": { "ad_account_id": "1" } } } } } }, "/integrations/connections/{connection_id}/providers/metaads/saved-audiences/list": { "post": { "operationId": "integrationsMetaadsSavedAudiencesList", "summary": "List saved audiences of an ad account with targeting spec, estimated reach and status.", "description": "List saved audiences of an ad account with targeting spec, estimated reach and status.", "tags": [ "Meta Ads" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.metaads.saved_audiences.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsSavedAudiencesListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMetaadsSavedAudiencesListRequest" }, "example": { "ad_account_id": "1" } } } } } }, "/integrations/connections/{connection_id}/providers/microsoft365/attachments/import": { "post": { "operationId": "integrationsMicrosoft365AttachmentsImport", "summary": "Import one bounded Outlook attachment into a Space as a new document.", "description": "Import one bounded Outlook attachment into a Space as a new document.", "tags": [ "Microsoft 365" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.microsoft365.attachments.import", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" }, { "name": "External side effect" } ], "x-risk-level": "reversible", "x-effect": "external_side_effect", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMicrosoft365AttachmentsImportResponse" }, "example": { "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "job_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMicrosoft365AttachmentsImportRequest" }, "example": { "message_id": "example", "attachment_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/microsoft365/attachments/list": { "post": { "operationId": "integrationsMicrosoft365AttachmentsList", "summary": "List attachment metadata for one message without downloading content.", "description": "List attachment metadata for one message without downloading content.", "tags": [ "Microsoft 365" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.microsoft365.attachments.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMicrosoft365AttachmentsListResponse" }, "example": { "items": [], "truncated": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMicrosoft365AttachmentsListRequest" }, "example": { "message_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/microsoft365/drives/list": { "post": { "operationId": "integrationsMicrosoft365DrivesList", "summary": "List the personal OneDrive and the SharePoint document libraries the account can read.", "description": "List the personal OneDrive and the SharePoint document libraries the account can read.", "tags": [ "Microsoft 365" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.microsoft365.drives.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMicrosoft365DrivesListResponse" }, "example": { "items": [], "truncated": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMicrosoft365DrivesListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/microsoft365/files/import": { "post": { "operationId": "integrationsMicrosoft365FilesImport", "summary": "Import one bounded OneDrive or SharePoint file into a Space as a new document.", "description": "Import one bounded OneDrive or SharePoint file into a Space as a new document.", "tags": [ "Microsoft 365" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.microsoft365.files.import", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" }, { "name": "External side effect" } ], "x-risk-level": "reversible", "x-effect": "external_side_effect", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMicrosoft365FilesImportResponse" }, "example": { "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "job_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMicrosoft365FilesImportRequest" }, "example": { "drive_id": "example", "item_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/microsoft365/files/list": { "post": { "operationId": "integrationsMicrosoft365FilesList", "summary": "List the children of a drive folder with cursor pagination.", "description": "List the children of a drive folder with cursor pagination.", "tags": [ "Microsoft 365" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.microsoft365.files.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMicrosoft365FilesListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMicrosoft365FilesListRequest" }, "example": { "drive_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/microsoft365/mailfolders/list": { "post": { "operationId": "integrationsMicrosoft365MailfoldersList", "summary": "List the mail folders of the Outlook mailbox with cursor pagination.", "description": "List the mail folders of the Outlook mailbox with cursor pagination.", "tags": [ "Microsoft 365" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.microsoft365.mailfolders.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMicrosoft365MailfoldersListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMicrosoft365MailfoldersListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/microsoft365/messages/get": { "post": { "operationId": "integrationsMicrosoft365MessagesGet", "summary": "Fetch one Outlook message's headers and a bounded text or HTML body.", "description": "Fetch one Outlook message's headers and a bounded text or HTML body.", "tags": [ "Microsoft 365" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.microsoft365.messages.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMicrosoft365MessagesGetResponse" }, "example": { "message_id": "example", "internet_message_id": "example", "subject": "example", "sender": "example", "recipients": [], "cc": [], "received_at": "example", "is_read": false, "text": "example", "text_truncated": false, "html": "example", "html_truncated": false, "has_attachments": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMicrosoft365MessagesGetRequest" }, "example": { "message_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/microsoft365/messages/search": { "post": { "operationId": "integrationsMicrosoft365MessagesSearch", "summary": "Search one Outlook folder by date window, sender, subject, and read state; returns newest-first message summaries with cursor pagination.", "description": "Search one Outlook folder by date window, sender, subject, and read state; returns newest-first message summaries with cursor pagination.", "tags": [ "Microsoft 365" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.microsoft365.messages.search", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMicrosoft365MessagesSearchResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMicrosoft365MessagesSearchRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/mongodb/collections/describe": { "post": { "operationId": "integrationsMongodbCollectionsDescribe", "summary": "Infer the fields and types of one collection from a random sample and list its indexes.", "description": "Infer the fields and types of one collection from a random sample and list its indexes.", "tags": [ "MongoDB" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.mongodb.collections.describe", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMongodbCollectionsDescribeResponse" }, "example": { "collection": "example", "estimated_count": 0, "sampled": 0, "fields": [], "indexes": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMongodbCollectionsDescribeRequest" }, "example": { "collection": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/mongodb/collections/list": { "post": { "operationId": "integrationsMongodbCollectionsList", "summary": "List the collections and views of the database with estimated counts.", "description": "List the collections and views of the database with estimated counts.", "tags": [ "MongoDB" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.mongodb.collections.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMongodbCollectionsListResponse" }, "example": { "items": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMongodbCollectionsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/mongodb/documents/aggregate": { "post": { "operationId": "integrationsMongodbDocumentsAggregate", "summary": "Run a read-only aggregation pipeline on one collection", "description": "Run a read-only aggregation pipeline on one collection. `$lookup` may only read collections declared in `lookup_collections`; writing stages and JavaScript are rejected.", "tags": [ "MongoDB" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.mongodb.documents.aggregate", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMongodbDocumentsAggregateResponse" }, "example": { "documents": [], "document_count": 0, "has_more": false, "truncated": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMongodbDocumentsAggregateRequest" }, "example": { "collection": "example", "pipeline": [ {} ] } } } } } }, "/integrations/connections/{connection_id}/providers/mongodb/documents/find": { "post": { "operationId": "integrationsMongodbDocumentsFind", "summary": "Find documents in one collection with a MongoDB query filter, optional projection and sort, bounded by limit.", "description": "Find documents in one collection with a MongoDB query filter, optional projection and sort, bounded by limit.", "tags": [ "MongoDB" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.mongodb.documents.find", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMongodbDocumentsFindResponse" }, "example": { "documents": [], "document_count": 0, "has_more": false, "truncated": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsMongodbDocumentsFindRequest" }, "example": { "collection": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/notion/blocks/append": { "post": { "operationId": "integrationsNotionBlocksAppend", "summary": "Add up to 50 text or divider blocks at the start or end of a page or block.", "description": "Add up to 50 text or divider blocks at the start or end of a page or block.", "tags": [ "Notion" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.notion.blocks.append", "x-required-scope": "integrations:destroy", "x-badges": [ { "name": "integrations:destroy", "position": "before" }, { "name": "External side effect" } ], "x-risk-level": "irreversible", "x-effect": "external_side_effect", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsNotionBlocksAppendResponse" }, "example": { "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "job_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsNotionBlocksAppendRequest" }, "example": { "block_id": "examplexxxxxxxxxxxxxxxxxxxxxxxxx", "blocks": [ { "type": "paragraph" } ] } } } } } }, "/integrations/connections/{connection_id}/providers/notion/blocks/list": { "post": { "operationId": "integrationsNotionBlocksList", "summary": "List one level of page or block content; follow has_children with blocks.list to read nested blocks.", "description": "List one level of page or block content; follow has_children with blocks.list to read nested blocks.", "tags": [ "Notion" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.notion.blocks.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsNotionBlocksListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsNotionBlocksListRequest" }, "example": { "block_id": "examplexxxxxxxxxxxxxxxxxxxxxxxxx" } } } } } }, "/integrations/connections/{connection_id}/providers/notion/data-sources/get": { "post": { "operationId": "integrationsNotionDataSourcesGet", "summary": "Get a Notion data source, its properties and select, multi-select or status options.", "description": "Get a Notion data source, its properties and select, multi-select or status options.", "tags": [ "Notion" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.notion.data_sources.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsNotionDataSourcesGetResponse" }, "example": { "data_source_id": "example", "title": "Approve supplier payment", "description": "example", "database_id": "example", "url": "https://api.adlass.io/v1/workflows/hooks/example", "is_inline": false, "in_trash": false, "properties": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsNotionDataSourcesGetRequest" }, "example": { "data_source_id": "examplexxxxxxxxxxxxxxxxxxxxxxxxx" } } } } } }, "/integrations/connections/{connection_id}/providers/notion/data-sources/query": { "post": { "operationId": "integrationsNotionDataSourcesQuery", "summary": "Query pages in a data source using Notion filters, sorts and cursor pagination; incomplete marks partial results.", "description": "Query pages in a data source using Notion filters, sorts and cursor pagination; incomplete marks partial results.", "tags": [ "Notion" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.notion.data_sources.query", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsNotionDataSourcesQueryResponse" }, "example": { "items": [], "next_cursor": "example", "incomplete": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsNotionDataSourcesQueryRequest" }, "example": { "data_source_id": "examplexxxxxxxxxxxxxxxxxxxxxxxxx" } } } } } }, "/integrations/connections/{connection_id}/providers/notion/pages/get": { "post": { "operationId": "integrationsNotionPagesGet", "summary": "Get a page and flattened properties; use blocks.list for content", "description": "Get a page and flattened properties; use blocks.list for content. Notion may limit property references to 25.", "tags": [ "Notion" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.notion.pages.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsNotionPagesGetResponse" }, "example": { "page_id": "example", "title": "Approve supplier payment", "url": "https://api.adlass.io/v1/workflows/hooks/example", "public_url": "example", "icon": "example", "parent": { "type": "run.completed", "id": "example" }, "created_time": "example", "last_edited_time": "example", "in_trash": false, "is_locked": false, "properties": {} } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsNotionPagesGetRequest" }, "example": { "page_id": "examplexxxxxxxxxxxxxxxxxxxxxxxxx" } } } } } }, "/integrations/connections/{connection_id}/providers/notion/search/query": { "post": { "operationId": "integrationsNotionSearchQuery", "summary": "Search shared Notion pages and data sources by title with cursor pagination.", "description": "Search shared Notion pages and data sources by title with cursor pagination.", "tags": [ "Notion" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.notion.search.query", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsNotionSearchQueryResponse" }, "example": { "items": [], "next_cursor": "example", "incomplete": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsNotionSearchQueryRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/postgres/rows/query": { "post": { "operationId": "integrationsPostgresRowsQuery", "summary": "Read rows from one table with optional column selection, simple filters, ordering, limit, and offset.", "description": "Read rows from one table with optional column selection, simple filters, ordering, limit, and offset.", "tags": [ "PostgreSQL" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.postgres.rows.query", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsPostgresRowsQueryResponse" }, "example": { "columns": [], "rows": [], "row_count": 0, "has_more": false, "truncated": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsPostgresRowsQueryRequest" }, "example": { "table": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/postgres/schemas/list": { "post": { "operationId": "integrationsPostgresSchemasList", "summary": "List the schemas the read-only user may use.", "description": "List the schemas the read-only user may use.", "tags": [ "PostgreSQL" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.postgres.schemas.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsPostgresSchemasListResponse" }, "example": { "items": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsPostgresSchemasListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/postgres/sql/select": { "post": { "operationId": "integrationsPostgresSqlSelect", "summary": "Run one read-only SELECT statement", "description": "Run one read-only SELECT statement. Every table the statement reads must be declared in `tables` as schema.table; joins, CTEs, and aggregations are allowed, user-defined functions and writes are not.", "tags": [ "PostgreSQL" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.postgres.sql.select", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsPostgresSqlSelectResponse" }, "example": { "columns": [], "rows": [], "row_count": 0, "has_more": false, "truncated": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsPostgresSqlSelectRequest" }, "example": { "sql": "example", "tables": [ "example" ] } } } } } }, "/integrations/connections/{connection_id}/providers/postgres/tables/describe": { "post": { "operationId": "integrationsPostgresTablesDescribe", "summary": "Describe one table: columns, types, primary key, and foreign keys.", "description": "Describe one table: columns, types, primary key, and foreign keys.", "tags": [ "PostgreSQL" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.postgres.tables.describe", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsPostgresTablesDescribeResponse" }, "example": { "table": "example", "kind": "schedule", "estimated_rows": 0, "columns": [], "primary_key": [], "foreign_keys": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsPostgresTablesDescribeRequest" }, "example": { "table": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/postgres/tables/list": { "post": { "operationId": "integrationsPostgresTablesList", "summary": "List tables and views (schema.table) with estimated row counts, optionally filtered by schema, with cursor pagination.", "description": "List tables and views (schema.table) with estimated row counts, optionally filtered by schema, with cursor pagination.", "tags": [ "PostgreSQL" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.postgres.tables.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsPostgresTablesListResponse" }, "example": { "items": [], "has_more": false, "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsPostgresTablesListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/shopify/abandoned-checkouts/list": { "post": { "operationId": "integrationsShopifyAbandonedCheckoutsList", "summary": "List abandoned checkouts with totals and the recovery URL.", "description": "List abandoned checkouts with totals and the recovery URL.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.abandoned_checkouts.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyAbandonedCheckoutsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyAbandonedCheckoutsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/shopify/collection-products/list": { "post": { "operationId": "integrationsShopifyCollectionProductsList", "summary": "List the products of one collection in collection order or by sort key.", "description": "List the products of one collection in collection order or by sort key.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.collection_products.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyCollectionProductsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyCollectionProductsListRequest" }, "example": { "collection_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/shopify/collections/get": { "post": { "operationId": "integrationsShopifyCollectionsGet", "summary": "Get one collection by ID or handle including smart-collection rules.", "description": "Get one collection by ID or handle including smart-collection rules.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.collections.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyCollectionsGetResponse" }, "example": { "id": "example", "handle": "example", "title": "Approve supplier payment", "description": "example", "products_count": 0, "sort_order": "example", "is_smart": false, "rule_set": { "applied_disjunctively": false, "rules": [] }, "image_url": "example", "updated_at": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyCollectionsGetRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/shopify/collections/list": { "post": { "operationId": "integrationsShopifyCollectionsList", "summary": "List collections (manual and smart) with search syntax and cursor pagination.", "description": "List collections (manual and smart) with search syntax and cursor pagination.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.collections.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyCollectionsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyCollectionsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/shopify/customers/get": { "post": { "operationId": "integrationsShopifyCustomersGet", "summary": "Get one customer with the first 10 addresses, marketing consent, order statistics and 25 metafields.", "description": "Get one customer with the first 10 addresses, marketing consent, order statistics and 25 metafields.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.customers.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyCustomersGetResponse" }, "example": { "id": "example", "display_name": "example", "first_name": "example", "last_name": "example", "email": "ada@example.com", "phone": "example", "state": "example", "verified_email": false, "number_of_orders": 0, "amount_spent": { "amount": "example", "currency_code": "example" }, "tags": [], "locale": "example", "email_marketing_state": "example", "default_address": { "name": "Customer documents", "company": "example", "address1": "example", "address2": "example", "city": "example", "province_code": "example", "country_code": "example", "zip": "example", "phone": "example" }, "last_order": { "id": "example", "name": "Customer documents" }, "created_at": "example", "updated_at": "example", "note": "example", "addresses": [], "metafields": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyCustomersGetRequest" }, "example": { "customer_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/shopify/customers/list": { "post": { "operationId": "integrationsShopifyCustomersList", "summary": "List customers with search syntax (e.g", "description": "List customers with search syntax (e.g. `email:*@example.com orders_count:>3`).", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.customers.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyCustomersListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyCustomersListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/shopify/discounts/get": { "post": { "operationId": "integrationsShopifyDiscountsGet", "summary": "Get one discount by its DiscountNode ID.", "description": "Get one discount by its DiscountNode ID.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.discounts.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyDiscountsGetResponse" }, "example": { "id": "example", "method": "code", "kind": "schedule", "title": "Approve supplier payment", "code": "example", "status": "ACTIVE", "summary": "Extracts totals and due dates from supplier invoices.", "discount_classes": [], "starts_at": "example", "ends_at": "example", "usage_count": 0, "usage_limit": 0, "applies_once_per_customer": false, "combines_with": { "order_discounts": false, "product_discounts": false, "shipping_discounts": false }, "created_at": "example", "updated_at": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyDiscountsGetRequest" }, "example": { "discount_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/shopify/discounts/list": { "post": { "operationId": "integrationsShopifyDiscountsList", "summary": "List code and automatic discounts with status, schedule and usage.", "description": "List code and automatic discounts with status, schedule and usage.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.discounts.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyDiscountsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyDiscountsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/shopify/draft-orders/get": { "post": { "operationId": "integrationsShopifyDraftOrdersGet", "summary": "Get one draft order with the first 50 line items and addresses.", "description": "Get one draft order with the first 50 line items and addresses.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.draft_orders.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyDraftOrdersGetResponse" }, "example": { "id": "example", "name": "Customer documents", "status": "ACTIVE", "created_at": "example", "updated_at": "example", "completed_at": "example", "invoice_sent_at": "example", "currency_code": "example", "subtotal": { "amount": "example", "currency_code": "example" }, "total_price": { "amount": "example", "currency_code": "example" }, "total_tax": { "amount": "example", "currency_code": "example" }, "customer": { "id": "example", "display_name": "example", "email": "ada@example.com" }, "email": "ada@example.com", "tags": [], "order_id": "example", "note": "example", "line_items": [], "line_items_truncated": false, "shipping_address": { "name": "Customer documents", "company": "example", "address1": "example", "address2": "example", "city": "example", "province_code": "example", "country_code": "example", "zip": "example", "phone": "example" }, "billing_address": { "name": "Customer documents", "company": "example", "address1": "example", "address2": "example", "city": "example", "province_code": "example", "country_code": "example", "zip": "example", "phone": "example" }, "shipping_line": { "title": "Approve supplier payment", "price": { "amount": "example", "currency_code": "example" } }, "discount_codes": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyDraftOrdersGetRequest" }, "example": { "draft_order_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/shopify/draft-orders/list": { "post": { "operationId": "integrationsShopifyDraftOrdersList", "summary": "List draft orders with search syntax and status.", "description": "List draft orders with search syntax and status.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.draft_orders.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyDraftOrdersListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyDraftOrdersListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/shopify/fulfillment-orders/list": { "post": { "operationId": "integrationsShopifyFulfillmentOrdersList", "summary": "List fulfillment orders with status, assigned location and the first 50 line items with remaining quantities.", "description": "List fulfillment orders with status, assigned location and the first 50 line items with remaining quantities.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.fulfillment_orders.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyFulfillmentOrdersListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyFulfillmentOrdersListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/shopify/inventory-items/get": { "post": { "operationId": "integrationsShopifyInventoryItemsGet", "summary": "Get one inventory item with its stock levels at the first 50 locations (available, on hand, committed, incoming, reserved).", "description": "Get one inventory item with its stock levels at the first 50 locations (available, on hand, committed, incoming, reserved).", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.inventory_items.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyInventoryItemsGetResponse" }, "example": { "id": "example", "sku": "example", "tracked": false, "requires_shipping": false, "unit_cost": { "amount": "example", "currency_code": "example" }, "country_code_of_origin": "example", "harmonized_system_code": "example", "variant_id": "example", "product_id": "example", "variant_title": "example", "created_at": "example", "updated_at": "example", "levels": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyInventoryItemsGetRequest" }, "example": { "inventory_item_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/shopify/inventory-items/list": { "post": { "operationId": "integrationsShopifyInventoryItemsList", "summary": "List inventory items (SKU, cost, tracking) with search syntax (e.g", "description": "List inventory items (SKU, cost, tracking) with search syntax (e.g. `sku:ABC-1`).", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.inventory_items.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyInventoryItemsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyInventoryItemsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/shopify/inventory-levels/list": { "post": { "operationId": "integrationsShopifyInventoryLevelsList", "summary": "List the stock levels of one location across inventory items with all quantity states.", "description": "List the stock levels of one location across inventory items with all quantity states.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.inventory_levels.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyInventoryLevelsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyInventoryLevelsListRequest" }, "example": { "location_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/shopify/locations/list": { "post": { "operationId": "integrationsShopifyLocationsList", "summary": "List the store locations (warehouses, retail, fulfillment services).", "description": "List the store locations (warehouses, retail, fulfillment services).", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.locations.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyLocationsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyLocationsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/shopify/marketing-events/list": { "post": { "operationId": "integrationsShopifyMarketingEventsList", "summary": "List marketing events (campaigns, ads, posts) with UTM parameters and schedule.", "description": "List marketing events (campaigns, ads, posts) with UTM parameters and schedule.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.marketing_events.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyMarketingEventsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyMarketingEventsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/shopify/markets/list": { "post": { "operationId": "integrationsShopifyMarketsList", "summary": "List markets with status, currency settings and region countries.", "description": "List markets with status, currency settings and region countries.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.markets.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyMarketsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyMarketsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/shopify/metafield-definitions/list": { "post": { "operationId": "integrationsShopifyMetafieldDefinitionsList", "summary": "List metafield definitions for one owner type (product, variant, customer, order, ...).", "description": "List metafield definitions for one owner type (product, variant, customer, order, ...).", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.metafield_definitions.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyMetafieldDefinitionsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyMetafieldDefinitionsListRequest" }, "example": { "owner_type": "product" } } } } } }, "/integrations/connections/{connection_id}/providers/shopify/metafields/list": { "post": { "operationId": "integrationsShopifyMetafieldsList", "summary": "List the metafields of one resource by its global ID, optionally filtered by namespace.", "description": "List the metafields of one resource by its global ID, optionally filtered by namespace.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.metafields.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyMetafieldsListResponse" }, "example": { "owner_id": "example", "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyMetafieldsListRequest" }, "example": { "owner_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/shopify/metaobject-definitions/list": { "post": { "operationId": "integrationsShopifyMetaobjectDefinitionsList", "summary": "List metaobject definitions with their field definitions.", "description": "List metaobject definitions with their field definitions.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.metaobject_definitions.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyMetaobjectDefinitionsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyMetaobjectDefinitionsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/shopify/metaobjects/list": { "post": { "operationId": "integrationsShopifyMetaobjectsList", "summary": "List the metaobject entries of one metaobject type with their field values.", "description": "List the metaobject entries of one metaobject type with their field values.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.metaobjects.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyMetaobjectsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyMetaobjectsListRequest" }, "example": { "type": "1" } } } } } }, "/integrations/connections/{connection_id}/providers/shopify/orders/get": { "post": { "operationId": "integrationsShopifyOrdersGet", "summary": "Get one order with the first 50 line items, addresses, fulfillments, transactions, refunds, returns and 25 metafields.", "description": "Get one order with the first 50 line items, addresses, fulfillments, transactions, refunds, returns and 25 metafields.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.orders.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyOrdersGetResponse" }, "example": { "id": "example", "name": "Customer documents", "created_at": "example", "processed_at": "example", "updated_at": "example", "cancelled_at": "example", "closed": false, "test": false, "display_financial_status": "example", "display_fulfillment_status": "example", "currency_code": "example", "subtotal": { "amount": "example", "currency_code": "example" }, "total_price": { "amount": "example", "currency_code": "example" }, "total_tax": { "amount": "example", "currency_code": "example" }, "total_discounts": { "amount": "example", "currency_code": "example" }, "total_shipping": { "amount": "example", "currency_code": "example" }, "total_refunded": { "amount": "example", "currency_code": "example" }, "customer": { "id": "example", "display_name": "example", "email": "ada@example.com" }, "email": "ada@example.com", "tags": [], "line_items_quantity": 0, "source_name": "example", "sales_channel": "example", "shipping_country_code": "example", "note": "example", "phone": "example", "line_items": [], "line_items_truncated": false, "shipping_address": { "name": "Customer documents", "company": "example", "address1": "example", "address2": "example", "city": "example", "province_code": "example", "country_code": "example", "zip": "example", "phone": "example" }, "billing_address": { "name": "Customer documents", "company": "example", "address1": "example", "address2": "example", "city": "example", "province_code": "example", "country_code": "example", "zip": "example", "phone": "example" }, "shipping_line": { "title": "Approve supplier payment", "price": { "amount": "example", "currency_code": "example" } }, "discount_codes": [], "payment_gateway_names": [], "fulfillments": [], "fulfillment_orders": [], "transactions": [], "refunds": [], "returns": [], "metafields": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyOrdersGetRequest" }, "example": { "order_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/shopify/orders/list": { "post": { "operationId": "integrationsShopifyOrdersList", "summary": "List orders with search syntax (e.g", "description": "List orders with search syntax (e.g. `created_at:>2026-01-01 financial_status:paid`), totals and status.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.orders.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyOrdersListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyOrdersListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/shopify/payouts/list": { "post": { "operationId": "integrationsShopifyPayoutsList", "summary": "List Shopify Payments payouts with net amount and fee breakdown.", "description": "List Shopify Payments payouts with net amount and fee breakdown.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.payouts.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyPayoutsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyPayoutsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/shopify/product-tags/list": { "post": { "operationId": "integrationsShopifyProductTagsList", "summary": "List the distinct product tags of the store.", "description": "List the distinct product tags of the store.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.product_tags.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyProductTagsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyProductTagsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/shopify/product-types/list": { "post": { "operationId": "integrationsShopifyProductTypesList", "summary": "List the distinct product types of the store.", "description": "List the distinct product types of the store.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.product_types.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyProductTypesListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyProductTypesListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/shopify/product-variants/get": { "post": { "operationId": "integrationsShopifyProductVariantsGet", "summary": "Get one product variant with price, SKU, barcode, options and inventory data.", "description": "Get one product variant with price, SKU, barcode, options and inventory data.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.product_variants.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyProductVariantsGetResponse" }, "example": { "id": "example", "product_id": "example", "title": "Approve supplier payment", "display_name": "example", "sku": "example", "barcode": "example", "price": "example", "compare_at_price": "example", "position": 0, "inventory_quantity": 0, "inventory_item_id": "example", "inventory_policy": "example", "taxable": false, "available_for_sale": false, "selected_options": [], "image_url": "example", "created_at": "example", "updated_at": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyProductVariantsGetRequest" }, "example": { "variant_id": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/shopify/product-variants/list": { "post": { "operationId": "integrationsShopifyProductVariantsList", "summary": "List product variants with search syntax (e.g", "description": "List product variants with search syntax (e.g. `sku:ABC-1`), optionally scoped to one product.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.product_variants.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyProductVariantsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyProductVariantsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/shopify/product-vendors/list": { "post": { "operationId": "integrationsShopifyProductVendorsList", "summary": "List the distinct product vendors of the store.", "description": "List the distinct product vendors of the store.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.product_vendors.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyProductVendorsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyProductVendorsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/shopify/products/get": { "post": { "operationId": "integrationsShopifyProductsGet", "summary": "Get one product by ID or handle with options, first 100 variants, 20 media, 20 collections, 50 metafields and SEO.", "description": "Get one product by ID or handle with options, first 100 variants, 20 media, 20 collections, 50 metafields and SEO.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.products.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyProductsGetResponse" }, "example": { "id": "example", "handle": "example", "title": "Approve supplier payment", "status": "ACTIVE", "vendor": "example", "product_type": "example", "tags": [], "total_inventory": 0, "tracks_inventory": false, "price_min": { "amount": "example", "currency_code": "example" }, "price_max": { "amount": "example", "currency_code": "example" }, "variants_count": 0, "has_only_default_variant": false, "online_store_url": "example", "featured_image_url": "example", "created_at": "example", "updated_at": "example", "published_at": "example", "description": "example", "options": [], "variants": [], "variants_truncated": false, "media": [], "collections": [], "metafields": [], "seo": { "title": "Approve supplier payment", "description": "example" } } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyProductsGetRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/shopify/products/list": { "post": { "operationId": "integrationsShopifyProductsList", "summary": "List products with Shopify search syntax (e.g", "description": "List products with Shopify search syntax (e.g. `vendor:Acme tag:sale`), sort and cursor pagination.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.products.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyProductsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyProductsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/shopify/publications/list": { "post": { "operationId": "integrationsShopifyPublicationsList", "summary": "List sales channels (publications) products can be published to.", "description": "List sales channels (publications) products can be published to.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.publications.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyPublicationsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyPublicationsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/shopify/reports/query": { "post": { "operationId": "integrationsShopifyReportsQuery", "summary": "Run a ShopifyQL analytics query (e.g", "description": "Run a ShopifyQL analytics query (e.g. `FROM sales SHOW total_sales GROUP BY month SINCE -3m`); rows are capped at 1000.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.reports.query", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyReportsQueryResponse" }, "example": { "columns": [], "rows": [], "row_count": 0, "truncated": false, "parse_errors": [] } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyReportsQueryRequest" }, "example": { "shopifyql": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/shopify/segments/list": { "post": { "operationId": "integrationsShopifySegmentsList", "summary": "List customer segments with their segment query.", "description": "List customer segments with their segment query.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.segments.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifySegmentsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifySegmentsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/shopify/shop/get": { "post": { "operationId": "integrationsShopifyShopGet", "summary": "Get the store profile: name, domains, currency, timezone, plan.", "description": "Get the store profile: name, domains, currency, timezone, plan.", "tags": [ "Shopify" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.shopify.shop.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyShopGetResponse" }, "example": { "id": "example", "name": "Customer documents", "myshopify_domain": "example", "primary_domain": "example", "contact_email": "example", "currency_code": "example", "enabled_presentment_currencies": [], "timezone": "example", "country_code": "example", "plan_name": "example", "weight_unit": "example", "taxes_included": false, "created_at": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsShopifyShopGetRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/slack/conversations/list": { "post": { "operationId": "integrationsSlackConversationsList", "summary": "List the channels, private groups, group DMs, and DMs the connected Slack user belongs to, with cursor pagination.", "description": "List the channels, private groups, group DMs, and DMs the connected Slack user belongs to, with cursor pagination.", "tags": [ "Slack" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.slack.conversations.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsSlackConversationsListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsSlackConversationsListRequest" }, "example": {} } } } } }, "/integrations/connections/{connection_id}/providers/slack/conversations/open": { "post": { "operationId": "integrationsSlackConversationsOpen", "summary": "Open (or resume) a direct message with one user or a group DM with up to eight users; returns the conversation ID to send messages to.", "description": "Open (or resume) a direct message with one user or a group DM with up to eight users; returns the conversation ID to send messages to.", "tags": [ "Slack" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.slack.conversations.open", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" }, { "name": "External side effect" } ], "x-risk-level": "reversible", "x-effect": "external_side_effect", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsSlackConversationsOpenResponse" }, "example": { "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "job_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsSlackConversationsOpenRequest" }, "example": { "user_ids": [ "UAAAAAAAA" ] } } } } } }, "/integrations/connections/{connection_id}/providers/slack/messages/list": { "post": { "operationId": "integrationsSlackMessagesList", "summary": "Read the newest messages of one Slack conversation, optionally bounded by a timestamp window, with cursor pagination (max 15 per page).", "description": "Read the newest messages of one Slack conversation, optionally bounded by a timestamp window, with cursor pagination (max 15 per page).", "tags": [ "Slack" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.slack.messages.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsSlackMessagesListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsSlackMessagesListRequest" }, "example": { "channel_id": "CAAAAAAAA" } } } } } }, "/integrations/connections/{connection_id}/providers/slack/messages/search": { "post": { "operationId": "integrationsSlackMessagesSearch", "summary": "Search messages across every conversation the connected Slack user can see, newest first, using Slack search syntax (in:, from:, before:).", "description": "Search messages across every conversation the connected Slack user can see, newest first, using Slack search syntax (in:, from:, before:).", "tags": [ "Slack" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.slack.messages.search", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsSlackMessagesSearchResponse" }, "example": { "items": [], "total": 0, "has_more": false } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsSlackMessagesSearchRequest" }, "example": { "query": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/slack/messages/send": { "post": { "operationId": "integrationsSlackMessagesSend", "summary": "Post a message as the connected Slack user into a channel, group DM, or DM, optionally as a thread reply.", "description": "Post a message as the connected Slack user into a channel, group DM, or DM, optionally as a thread reply.", "tags": [ "Slack" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.slack.messages.send", "x-required-scope": "integrations:destroy", "x-badges": [ { "name": "integrations:destroy", "position": "before" }, { "name": "External side effect" } ], "x-risk-level": "irreversible", "x-effect": "external_side_effect", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsSlackMessagesSendResponse" }, "example": { "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "job_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsSlackMessagesSendRequest" }, "example": { "channel_id": "CAAAAAAAA", "text": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/slack/reactions/add": { "post": { "operationId": "integrationsSlackReactionsAdd", "summary": "Add an emoji reaction as the connected Slack user to one message.", "description": "Add an emoji reaction as the connected Slack user to one message.", "tags": [ "Slack" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "x-operation-key": "integrations.slack.reactions.add", "x-required-scope": "integrations:write", "x-badges": [ { "name": "integrations:write", "position": "before" }, { "name": "External side effect" } ], "x-risk-level": "reversible", "x-effect": "external_side_effect", "x-execution-mode": "queued", "x-idempotent": false, "responses": { "202": { "description": "Accepted for asynchronous processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsSlackReactionsAddResponse" }, "example": { "invocation_id": "123e4567-e89b-42d3-a456-426614174000", "status": "ACTIVE", "job_id": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" }, "Location": { "$ref": "#/components/headers/Location" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsSlackReactionsAddRequest" }, "example": { "channel_id": "CAAAAAAAA", "message_ts": "0000000000.000000", "reaction": "example" } } } } } }, "/integrations/connections/{connection_id}/providers/slack/threads/get": { "post": { "operationId": "integrationsSlackThreadsGet", "summary": "Read the replies of one Slack thread identified by its parent message timestamp, with cursor pagination (max 15 per page).", "description": "Read the replies of one Slack thread identified by its parent message timestamp, with cursor pagination (max 15 per page).", "tags": [ "Slack" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.slack.threads.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsSlackThreadsGetResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsSlackThreadsGetRequest" }, "example": { "channel_id": "CAAAAAAAA", "thread_ts": "0000000000.000000" } } } } } }, "/integrations/connections/{connection_id}/providers/slack/users/get": { "post": { "operationId": "integrationsSlackUsersGet", "summary": "Fetch the profile of one Slack workspace member by user ID.", "description": "Fetch the profile of one Slack workspace member by user ID.", "tags": [ "Slack" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.slack.users.get", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsSlackUsersGetResponse" }, "example": { "user_id": "example", "name": "Customer documents", "real_name": "example", "display_name": "example", "email": "ada@example.com", "is_bot": false, "deleted": false, "tz": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsSlackUsersGetRequest" }, "example": { "user_id": "UAAAAAAAA" } } } } } }, "/integrations/connections/{connection_id}/providers/slack/users/list": { "post": { "operationId": "integrationsSlackUsersList", "summary": "List the members of the Slack workspace with cursor pagination.", "description": "List the members of the Slack workspace with cursor pagination.", "tags": [ "Slack" ], "parameters": [ { "$ref": "#/components/parameters/RequestId" }, { "name": "connection_id", "in": "path", "required": true, "description": "Resource identifier: connection_id.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-42d3-a456-426614174000" } ], "x-operation-key": "integrations.slack.users.list", "x-required-scope": "integrations:read", "x-badges": [ { "name": "integrations:read", "position": "before" } ], "x-risk-level": "none", "x-effect": "read", "x-execution-mode": "sync", "x-idempotent": true, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsSlackUsersListResponse" }, "example": { "items": [], "next_cursor": "example" } } }, "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "Idempotent-Replayed": { "$ref": "#/components/headers/Idempotent-Replayed" } } }, "400": { "description": "Request failed with HTTP 400.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsafe_lifecycle_details", "title": "Unsafe lifecycle details", "status": 400, "code": "unsafe_lifecycle_details", "request_id": "req_example" } } } }, "401": { "description": "Request failed with HTTP 401.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unauthorized", "title": "Unauthorized", "status": 401, "code": "unauthorized", "request_id": "req_example" } } } }, "402": { "description": "Request failed with HTTP 402.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/billing_credits_exhausted", "title": "Billing credits exhausted", "status": 402, "code": "billing_credits_exhausted", "request_id": "req_example" } } } }, "403": { "description": "Request failed with HTTP 403.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/access_denied", "title": "Access denied", "status": 403, "code": "access_denied", "request_id": "req_example" } } } }, "404": { "description": "Request failed with HTTP 404.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_not_found", "title": "Integration not found", "status": 404, "code": "integration_not_found", "request_id": "req_example" } } } }, "405": { "description": "Request failed with HTTP 405.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/method_not_allowed", "title": "Method not allowed", "status": 405, "code": "method_not_allowed", "request_id": "req_example" } } } }, "409": { "description": "Request failed with HTTP 409.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_disconnect_required", "title": "Integration disconnect required", "status": 409, "code": "integration_disconnect_required", "request_id": "req_example" } } } }, "410": { "description": "Request failed with HTTP 410.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/route_retired", "title": "Route retired", "status": 410, "code": "route_retired", "request_id": "req_example" } } } }, "413": { "description": "Request failed with HTTP 413.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/zip_too_large", "title": "Zip too large", "status": 413, "code": "zip_too_large", "request_id": "req_example" } } } }, "415": { "description": "Request failed with HTTP 415.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/unsupported_media_type", "title": "Unsupported media type", "status": 415, "code": "unsupported_media_type", "request_id": "req_example" } } } }, "422": { "description": "Request failed with HTTP 422.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/idempotency_key_reused", "title": "Idempotency key reused", "status": 422, "code": "idempotency_key_reused", "request_id": "req_example" } } } }, "429": { "description": "Request failed with HTTP 429.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_rate_limited", "title": "Integration rate limited", "status": 429, "code": "integration_rate_limited", "request_id": "req_example" } } } }, "500": { "description": "Request failed with HTTP 500.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/internal_error", "title": "Internal error", "status": 500, "code": "internal_error", "request_id": "req_example" } } } }, "502": { "description": "Request failed with HTTP 502.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_provider_error", "title": "Integration provider error", "status": 502, "code": "integration_provider_error", "request_id": "req_example" } } } }, "503": { "description": "Request failed with HTTP 503.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_temporarily_unavailable", "title": "Integration temporarily unavailable", "status": 503, "code": "integration_temporarily_unavailable", "request_id": "req_example" } } } }, "504": { "description": "Request failed with HTTP 504.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://developers.adlass.io/errors/integration_timeout", "title": "Integration timeout", "status": 504, "code": "integration_timeout", "request_id": "req_example" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsSlackUsersListRequest" }, "example": {} } } } } } }, "components": { "securitySchemes": { "bearerApiKey": { "type": "http", "scheme": "bearer", "bearerFormat": "adl_live_… or adl_test_…", "description": "Create a scoped API key in the Adlass settings." } }, "schemas": { "Problem": { "type": "object", "required": [ "type", "title", "status", "code", "request_id" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "request_id": { "type": "string" }, "required_scope": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" } } } } } }, "SpacesListRequest": { "type": "object", "properties": { "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, "title": "SpacesListRequest" }, "SpacesListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "clerk_user_id": { "type": "string" }, "name": { "type": "string" }, "storage_prefix": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "role": { "type": "string" }, "is_owner": { "type": "boolean" }, "can_read": { "type": "boolean" }, "can_download": { "type": "boolean" }, "can_upload": { "type": "boolean" }, "can_delete": { "type": "boolean" }, "can_rename": { "type": "boolean" }, "document_count": { "type": "integer" }, "member_count": { "type": "integer" }, "skill_count": { "type": "integer" } }, "required": [ "id", "clerk_user_id", "name", "storage_prefix", "created_at", "role", "is_owner", "can_read", "can_download", "can_upload", "can_delete", "can_rename", "document_count", "member_count", "skill_count" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." }, "total": { "type": "integer" } }, "required": [ "items", "next_cursor", "total" ], "additionalProperties": false, "title": "SpacesListResponse" }, "SpacesCreateRequest": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "maxLength": 255 } }, "title": "SpacesCreateRequest" }, "SpacesCreateResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "clerk_user_id": { "type": "string" }, "name": { "type": "string" }, "storage_prefix": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "role": { "type": "string" }, "is_owner": { "type": "boolean" }, "can_read": { "type": "boolean" }, "can_download": { "type": "boolean" }, "can_upload": { "type": "boolean" }, "can_delete": { "type": "boolean" }, "can_rename": { "type": "boolean" }, "document_count": { "type": "integer" }, "member_count": { "type": "integer" }, "skill_count": { "type": "integer" } }, "required": [ "id", "clerk_user_id", "name", "storage_prefix", "created_at", "role", "is_owner", "can_read", "can_download", "can_upload", "can_delete", "can_rename", "document_count", "member_count", "skill_count" ], "additionalProperties": false, "title": "SpacesCreateResponse" }, "SpacesGetRequest": { "type": "object", "properties": {}, "title": "SpacesGetRequest" }, "SpacesGetResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "clerk_user_id": { "type": "string" }, "name": { "type": "string" }, "storage_prefix": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "role": { "type": "string" }, "is_owner": { "type": "boolean" }, "can_read": { "type": "boolean" }, "can_download": { "type": "boolean" }, "can_upload": { "type": "boolean" }, "can_delete": { "type": "boolean" }, "can_rename": { "type": "boolean" }, "document_count": { "type": "integer" }, "member_count": { "type": "integer" }, "skill_count": { "type": "integer" } }, "required": [ "id", "clerk_user_id", "name", "storage_prefix", "created_at", "role", "is_owner", "can_read", "can_download", "can_upload", "can_delete", "can_rename", "document_count", "member_count", "skill_count" ], "additionalProperties": false, "title": "SpacesGetResponse" }, "SpacesUpdateRequest": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 } }, "title": "SpacesUpdateRequest" }, "SpacesUpdateResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "clerk_user_id": { "type": "string" }, "name": { "type": "string" }, "storage_prefix": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "role": { "type": "string" }, "is_owner": { "type": "boolean" }, "can_read": { "type": "boolean" }, "can_download": { "type": "boolean" }, "can_upload": { "type": "boolean" }, "can_delete": { "type": "boolean" }, "can_rename": { "type": "boolean" }, "document_count": { "type": "integer" }, "member_count": { "type": "integer" }, "skill_count": { "type": "integer" } }, "required": [ "id", "clerk_user_id", "name", "storage_prefix", "created_at", "role", "is_owner", "can_read", "can_download", "can_upload", "can_delete", "can_rename", "document_count", "member_count", "skill_count" ], "additionalProperties": false, "title": "SpacesUpdateResponse" }, "SpacesDeleteRequest": { "type": "object", "properties": {}, "title": "SpacesDeleteRequest" }, "SpacesDeleteResponse": { "type": "object", "properties": { "space_id": { "type": "string", "format": "uuid" }, "outcome": { "type": "string", "enum": [ "deleted" ] } }, "required": [ "space_id", "outcome" ], "additionalProperties": false, "title": "SpacesDeleteResponse" }, "SpacesSummaryRequest": { "type": "object", "properties": {}, "title": "SpacesSummaryRequest" }, "SpacesSummaryResponse": { "type": "object", "properties": { "available": { "type": "boolean" }, "content": { "type": [ "object", "null" ], "additionalProperties": true }, "fact_count": { "type": [ "integer", "null" ] }, "generated_at": { "type": [ "string", "null" ] } }, "required": [ "available", "content", "fact_count", "generated_at" ], "additionalProperties": false, "title": "SpacesSummaryResponse" }, "SpacesJobsInProgressRequest": { "type": "object", "properties": {}, "title": "SpacesJobsInProgressRequest" }, "SpacesJobsInProgressResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "document_id": { "type": "string", "format": "uuid" }, "file_name": { "type": "string" } }, "required": [ "document_id", "file_name" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false, "title": "SpacesJobsInProgressResponse" }, "SpacesCleanRequest": { "type": "object", "properties": {}, "title": "SpacesCleanRequest" }, "SpacesCleanResponse": { "type": "object", "properties": { "space_id": { "type": "string", "format": "uuid" }, "deleted_documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "file_name": { "type": "string" }, "status": { "type": "string", "enum": [ "deleted", "error" ] }, "error": { "type": "string" } }, "required": [ "id", "file_name", "status" ], "additionalProperties": false } }, "facts_rows_deleted": { "type": "integer" }, "optimize_metrics": { "type": "object", "additionalProperties": true }, "vacuum_files_deleted": { "type": "integer" } }, "required": [ "space_id", "deleted_documents", "facts_rows_deleted", "optimize_metrics", "vacuum_files_deleted" ], "additionalProperties": false, "title": "SpacesCleanResponse" }, "SpacesSharesListRequest": { "type": "object", "properties": { "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, "title": "SpacesSharesListRequest" }, "SpacesSharesListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "user_id": { "type": [ "string", "null" ], "format": "uuid" }, "email": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "role": { "enum": [ "OWNER", "ADMIN", "EDITOR", "READER" ], "type": "string" }, "can_read": { "type": "boolean" }, "can_download": { "type": "boolean" }, "can_upload": { "type": "boolean" }, "can_delete": { "type": "boolean" }, "can_rename": { "type": "boolean" }, "status": { "enum": [ "INVITED", "ACTIVE" ], "type": "string" }, "accept_url": { "type": [ "string", "null" ] }, "invited_by": { "type": [ "object", "null" ], "additionalProperties": {} }, "accepted_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_invited_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "space_id", "user_id", "email", "name", "role", "can_read", "can_download", "can_upload", "can_delete", "can_rename", "status", "accept_url", "invited_by", "accepted_at", "last_invited_at", "created_at", "updated_at" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "additionalProperties": false, "title": "SpacesSharesListResponse" }, "SpacesShareRequest": { "type": "object", "required": [ "email", "role" ], "properties": { "email": { "type": "string", "format": "email" }, "role": { "type": "string", "enum": [ "ADMIN", "EDITOR", "READER" ] }, "can_read": { "type": [ "boolean", "null" ] }, "can_download": { "type": [ "boolean", "null" ] }, "can_upload": { "type": [ "boolean", "null" ] }, "can_delete": { "type": [ "boolean", "null" ] }, "can_rename": { "type": [ "boolean", "null" ] } }, "title": "SpacesShareRequest" }, "SpacesShareResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "user_id": { "type": [ "string", "null" ], "format": "uuid" }, "email": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "role": { "enum": [ "ADMIN", "EDITOR", "READER" ], "type": "string" }, "can_read": { "type": "boolean" }, "can_download": { "type": "boolean" }, "can_upload": { "type": "boolean" }, "can_delete": { "type": "boolean" }, "can_rename": { "type": "boolean" }, "status": { "enum": [ "INVITED", "ACTIVE" ], "type": "string" }, "accept_url": { "type": [ "string", "null" ] }, "invited_by": { "type": [ "object", "null" ], "additionalProperties": {} }, "accepted_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_invited_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "space_id", "user_id", "email", "name", "role", "can_read", "can_download", "can_upload", "can_delete", "can_rename", "status", "accept_url", "invited_by", "accepted_at", "last_invited_at", "created_at", "updated_at" ], "additionalProperties": false, "title": "SpacesShareResponse" }, "SpacesShareUpdateRequest": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "ADMIN", "EDITOR", "READER" ] }, "can_read": { "type": [ "boolean", "null" ] }, "can_download": { "type": [ "boolean", "null" ] }, "can_upload": { "type": [ "boolean", "null" ] }, "can_delete": { "type": [ "boolean", "null" ] }, "can_rename": { "type": [ "boolean", "null" ] } }, "title": "SpacesShareUpdateRequest" }, "SpacesShareUpdateResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "user_id": { "type": [ "string", "null" ], "format": "uuid" }, "email": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "role": { "enum": [ "ADMIN", "EDITOR", "READER" ], "type": "string" }, "can_read": { "type": "boolean" }, "can_download": { "type": "boolean" }, "can_upload": { "type": "boolean" }, "can_delete": { "type": "boolean" }, "can_rename": { "type": "boolean" }, "status": { "enum": [ "INVITED", "ACTIVE" ], "type": "string" }, "accept_url": { "type": [ "string", "null" ] }, "invited_by": { "type": [ "object", "null" ], "additionalProperties": {} }, "accepted_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_invited_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "space_id", "user_id", "email", "name", "role", "can_read", "can_download", "can_upload", "can_delete", "can_rename", "status", "accept_url", "invited_by", "accepted_at", "last_invited_at", "created_at", "updated_at" ], "additionalProperties": false, "title": "SpacesShareUpdateResponse" }, "SpacesShareRevokeRequest": { "type": "object", "properties": {}, "title": "SpacesShareRevokeRequest" }, "SpacesShareRevokeResponse": { "type": "object", "properties": { "space_id": { "type": "string", "format": "uuid" }, "membership_id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "revoked" ] } }, "required": [ "space_id", "membership_id", "status" ], "additionalProperties": false, "title": "SpacesShareRevokeResponse" }, "SpacesShareAcceptRequest": { "type": "object", "properties": {}, "title": "SpacesShareAcceptRequest" }, "SpacesShareAcceptResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "user_id": { "type": [ "string", "null" ], "format": "uuid" }, "email": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "role": { "enum": [ "ADMIN", "EDITOR", "READER" ], "type": "string" }, "can_read": { "type": "boolean" }, "can_download": { "type": "boolean" }, "can_upload": { "type": "boolean" }, "can_delete": { "type": "boolean" }, "can_rename": { "type": "boolean" }, "status": { "enum": [ "INVITED", "ACTIVE" ], "type": "string" }, "accept_url": { "type": [ "string", "null" ] }, "invited_by": { "type": [ "object", "null" ], "additionalProperties": {} }, "accepted_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_invited_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "space_id", "user_id", "email", "name", "role", "can_read", "can_download", "can_upload", "can_delete", "can_rename", "status", "accept_url", "invited_by", "accepted_at", "last_invited_at", "created_at", "updated_at" ], "additionalProperties": false, "title": "SpacesShareAcceptResponse" }, "SpacesShareDeclineRequest": { "type": "object", "properties": {}, "title": "SpacesShareDeclineRequest" }, "SpacesShareDeclineResponse": { "type": "object", "properties": { "space_id": { "type": "string", "format": "uuid" }, "membership_id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "declined" ] } }, "required": [ "space_id", "membership_id", "status" ], "additionalProperties": false, "title": "SpacesShareDeclineResponse" }, "SpacesShareResendRequest": { "type": "object", "properties": {}, "title": "SpacesShareResendRequest" }, "SpacesShareResendResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "user_id": { "type": [ "string", "null" ], "format": "uuid" }, "email": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "role": { "enum": [ "ADMIN", "EDITOR", "READER" ], "type": "string" }, "can_read": { "type": "boolean" }, "can_download": { "type": "boolean" }, "can_upload": { "type": "boolean" }, "can_delete": { "type": "boolean" }, "can_rename": { "type": "boolean" }, "status": { "enum": [ "INVITED", "ACTIVE" ], "type": "string" }, "accept_url": { "type": [ "string", "null" ] }, "invited_by": { "type": [ "object", "null" ], "additionalProperties": {} }, "accepted_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_invited_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "space_id", "user_id", "email", "name", "role", "can_read", "can_download", "can_upload", "can_delete", "can_rename", "status", "accept_url", "invited_by", "accepted_at", "last_invited_at", "created_at", "updated_at" ], "additionalProperties": false, "title": "SpacesShareResendResponse" }, "SpacesInvitationsMineRequest": { "type": "object", "properties": {}, "title": "SpacesInvitationsMineRequest" }, "SpacesInvitationsMineResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "space_name": { "type": "string" }, "role": { "enum": [ "ADMIN", "EDITOR", "READER" ], "type": "string" }, "invited_by": { "type": [ "object", "null" ], "additionalProperties": {} }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "space_id", "space_name", "role", "invited_by", "created_at" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false, "title": "SpacesInvitationsMineResponse" }, "DocumentsFoldersListRequest": { "type": "object", "properties": { "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, "title": "DocumentsFoldersListRequest" }, "DocumentsFoldersListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "parent_id": { "type": [ "string", "null" ], "format": "uuid" }, "name": { "type": "string" }, "path": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "document_count": { "type": "integer" }, "child_folder_count": { "type": "integer" } }, "required": [ "id", "space_id", "parent_id", "name", "path", "created_at", "document_count", "child_folder_count" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "additionalProperties": false, "title": "DocumentsFoldersListResponse" }, "DocumentsFolderCreateRequest": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "maxLength": 255 }, "parent_folder_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "DocumentsFolderCreateRequest" }, "DocumentsFolderCreateResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "parent_id": { "type": [ "string", "null" ], "format": "uuid" }, "name": { "type": "string" }, "path": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "document_count": { "type": "integer" }, "child_folder_count": { "type": "integer" } }, "required": [ "id", "space_id", "parent_id", "name", "path", "created_at", "document_count", "child_folder_count" ], "additionalProperties": false, "title": "DocumentsFolderCreateResponse" }, "DocumentsFolderRenameRequest": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "maxLength": 255 } }, "title": "DocumentsFolderRenameRequest" }, "DocumentsFolderRenameResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "parent_id": { "type": [ "string", "null" ], "format": "uuid" }, "name": { "type": "string" }, "path": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "document_count": { "type": "integer" }, "child_folder_count": { "type": "integer" } }, "required": [ "id", "space_id", "parent_id", "name", "path", "created_at", "document_count", "child_folder_count" ], "additionalProperties": false, "title": "DocumentsFolderRenameResponse" }, "DocumentsFolderDeleteRequest": { "type": "object", "properties": {}, "title": "DocumentsFolderDeleteRequest" }, "DocumentsFolderDeleteResponse": { "type": "object", "properties": { "folder_id": { "type": "string", "format": "uuid" }, "outcome": { "type": "string", "enum": [ "deleted" ] } }, "required": [ "folder_id", "outcome" ], "additionalProperties": false, "title": "DocumentsFolderDeleteResponse" }, "DocumentsFolderMoveRequest": { "type": "object", "required": [ "parent_folder_id" ], "properties": { "parent_folder_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "DocumentsFolderMoveRequest" }, "DocumentsFolderMoveResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "parent_id": { "type": [ "string", "null" ], "format": "uuid" }, "name": { "type": "string" }, "path": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "document_count": { "type": "integer" }, "child_folder_count": { "type": "integer" } }, "required": [ "id", "space_id", "parent_id", "name", "path", "created_at", "document_count", "child_folder_count" ], "additionalProperties": false, "title": "DocumentsFolderMoveResponse" }, "DocumentsSpaceContentsRequest": { "type": "object", "properties": {}, "title": "DocumentsSpaceContentsRequest" }, "DocumentsSpaceContentsResponse": { "type": "object", "properties": { "space_id": { "type": "string", "format": "uuid" }, "folder_id": { "type": [ "string", "null" ], "format": "uuid" }, "path": { "type": "string" }, "folders": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "parent_id": { "type": [ "string", "null" ], "format": "uuid" }, "name": { "type": "string" }, "path": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "document_count": { "type": "integer" }, "child_folder_count": { "type": "integer" } }, "required": [ "id", "space_id", "parent_id", "name", "path", "created_at", "document_count", "child_folder_count" ], "additionalProperties": false } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "tenant_id": { "type": "string", "format": "uuid" }, "workspace_id": { "type": [ "string", "null" ], "format": "uuid" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "folder_id": { "type": [ "string", "null" ], "format": "uuid" }, "uploaded_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "file_name": { "type": "string" }, "content_type": { "type": "string" }, "file_size": { "type": "integer" }, "storage_key": { "type": "string" }, "status": { "enum": [ "PENDING_UPLOAD", "UPLOADED", "PROCESSING", "PROCESSED", "FAILED", "ARCHIVED" ], "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "doc_origin": { "enum": [ "UPLOADED", "NATIVE", "PUBLIC", "IMPORTED" ], "type": "string" }, "live_content_type": { "enum": [ "MARKDOWN", "STRUCTURED_TABLE", "DATABASE", "HTML", null ], "type": [ "string", "null" ] }, "has_active_collab_session": { "type": "boolean" }, "has_content": { "type": "boolean" } }, "required": [ "id", "tenant_id", "workspace_id", "space_id", "folder_id", "uploaded_by", "file_name", "content_type", "file_size", "storage_key", "status", "created_at", "doc_origin", "live_content_type", "has_active_collab_session", "has_content" ], "additionalProperties": false } } }, "required": [ "space_id", "folder_id", "path", "folders", "documents" ], "additionalProperties": false, "title": "DocumentsSpaceContentsResponse" }, "DocumentsFolderContentsRequest": { "type": "object", "properties": {}, "title": "DocumentsFolderContentsRequest" }, "DocumentsFolderContentsResponse": { "type": "object", "properties": { "space_id": { "type": "string", "format": "uuid" }, "folder_id": { "type": [ "string", "null" ], "format": "uuid" }, "path": { "type": "string" }, "folders": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "parent_id": { "type": [ "string", "null" ], "format": "uuid" }, "name": { "type": "string" }, "path": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "document_count": { "type": "integer" }, "child_folder_count": { "type": "integer" } }, "required": [ "id", "space_id", "parent_id", "name", "path", "created_at", "document_count", "child_folder_count" ], "additionalProperties": false } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "tenant_id": { "type": "string", "format": "uuid" }, "workspace_id": { "type": [ "string", "null" ], "format": "uuid" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "folder_id": { "type": [ "string", "null" ], "format": "uuid" }, "uploaded_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "file_name": { "type": "string" }, "content_type": { "type": "string" }, "file_size": { "type": "integer" }, "storage_key": { "type": "string" }, "status": { "enum": [ "PENDING_UPLOAD", "UPLOADED", "PROCESSING", "PROCESSED", "FAILED", "ARCHIVED" ], "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "doc_origin": { "enum": [ "UPLOADED", "NATIVE", "PUBLIC", "IMPORTED" ], "type": "string" }, "live_content_type": { "enum": [ "MARKDOWN", "STRUCTURED_TABLE", "DATABASE", "HTML", null ], "type": [ "string", "null" ] }, "has_active_collab_session": { "type": "boolean" }, "has_content": { "type": "boolean" } }, "required": [ "id", "tenant_id", "workspace_id", "space_id", "folder_id", "uploaded_by", "file_name", "content_type", "file_size", "storage_key", "status", "created_at", "doc_origin", "live_content_type", "has_active_collab_session", "has_content" ], "additionalProperties": false } } }, "required": [ "space_id", "folder_id", "path", "folders", "documents" ], "additionalProperties": false, "title": "DocumentsFolderContentsResponse" }, "DocumentsLsRequest": { "type": "object", "properties": { "path": { "type": "string", "default": "/" } }, "title": "DocumentsLsRequest" }, "DocumentsLsResponse": { "type": "object", "properties": { "space_id": { "type": "string", "format": "uuid" }, "path": { "type": "string" }, "entries": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "dir", "file" ] }, "document_id": { "type": [ "string", "null" ], "format": "uuid" }, "size": { "type": [ "integer", "null" ] } }, "required": [ "name", "type", "document_id", "size" ], "additionalProperties": false } } }, "required": [ "space_id", "path", "entries" ], "additionalProperties": false, "title": "DocumentsLsResponse" }, "DocumentsListRequest": { "type": "object", "properties": { "space_id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "PENDING_UPLOAD", "UPLOADED", "PROCESSING", "PROCESSED", "FAILED", "ARCHIVED" ] }, "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, "title": "DocumentsListRequest" }, "DocumentsListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "tenant_id": { "type": "string", "format": "uuid" }, "workspace_id": { "type": [ "string", "null" ], "format": "uuid" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "folder_id": { "type": [ "string", "null" ], "format": "uuid" }, "uploaded_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "file_name": { "type": "string" }, "content_type": { "type": "string" }, "file_size": { "type": "integer" }, "storage_key": { "type": "string" }, "status": { "enum": [ "PENDING_UPLOAD", "UPLOADED", "PROCESSING", "PROCESSED", "FAILED", "ARCHIVED" ], "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "doc_origin": { "enum": [ "UPLOADED", "NATIVE", "PUBLIC", "IMPORTED" ], "type": "string" }, "live_content_type": { "enum": [ "MARKDOWN", "STRUCTURED_TABLE", "DATABASE", "HTML", null ], "type": [ "string", "null" ] }, "has_active_collab_session": { "type": "boolean" }, "has_content": { "type": "boolean" } }, "required": [ "id", "tenant_id", "workspace_id", "space_id", "folder_id", "uploaded_by", "file_name", "content_type", "file_size", "storage_key", "status", "created_at", "doc_origin", "live_content_type", "has_active_collab_session", "has_content" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "additionalProperties": false, "title": "DocumentsListResponse" }, "DocumentsUploadInitiateRequest": { "type": "object", "required": [ "space_id", "file_name", "file_size" ], "properties": { "space_id": { "type": "string", "format": "uuid" }, "folder_id": { "type": [ "string", "null" ], "format": "uuid" }, "file_name": { "type": "string", "maxLength": 500 }, "content_type": { "type": "string", "maxLength": 200 }, "file_size": { "type": "integer", "minimum": 0, "maximum": 52428800, "description": "Size in bytes; uploads above 50 MB are rejected." } }, "title": "DocumentsUploadInitiateRequest" }, "DocumentsUploadInitiateResponse": { "type": "object", "properties": { "document_id": { "type": "string", "format": "uuid" }, "storage_key": { "type": "string" }, "status": { "type": "string" }, "space_id": { "type": "string", "format": "uuid" }, "folder_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "document_id", "storage_key", "status", "space_id", "folder_id" ], "additionalProperties": false, "title": "DocumentsUploadInitiateResponse" }, "DocumentsGetRequest": { "type": "object", "properties": {}, "title": "DocumentsGetRequest" }, "DocumentsGetResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "tenant_id": { "type": "string", "format": "uuid" }, "workspace_id": { "type": [ "string", "null" ], "format": "uuid" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "folder_id": { "type": [ "string", "null" ], "format": "uuid" }, "uploaded_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "file_name": { "type": "string" }, "content_type": { "type": "string" }, "file_size": { "type": "integer" }, "storage_key": { "type": "string" }, "status": { "enum": [ "PENDING_UPLOAD", "UPLOADED", "PROCESSING", "PROCESSED", "FAILED", "ARCHIVED" ], "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "doc_origin": { "enum": [ "UPLOADED", "NATIVE", "PUBLIC", "IMPORTED" ], "type": "string" }, "live_content_type": { "enum": [ "MARKDOWN", "STRUCTURED_TABLE", "DATABASE", "HTML", null ], "type": [ "string", "null" ] }, "has_active_collab_session": { "type": "boolean" }, "has_content": { "type": "boolean" }, "collab_mode": { "type": "string", "enum": [ "write", "read" ] } }, "required": [ "id", "tenant_id", "workspace_id", "space_id", "folder_id", "uploaded_by", "file_name", "content_type", "file_size", "storage_key", "status", "created_at", "doc_origin", "live_content_type", "has_active_collab_session", "has_content", "collab_mode" ], "additionalProperties": false, "title": "DocumentsGetResponse" }, "DocumentsUploadUrlRequest": { "type": "object", "properties": {}, "title": "DocumentsUploadUrlRequest" }, "DocumentsUploadUrlResponse": { "type": "object", "properties": { "document_id": { "type": "string", "format": "uuid" }, "presigned_url": { "type": "string", "format": "uri" }, "expires_at": { "type": "string", "format": "date-time" }, "instructions_for_agent": { "type": "string" } }, "required": [ "document_id", "presigned_url", "expires_at", "instructions_for_agent" ], "additionalProperties": false, "title": "DocumentsUploadUrlResponse" }, "DocumentsUploadConfirmRequest": { "type": "object", "properties": {}, "title": "DocumentsUploadConfirmRequest" }, "DocumentsUploadConfirmResponse": { "type": "object", "properties": { "document_id": { "type": "string", "format": "uuid" }, "document_status": { "type": "string" }, "processing_job_id": { "type": "string", "format": "uuid" }, "processing_status": { "type": "string" } }, "required": [ "document_id", "document_status", "processing_job_id", "processing_status" ], "additionalProperties": false, "title": "DocumentsUploadConfirmResponse" }, "DocumentsDownloadRequest": { "type": "object", "properties": {}, "title": "DocumentsDownloadRequest" }, "DocumentsDownloadResponse": { "type": "object", "properties": { "document_id": { "type": "string", "format": "uuid" }, "file_name": { "type": "string" }, "presigned_url": { "type": "string", "format": "uri" }, "instructions_for_agent": { "type": "string" } }, "required": [ "document_id", "file_name", "presigned_url", "instructions_for_agent" ], "additionalProperties": false, "title": "DocumentsDownloadResponse" }, "DocumentsDownloadBulkRequest": { "type": "object", "required": [ "document_ids" ], "properties": { "document_ids": { "type": "array", "minItems": 1, "maxItems": 50, "items": { "type": "string", "format": "uuid" } } }, "title": "DocumentsDownloadBulkRequest" }, "DocumentsDownloadBulkResponse": { "type": "object", "properties": { "presigned_url": { "type": "string", "format": "uri" }, "zip_file_name": { "type": "string" }, "file_count": { "type": "integer" }, "total_size_bytes": { "type": "integer" }, "expires_at": { "type": "string", "format": "date-time" }, "failed_document_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "instructions_for_agent": { "type": "string" } }, "required": [ "presigned_url", "zip_file_name", "file_count", "total_size_bytes", "expires_at", "failed_document_ids", "instructions_for_agent" ], "additionalProperties": false, "title": "DocumentsDownloadBulkResponse" }, "DocumentsRenameRequest": { "type": "object", "required": [ "file_name" ], "properties": { "file_name": { "type": "string", "maxLength": 500 } }, "title": "DocumentsRenameRequest" }, "DocumentsRenameResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "tenant_id": { "type": "string", "format": "uuid" }, "workspace_id": { "type": [ "string", "null" ], "format": "uuid" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "folder_id": { "type": [ "string", "null" ], "format": "uuid" }, "uploaded_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "file_name": { "type": "string" }, "content_type": { "type": "string" }, "file_size": { "type": "integer" }, "storage_key": { "type": "string" }, "status": { "enum": [ "PENDING_UPLOAD", "UPLOADED", "PROCESSING", "PROCESSED", "FAILED", "ARCHIVED" ], "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "doc_origin": { "enum": [ "UPLOADED", "NATIVE", "PUBLIC", "IMPORTED" ], "type": "string" }, "live_content_type": { "enum": [ "MARKDOWN", "STRUCTURED_TABLE", "DATABASE", "HTML", null ], "type": [ "string", "null" ] }, "has_active_collab_session": { "type": "boolean" }, "has_content": { "type": "boolean" } }, "required": [ "id", "tenant_id", "workspace_id", "space_id", "folder_id", "uploaded_by", "file_name", "content_type", "file_size", "storage_key", "status", "created_at", "doc_origin", "live_content_type", "has_active_collab_session", "has_content" ], "additionalProperties": false, "title": "DocumentsRenameResponse" }, "DocumentsMoveRequest": { "type": "object", "properties": { "destination_folder_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "DocumentsMoveRequest" }, "DocumentsMoveResponse": { "type": "object", "properties": { "document_id": { "type": "string", "format": "uuid" }, "file_name": { "type": "string" }, "new_storage_key": { "type": "string" }, "destination_folder_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "document_id", "file_name", "new_storage_key", "destination_folder_id" ], "additionalProperties": false, "title": "DocumentsMoveResponse" }, "DocumentsBulkMoveRequest": { "type": "object", "required": [ "document_ids" ], "properties": { "document_ids": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "type": "string", "format": "uuid" } }, "destination_folder_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "DocumentsBulkMoveRequest" }, "DocumentsBulkMoveResponse": { "type": "object", "properties": { "moved_count": { "type": "integer" }, "failed_document_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "moved_count", "failed_document_ids" ], "additionalProperties": false, "title": "DocumentsBulkMoveResponse" }, "DocumentsDeleteRequest": { "type": "object", "properties": {}, "title": "DocumentsDeleteRequest" }, "DocumentsDeleteResponse": { "type": "object", "properties": { "document_id": { "type": "string", "format": "uuid" }, "outcome": { "type": "string", "enum": [ "deleted" ] } }, "required": [ "document_id", "outcome" ], "additionalProperties": false, "title": "DocumentsDeleteResponse" }, "DocumentsBulkDeleteRequest": { "type": "object", "required": [ "document_ids" ], "properties": { "document_ids": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "type": "string", "format": "uuid" } } }, "title": "DocumentsBulkDeleteRequest" }, "DocumentsBulkDeleteResponse": { "type": "object", "properties": { "deleted_count": { "type": "integer" }, "failed_document_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "deleted_count", "failed_document_ids" ], "additionalProperties": false, "title": "DocumentsBulkDeleteResponse" }, "DocumentsLiveCreateRequest": { "type": "object", "required": [ "space_id", "file_name", "content_type" ], "properties": { "space_id": { "type": "string", "format": "uuid" }, "folder_id": { "type": [ "string", "null" ], "format": "uuid" }, "file_name": { "type": "string", "maxLength": 500 }, "content_type": { "type": "string", "enum": [ "application/vnd.adlass.live-document", "application/vnd.adlass.live-sheet", "application/vnd.adlass.live-database" ] }, "content": { "type": "string", "description": "Optional initial markdown body; only valid for live markdown documents." } }, "title": "DocumentsLiveCreateRequest" }, "DocumentsLiveCreateResponse": { "type": "object", "required": [ "id", "tenant_id", "workspace_id", "space_id", "folder_id", "uploaded_by", "file_name", "content_type", "file_size", "storage_key", "status", "created_at", "doc_origin", "live_content_type", "has_active_collab_session" ], "properties": { "id": { "type": "string", "format": "uuid" }, "tenant_id": { "type": "string", "format": "uuid" }, "workspace_id": { "type": [ "string", "null" ], "format": "uuid" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "folder_id": { "type": [ "string", "null" ], "format": "uuid" }, "uploaded_by": { "type": [ "object", "null" ] }, "file_name": { "type": "string" }, "content_type": { "type": "string" }, "file_size": { "type": "integer" }, "storage_key": { "type": "string" }, "status": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "doc_origin": { "type": "string" }, "live_content_type": { "type": [ "string", "null" ] }, "has_active_collab_session": { "type": "boolean" } }, "title": "DocumentsLiveCreateResponse" }, "DocumentsLiveReadRequest": { "type": "object", "properties": {}, "title": "DocumentsLiveReadRequest" }, "DocumentsLiveReadResponse": { "type": "object", "required": [ "document_id", "file_name", "live_content_type", "content_hash" ], "properties": { "document_id": { "type": "string", "format": "uuid" }, "file_name": { "type": "string" }, "live_content_type": { "type": "string", "enum": [ "MARKDOWN", "STRUCTURED_TABLE", "DATABASE" ] }, "content_hash": { "type": "string" }, "content": { "type": [ "string", "null" ], "description": "Markdown body; null unless live_content_type is MARKDOWN." }, "rows": { "type": [ "object", "null" ], "description": "Row id -> cell values; null for MARKDOWN documents." }, "row_order": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Display order; only set for STRUCTURED_TABLE documents." }, "schema": { "type": "object", "description": "Property specs; only present for DATABASE documents." }, "views": { "type": "object", "description": "View specs; only present for DATABASE documents." } }, "title": "DocumentsLiveReadResponse" }, "DocumentsLiveEditRequest": { "type": "object", "properties": { "expected_content_hash": { "type": "string", "maxLength": 64 }, "content": { "type": "string", "description": "Full markdown body; replaces the document's text." }, "cells": { "type": "array", "items": { "type": "object", "required": [ "row_id", "column_id", "value" ], "properties": { "row_id": { "type": "string", "maxLength": 200 }, "column_id": { "type": "string", "maxLength": 200 }, "value": { "type": "string" } } } }, "row_order": { "type": "array", "items": { "type": "string", "maxLength": 200 }, "description": "Full row order; rows not listed are appended sorted by id." } }, "title": "DocumentsLiveEditRequest" }, "DocumentsLiveEditResponse": { "type": "object", "required": [ "document_id", "content_hash", "changed" ], "properties": { "document_id": { "type": "string", "format": "uuid" }, "content_hash": { "type": "string" }, "changed": { "type": "boolean" } }, "title": "DocumentsLiveEditResponse" }, "DocumentsLiveSaveRequest": { "type": "object", "properties": {}, "title": "DocumentsLiveSaveRequest" }, "DocumentsLiveSaveResponse": { "type": "object", "required": [ "document_id", "saved_at", "extraction_requested" ], "properties": { "document_id": { "type": "string", "format": "uuid" }, "saved_at": { "type": "string", "format": "date-time" }, "extraction_requested": { "type": "boolean" } }, "title": "DocumentsLiveSaveResponse" }, "DocumentsDatabaseReadRequest": { "type": "object", "properties": {}, "title": "DocumentsDatabaseReadRequest" }, "DocumentsDatabaseReadResponse": { "type": "object", "required": [ "document_id", "file_name", "content_hash", "schema", "views", "rows" ], "properties": { "document_id": { "type": "string", "format": "uuid" }, "file_name": { "type": "string" }, "content_hash": { "type": "string" }, "schema": { "type": "object", "description": "Maps property ids to property specs (type, name, options)." }, "views": { "type": "object" }, "rows": { "type": "object", "description": "Maps row ids to objects of property id -> cell value." } }, "title": "DocumentsDatabaseReadResponse" }, "DocumentsDatabaseRowCreateRequest": { "type": "object", "required": [ "cells" ], "properties": { "expected_content_hash": { "type": "string", "maxLength": 64 }, "cells": { "type": "object", "description": "Maps property ids to string values, e.g. {\"title\": \"Fix login bug\", \"status\": \"todo\"}. Read the database first to see valid property ids and select options; null clears a cell." } }, "title": "DocumentsDatabaseRowCreateRequest" }, "DocumentsDatabaseRowCreateResponse": { "type": "object", "required": [ "document_id", "content_hash", "changed", "row_id" ], "properties": { "document_id": { "type": "string", "format": "uuid" }, "content_hash": { "type": "string" }, "changed": { "type": "boolean" }, "row_id": { "type": "string" } }, "title": "DocumentsDatabaseRowCreateResponse" }, "DocumentsDatabaseRowUpdateRequest": { "type": "object", "required": [ "cells" ], "properties": { "expected_content_hash": { "type": "string", "maxLength": 64 }, "cells": { "type": "object", "description": "Maps property ids to string values, e.g. {\"title\": \"Fix login bug\", \"status\": \"todo\"}. Read the database first to see valid property ids and select options; null clears a cell." } }, "title": "DocumentsDatabaseRowUpdateRequest" }, "DocumentsDatabaseRowUpdateResponse": { "type": "object", "required": [ "document_id", "content_hash", "changed", "row_id" ], "properties": { "document_id": { "type": "string", "format": "uuid" }, "content_hash": { "type": "string" }, "changed": { "type": "boolean" }, "row_id": { "type": "string" } }, "title": "DocumentsDatabaseRowUpdateResponse" }, "DocumentsDatabaseRowDeleteRequest": { "type": "object", "properties": { "expected_content_hash": { "type": "string", "maxLength": 64 } }, "title": "DocumentsDatabaseRowDeleteRequest" }, "DocumentsDatabaseRowDeleteResponse": { "type": "object", "required": [ "document_id", "content_hash", "changed", "row_id" ], "properties": { "document_id": { "type": "string", "format": "uuid" }, "content_hash": { "type": "string" }, "changed": { "type": "boolean" }, "row_id": { "type": "string" } }, "title": "DocumentsDatabaseRowDeleteResponse" }, "DocumentsFactsReadRequest": { "type": "object", "properties": { "keyword": { "type": "string", "description": "Optional keyword filter" }, "limit": { "type": "integer", "minimum": 1, "maximum": 50, "default": 50 }, "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, "title": "DocumentsFactsReadRequest" }, "DocumentsFactsReadResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "properties": { "items": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Resources in this page." }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "title": "DocumentsFactsReadResponse" }, "DocumentsFactsGrepRequest": { "type": "object", "required": [ "pattern" ], "properties": { "pattern": { "type": "string", "description": "Free-form search term, or a regex when regex=true" }, "regex": { "type": "boolean", "default": false }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, "title": "DocumentsFactsGrepRequest" }, "DocumentsFactsGrepResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "title": "DocumentsFactsGrepResponse" }, "DocumentsFactsCatRequest": { "type": "object", "properties": {}, "title": "DocumentsFactsCatRequest" }, "DocumentsFactsCatResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "title": "DocumentsFactsCatResponse" }, "DocumentsJobsListRequest": { "type": "object", "properties": { "document_id": { "type": "string", "format": "uuid" }, "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, "title": "DocumentsJobsListRequest" }, "DocumentsJobsListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "document_id": { "type": "string", "format": "uuid" }, "job_type": { "type": "string" }, "status": { "enum": [ "QUEUED", "RUNNING", "COMPLETED", "FAILED" ], "type": "string" }, "celery_task_id": { "type": [ "string", "null" ] }, "started_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": [ "string", "null" ], "format": "date-time" }, "error_message": { "type": "string" } }, "required": [ "id", "document_id", "job_type", "status", "celery_task_id", "started_at", "completed_at", "error_message" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "additionalProperties": false, "title": "DocumentsJobsListResponse" }, "DocumentsJobsGetRequest": { "type": "object", "properties": {}, "title": "DocumentsJobsGetRequest" }, "DocumentsJobsGetResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "document_id": { "type": "string", "format": "uuid" }, "job_type": { "type": "string" }, "status": { "enum": [ "QUEUED", "RUNNING", "COMPLETED", "FAILED" ], "type": "string" }, "celery_task_id": { "type": [ "string", "null" ] }, "started_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": [ "string", "null" ], "format": "date-time" }, "error_message": { "type": "string" } }, "required": [ "id", "document_id", "job_type", "status", "celery_task_id", "started_at", "completed_at", "error_message" ], "additionalProperties": false, "title": "DocumentsJobsGetResponse" }, "SkillsSearchRequest": { "type": "object", "properties": { "query": { "type": "string", "description": "Name or summary text" }, "space_id": { "type": "string", "format": "uuid", "description": "Scope run statistics and automation flags to one Space" }, "kind": { "type": "string", "enum": [ "PLATFORM", "AGENT" ], "description": "Only Skills of this kind; omit for all" }, "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, "title": "SkillsSearchRequest" }, "SkillsSearchResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "slug": { "type": "string" }, "kind": { "type": "string", "enum": [ "PLATFORM", "AGENT" ] }, "name": { "type": "string" }, "summary": { "type": "string" }, "status": { "type": "string" }, "visibility": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } }, "is_template": { "type": "boolean" }, "current_version": { "type": [ "integer", "null" ] }, "has_draft": { "type": "boolean" }, "draft_revision": { "type": "integer" }, "draft_updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_by_id": { "type": [ "string", "null" ], "format": "uuid" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "access_mode": { "type": "string" }, "share_count": { "type": "integer" }, "access": { "type": [ "object", "null" ], "properties": { "share_role": { "type": [ "string", "null" ] }, "is_creator": { "type": "boolean" }, "access_mode": { "type": "string" }, "can_view": { "type": "boolean" }, "can_run": { "type": "boolean" }, "can_edit": { "type": "boolean" }, "can_share": { "type": "boolean" }, "can_archive": { "type": "boolean" } }, "required": [ "share_role", "is_creator", "access_mode", "can_view", "can_run", "can_edit", "can_share", "can_archive" ], "additionalProperties": false }, "updated_at": { "type": "string", "format": "date-time" }, "run_count": { "type": "integer" }, "total_cost_micro_usd": { "type": "integer" }, "total_micro_credits": { "type": "integer" }, "last_run_at": { "type": [ "string", "null" ], "format": "date-time" }, "automation_active": { "type": "boolean" } }, "required": [ "id", "slug", "kind", "name", "summary", "status", "visibility", "categories", "tags", "is_template", "current_version", "has_draft", "draft_revision", "draft_updated_at", "created_by_id", "created_by", "access_mode", "share_count", "access", "updated_at", "run_count", "total_cost_micro_usd", "total_micro_credits", "last_run_at", "automation_active" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "additionalProperties": false, "title": "SkillsSearchResponse" }, "SkillsCreateRequest": { "type": "object", "properties": { "template_id": { "type": "string", "format": "uuid", "description": "Platform template to clone; not combined with draft." }, "draft": { "type": "object", "description": "Initial draft content; not combined with template_id.", "additionalProperties": false, "properties": { "name": { "type": "string", "maxLength": 200 }, "summary": { "type": "string", "maxLength": 1000 }, "categories": { "type": "array", "items": { "type": "string", "maxLength": 100 } }, "tags": { "type": "array", "items": { "type": "string", "maxLength": 100 } }, "instructions": { "title": "Instructions", "type": "string" }, "capabilities": { "items": { "maxLength": 80, "type": "string" }, "title": "Capabilities", "type": "array" }, "steps": { "items": { "additionalProperties": false, "properties": { "title": { "maxLength": 200, "title": "Title", "type": "string" }, "detail": { "title": "Detail", "type": "string" } }, "title": "SkillStep", "type": "object" }, "maxItems": 40, "title": "Steps", "type": "array" }, "inputs": { "description": "Input keys must be unique.", "items": { "additionalProperties": false, "properties": { "key": { "maxLength": 80, "title": "Key", "type": "string" }, "type": { "enum": [ "text", "document" ], "title": "Type", "type": "string" }, "label": { "maxLength": 120, "title": "Label", "type": "string" }, "description": { "default": "", "maxLength": 2000, "title": "Description", "type": "string" }, "required": { "default": false, "title": "Required", "type": "boolean" } }, "title": "SkillInput", "type": "object" }, "maxItems": 10, "title": "Inputs", "type": "array", "uniqueItems": true, "x-uniqueBy": "key" }, "outputs": { "description": "Output keys must be unique.", "items": { "additionalProperties": false, "properties": { "key": { "maxLength": 80, "title": "Key", "type": "string" }, "type": { "enum": [ "doc", "sheet", "page" ], "title": "Type", "type": "string" }, "nameTemplate": { "maxLength": 200, "title": "Nametemplate", "type": "string" }, "description": { "default": "", "maxLength": 2000, "title": "Description", "type": "string" }, "mode": { "enum": [ "new", "persistent" ], "title": "Mode", "type": "string" }, "folderId": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "title": "Folderid" }, "link": { "anyOf": [ { "additionalProperties": false, "properties": { "expiresInDays": { "anyOf": [ { "maximum": 365, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Expiresindays" }, "accessMode": { "default": "ANONYMOUS", "enum": [ "ANONYMOUS", "EMAIL", "EMAIL_VERIFIED" ], "title": "Accessmode", "type": "string" }, "submissionMode": { "default": "MULTIPLE", "enum": [ "NONE", "SINGLE", "MULTIPLE" ], "title": "Submissionmode", "type": "string" } }, "title": "SkillPageLink", "type": "object" }, { "type": "null" } ], "default": null } }, "title": "SkillOutput", "type": "object" }, "maxItems": 10, "title": "Outputs", "type": "array", "uniqueItems": true, "x-uniqueBy": "key" }, "scope": { "anyOf": [ { "additionalProperties": false, "properties": { "folderIds": { "items": { "format": "uuid", "type": "string" }, "maxItems": 100, "title": "Folderids", "type": "array" }, "documentIds": { "items": { "format": "uuid", "type": "string" }, "maxItems": 1000, "title": "Documentids", "type": "array" }, "recordTypeIds": { "items": { "format": "uuid", "type": "string" }, "maxItems": 100, "title": "Recordtypeids", "type": "array" } }, "title": "SkillScope", "type": "object" }, { "type": "null" } ], "default": null }, "settings": { "additionalProperties": false, "properties": { "reviewerEnabled": { "default": false, "title": "Reviewerenabled", "type": "boolean" }, "reviewMaxRounds": { "default": 1, "maximum": 3, "minimum": 1, "title": "Reviewmaxrounds", "type": "integer" }, "webSearchEnabled": { "default": false, "title": "Websearchenabled", "type": "boolean" }, "webSearchContextSize": { "default": "medium", "enum": [ "low", "medium", "high" ], "title": "Websearchcontextsize", "type": "string" }, "browserEnabled": { "default": false, "title": "Browserenabled", "type": "boolean" }, "defaultModel": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "default": null, "title": "Defaultmodel" }, "defaultEffort": { "default": "medium", "enum": [ "none", "low", "medium", "high", "xhigh", "max" ], "title": "Defaulteffort", "type": "string" }, "maxTurns": { "default": 60, "maximum": 120, "minimum": 1, "title": "Maxturns", "type": "integer" } }, "title": "SkillSettings", "type": "object" }, "integrations": { "items": { "additionalProperties": false, "description": "A logical provider requirement; personal identifiers are never stored here.", "properties": { "key": { "maxLength": 80, "title": "Key", "type": "string" }, "providerKey": { "maxLength": 80, "title": "Providerkey", "type": "string" }, "operations": { "items": { "additionalProperties": false, "properties": { "resource": { "maxLength": 80, "title": "Resource", "type": "string" }, "operation": { "maxLength": 80, "title": "Operation", "type": "string" } }, "title": "SkillIntegrationOperation", "type": "object" }, "maxItems": 50, "title": "Operations", "type": "array" } }, "title": "SkillIntegrationAccess", "type": "object" }, "maxItems": 20, "title": "Integrations", "type": "array", "uniqueItems": true, "x-uniqueBy": "key" }, "emailAccess": { "anyOf": [ { "additionalProperties": false, "description": "A logical mailbox policy resolved to the running user's own connection.", "properties": { "key": { "const": "email", "default": "email", "title": "Key", "type": "string" }, "read": { "default": true, "title": "Read", "type": "boolean" }, "readAttachments": { "default": false, "title": "Readattachments", "type": "boolean" }, "lookbackDays": { "default": 7, "maximum": 90, "minimum": 1, "title": "Lookbackdays", "type": "integer" }, "send": { "default": false, "title": "Send", "type": "boolean" }, "maxSendPerRun": { "default": 1, "maximum": 50, "minimum": 1, "title": "Maxsendperrun", "type": "integer" }, "sendAttachments": { "default": false, "title": "Sendattachments", "type": "boolean" }, "allowedRecipients": { "items": { "type": "string" }, "maxItems": 50, "title": "Allowedrecipients", "type": "array" } }, "title": "SkillEmailAccess", "type": "object" }, { "type": "null" } ], "default": null }, "adaptBeforeUse": { "items": { "type": "string" }, "maxItems": 5, "title": "Adaptbeforeuse", "type": "array" }, "files": { "items": { "additionalProperties": false, "properties": { "path": { "maxLength": 200, "title": "Path", "type": "string" }, "content": { "maxLength": 100000, "title": "Content", "type": "string" } }, "title": "AgentSkillFile", "type": "object" }, "maxItems": 50, "title": "Files", "type": "array", "uniqueItems": true, "x-uniqueBy": "path" } } }, "kind": { "type": "string", "enum": [ "PLATFORM", "AGENT" ], "description": "PLATFORM runs in Adlass; AGENT is a SKILL.md-style skill for local coding agents" } }, "title": "SkillsCreateRequest" }, "SkillsCreateResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "slug": { "type": "string" }, "kind": { "type": "string", "enum": [ "PLATFORM", "AGENT" ] }, "name": { "type": "string" }, "summary": { "type": "string" }, "status": { "type": "string" }, "visibility": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } }, "is_template": { "type": "boolean" }, "current_version": { "type": [ "integer", "null" ] }, "has_draft": { "type": "boolean" }, "draft_revision": { "type": "integer" }, "draft_updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_by_id": { "type": [ "string", "null" ], "format": "uuid" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "access_mode": { "type": "string" }, "share_count": { "type": "integer" }, "access": { "type": [ "object", "null" ], "properties": { "share_role": { "type": [ "string", "null" ] }, "is_creator": { "type": "boolean" }, "access_mode": { "type": "string" }, "can_view": { "type": "boolean" }, "can_run": { "type": "boolean" }, "can_edit": { "type": "boolean" }, "can_share": { "type": "boolean" }, "can_archive": { "type": "boolean" } }, "required": [ "share_role", "is_creator", "access_mode", "can_view", "can_run", "can_edit", "can_share", "can_archive" ], "additionalProperties": false }, "updated_at": { "type": "string", "format": "date-time" }, "version": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" }, "definition": { "type": "object", "additionalProperties": true }, "content_hash": { "type": "string" }, "change_note": { "type": [ "string", "null" ] }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "version", "definition", "content_hash", "change_note", "created_at" ], "additionalProperties": false }, "draft": { "type": [ "object", "null" ], "additionalProperties": true }, "stubs": { "type": "object", "properties": { "skill": { "type": "string" }, "project": { "type": "string" } }, "required": [ "skill", "project" ], "additionalProperties": false } }, "required": [ "id", "slug", "kind", "name", "summary", "status", "visibility", "categories", "tags", "is_template", "current_version", "has_draft", "draft_revision", "draft_updated_at", "created_by_id", "created_by", "access_mode", "share_count", "access", "updated_at", "version", "draft" ], "additionalProperties": false, "title": "SkillsCreateResponse" }, "SkillsGetRequest": { "type": "object", "properties": {}, "title": "SkillsGetRequest" }, "SkillsGetResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "slug": { "type": "string" }, "kind": { "type": "string", "enum": [ "PLATFORM", "AGENT" ] }, "name": { "type": "string" }, "summary": { "type": "string" }, "status": { "type": "string" }, "visibility": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } }, "is_template": { "type": "boolean" }, "current_version": { "type": [ "integer", "null" ] }, "has_draft": { "type": "boolean" }, "draft_revision": { "type": "integer" }, "draft_updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_by_id": { "type": [ "string", "null" ], "format": "uuid" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "access_mode": { "type": "string" }, "share_count": { "type": "integer" }, "access": { "type": [ "object", "null" ], "properties": { "share_role": { "type": [ "string", "null" ] }, "is_creator": { "type": "boolean" }, "access_mode": { "type": "string" }, "can_view": { "type": "boolean" }, "can_run": { "type": "boolean" }, "can_edit": { "type": "boolean" }, "can_share": { "type": "boolean" }, "can_archive": { "type": "boolean" } }, "required": [ "share_role", "is_creator", "access_mode", "can_view", "can_run", "can_edit", "can_share", "can_archive" ], "additionalProperties": false }, "updated_at": { "type": "string", "format": "date-time" }, "version": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" }, "definition": { "type": "object", "additionalProperties": true }, "content_hash": { "type": "string" }, "change_note": { "type": [ "string", "null" ] }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "version", "definition", "content_hash", "change_note", "created_at" ], "additionalProperties": false }, "draft": { "type": [ "object", "null" ], "additionalProperties": true }, "stubs": { "type": "object", "properties": { "skill": { "type": "string" }, "project": { "type": "string" } }, "required": [ "skill", "project" ], "additionalProperties": false } }, "required": [ "id", "slug", "kind", "name", "summary", "status", "visibility", "categories", "tags", "is_template", "current_version", "has_draft", "draft_revision", "draft_updated_at", "created_by_id", "created_by", "access_mode", "share_count", "access", "updated_at", "version", "draft" ], "additionalProperties": false, "title": "SkillsGetResponse" }, "SkillsRenameRequest": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "maxLength": 200 } }, "title": "SkillsRenameRequest" }, "SkillsRenameResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "slug": { "type": "string" }, "kind": { "type": "string", "enum": [ "PLATFORM", "AGENT" ] }, "name": { "type": "string" }, "summary": { "type": "string" }, "status": { "type": "string" }, "visibility": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } }, "is_template": { "type": "boolean" }, "current_version": { "type": [ "integer", "null" ] }, "has_draft": { "type": "boolean" }, "draft_revision": { "type": "integer" }, "draft_updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_by_id": { "type": [ "string", "null" ], "format": "uuid" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "access_mode": { "type": "string" }, "share_count": { "type": "integer" }, "access": { "type": [ "object", "null" ], "properties": { "share_role": { "type": [ "string", "null" ] }, "is_creator": { "type": "boolean" }, "access_mode": { "type": "string" }, "can_view": { "type": "boolean" }, "can_run": { "type": "boolean" }, "can_edit": { "type": "boolean" }, "can_share": { "type": "boolean" }, "can_archive": { "type": "boolean" } }, "required": [ "share_role", "is_creator", "access_mode", "can_view", "can_run", "can_edit", "can_share", "can_archive" ], "additionalProperties": false }, "updated_at": { "type": "string", "format": "date-time" }, "version": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" }, "definition": { "type": "object", "additionalProperties": true }, "content_hash": { "type": "string" }, "change_note": { "type": [ "string", "null" ] }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "version", "definition", "content_hash", "change_note", "created_at" ], "additionalProperties": false }, "draft": { "type": [ "object", "null" ], "additionalProperties": true }, "stubs": { "type": "object", "properties": { "skill": { "type": "string" }, "project": { "type": "string" } }, "required": [ "skill", "project" ], "additionalProperties": false } }, "required": [ "id", "slug", "kind", "name", "summary", "status", "visibility", "categories", "tags", "is_template", "current_version", "has_draft", "draft_revision", "draft_updated_at", "created_by_id", "created_by", "access_mode", "share_count", "access", "updated_at", "version", "draft" ], "additionalProperties": false, "title": "SkillsRenameResponse" }, "SkillsDeleteRequest": { "type": "object", "properties": {}, "title": "SkillsDeleteRequest" }, "SkillsDeleteResponse": { "type": "object", "properties": { "outcome": { "type": "string", "enum": [ "deleted" ] } }, "required": [ "outcome" ], "additionalProperties": false, "title": "SkillsDeleteResponse" }, "SkillsDraftSaveRequest": { "type": "object", "required": [ "expected_revision", "draft" ], "properties": { "expected_revision": { "type": "integer", "minimum": 0 }, "draft": { "type": "object", "description": "Working copy of a Skill: name, summary, categories and tags next to the definition fields on the same level (no nested definition object). Platform skills use instructions, capabilities, steps, inputs, outputs, scope, settings, integrations, emailAccess and adaptBeforeUse; agent skills use instructions and files. The draft replaces the whole working copy: send every field that should remain, starting from skills.get (the draft if present, else the active version's definition plus name, summary, categories and tags). Fields may be incomplete while editing; skills.save validates the complete definition.", "additionalProperties": false, "properties": { "name": { "type": "string", "maxLength": 200 }, "summary": { "type": "string", "maxLength": 1000 }, "categories": { "type": "array", "items": { "type": "string", "maxLength": 100 } }, "tags": { "type": "array", "items": { "type": "string", "maxLength": 100 } }, "instructions": { "title": "Instructions", "type": "string" }, "capabilities": { "items": { "maxLength": 80, "type": "string" }, "title": "Capabilities", "type": "array" }, "steps": { "items": { "additionalProperties": false, "properties": { "title": { "maxLength": 200, "title": "Title", "type": "string" }, "detail": { "title": "Detail", "type": "string" } }, "title": "SkillStep", "type": "object" }, "maxItems": 40, "title": "Steps", "type": "array" }, "inputs": { "description": "Input keys must be unique.", "items": { "additionalProperties": false, "properties": { "key": { "maxLength": 80, "title": "Key", "type": "string" }, "type": { "enum": [ "text", "document" ], "title": "Type", "type": "string" }, "label": { "maxLength": 120, "title": "Label", "type": "string" }, "description": { "default": "", "maxLength": 2000, "title": "Description", "type": "string" }, "required": { "default": false, "title": "Required", "type": "boolean" } }, "title": "SkillInput", "type": "object" }, "maxItems": 10, "title": "Inputs", "type": "array", "uniqueItems": true, "x-uniqueBy": "key" }, "outputs": { "description": "Output keys must be unique.", "items": { "additionalProperties": false, "properties": { "key": { "maxLength": 80, "title": "Key", "type": "string" }, "type": { "enum": [ "doc", "sheet", "page" ], "title": "Type", "type": "string" }, "nameTemplate": { "maxLength": 200, "title": "Nametemplate", "type": "string" }, "description": { "default": "", "maxLength": 2000, "title": "Description", "type": "string" }, "mode": { "enum": [ "new", "persistent" ], "title": "Mode", "type": "string" }, "folderId": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "title": "Folderid" }, "link": { "anyOf": [ { "additionalProperties": false, "properties": { "expiresInDays": { "anyOf": [ { "maximum": 365, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Expiresindays" }, "accessMode": { "default": "ANONYMOUS", "enum": [ "ANONYMOUS", "EMAIL", "EMAIL_VERIFIED" ], "title": "Accessmode", "type": "string" }, "submissionMode": { "default": "MULTIPLE", "enum": [ "NONE", "SINGLE", "MULTIPLE" ], "title": "Submissionmode", "type": "string" } }, "title": "SkillPageLink", "type": "object" }, { "type": "null" } ], "default": null } }, "title": "SkillOutput", "type": "object" }, "maxItems": 10, "title": "Outputs", "type": "array", "uniqueItems": true, "x-uniqueBy": "key" }, "scope": { "anyOf": [ { "additionalProperties": false, "properties": { "folderIds": { "items": { "format": "uuid", "type": "string" }, "maxItems": 100, "title": "Folderids", "type": "array" }, "documentIds": { "items": { "format": "uuid", "type": "string" }, "maxItems": 1000, "title": "Documentids", "type": "array" }, "recordTypeIds": { "items": { "format": "uuid", "type": "string" }, "maxItems": 100, "title": "Recordtypeids", "type": "array" } }, "title": "SkillScope", "type": "object" }, { "type": "null" } ], "default": null }, "settings": { "additionalProperties": false, "properties": { "reviewerEnabled": { "default": false, "title": "Reviewerenabled", "type": "boolean" }, "reviewMaxRounds": { "default": 1, "maximum": 3, "minimum": 1, "title": "Reviewmaxrounds", "type": "integer" }, "webSearchEnabled": { "default": false, "title": "Websearchenabled", "type": "boolean" }, "webSearchContextSize": { "default": "medium", "enum": [ "low", "medium", "high" ], "title": "Websearchcontextsize", "type": "string" }, "browserEnabled": { "default": false, "title": "Browserenabled", "type": "boolean" }, "defaultModel": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "default": null, "title": "Defaultmodel" }, "defaultEffort": { "default": "medium", "enum": [ "none", "low", "medium", "high", "xhigh", "max" ], "title": "Defaulteffort", "type": "string" }, "maxTurns": { "default": 60, "maximum": 120, "minimum": 1, "title": "Maxturns", "type": "integer" } }, "title": "SkillSettings", "type": "object" }, "integrations": { "items": { "additionalProperties": false, "description": "A logical provider requirement; personal identifiers are never stored here.", "properties": { "key": { "maxLength": 80, "title": "Key", "type": "string" }, "providerKey": { "maxLength": 80, "title": "Providerkey", "type": "string" }, "operations": { "items": { "additionalProperties": false, "properties": { "resource": { "maxLength": 80, "title": "Resource", "type": "string" }, "operation": { "maxLength": 80, "title": "Operation", "type": "string" } }, "title": "SkillIntegrationOperation", "type": "object" }, "maxItems": 50, "title": "Operations", "type": "array" } }, "title": "SkillIntegrationAccess", "type": "object" }, "maxItems": 20, "title": "Integrations", "type": "array", "uniqueItems": true, "x-uniqueBy": "key" }, "emailAccess": { "anyOf": [ { "additionalProperties": false, "description": "A logical mailbox policy resolved to the running user's own connection.", "properties": { "key": { "const": "email", "default": "email", "title": "Key", "type": "string" }, "read": { "default": true, "title": "Read", "type": "boolean" }, "readAttachments": { "default": false, "title": "Readattachments", "type": "boolean" }, "lookbackDays": { "default": 7, "maximum": 90, "minimum": 1, "title": "Lookbackdays", "type": "integer" }, "send": { "default": false, "title": "Send", "type": "boolean" }, "maxSendPerRun": { "default": 1, "maximum": 50, "minimum": 1, "title": "Maxsendperrun", "type": "integer" }, "sendAttachments": { "default": false, "title": "Sendattachments", "type": "boolean" }, "allowedRecipients": { "items": { "type": "string" }, "maxItems": 50, "title": "Allowedrecipients", "type": "array" } }, "title": "SkillEmailAccess", "type": "object" }, { "type": "null" } ], "default": null }, "adaptBeforeUse": { "items": { "type": "string" }, "maxItems": 5, "title": "Adaptbeforeuse", "type": "array" }, "files": { "items": { "additionalProperties": false, "properties": { "path": { "maxLength": 200, "title": "Path", "type": "string" }, "content": { "maxLength": 100000, "title": "Content", "type": "string" } }, "title": "AgentSkillFile", "type": "object" }, "maxItems": 50, "title": "Files", "type": "array", "uniqueItems": true, "x-uniqueBy": "path" } } } }, "title": "SkillsDraftSaveRequest" }, "SkillsDraftSaveResponse": { "type": "object", "properties": { "skill_id": { "type": "string", "format": "uuid" }, "draft_revision": { "type": "integer" }, "draft_updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "skill_id", "draft_revision", "draft_updated_at" ], "additionalProperties": false, "title": "SkillsDraftSaveResponse" }, "SkillsDraftDiscardRequest": { "type": "object", "required": [ "expected_revision" ], "properties": { "expected_revision": { "type": "integer", "minimum": 0 } }, "title": "SkillsDraftDiscardRequest" }, "SkillsDraftDiscardResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "slug": { "type": "string" }, "kind": { "type": "string", "enum": [ "PLATFORM", "AGENT" ] }, "name": { "type": "string" }, "summary": { "type": "string" }, "status": { "type": "string" }, "visibility": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } }, "is_template": { "type": "boolean" }, "current_version": { "type": [ "integer", "null" ] }, "has_draft": { "type": "boolean" }, "draft_revision": { "type": "integer" }, "draft_updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_by_id": { "type": [ "string", "null" ], "format": "uuid" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "access_mode": { "type": "string" }, "share_count": { "type": "integer" }, "access": { "type": [ "object", "null" ], "properties": { "share_role": { "type": [ "string", "null" ] }, "is_creator": { "type": "boolean" }, "access_mode": { "type": "string" }, "can_view": { "type": "boolean" }, "can_run": { "type": "boolean" }, "can_edit": { "type": "boolean" }, "can_share": { "type": "boolean" }, "can_archive": { "type": "boolean" } }, "required": [ "share_role", "is_creator", "access_mode", "can_view", "can_run", "can_edit", "can_share", "can_archive" ], "additionalProperties": false }, "updated_at": { "type": "string", "format": "date-time" }, "version": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" }, "definition": { "type": "object", "additionalProperties": true }, "content_hash": { "type": "string" }, "change_note": { "type": [ "string", "null" ] }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "version", "definition", "content_hash", "change_note", "created_at" ], "additionalProperties": false }, "draft": { "type": [ "object", "null" ], "additionalProperties": true }, "stubs": { "type": "object", "properties": { "skill": { "type": "string" }, "project": { "type": "string" } }, "required": [ "skill", "project" ], "additionalProperties": false } }, "required": [ "id", "slug", "kind", "name", "summary", "status", "visibility", "categories", "tags", "is_template", "current_version", "has_draft", "draft_revision", "draft_updated_at", "created_by_id", "created_by", "access_mode", "share_count", "access", "updated_at", "version", "draft" ], "additionalProperties": false, "title": "SkillsDraftDiscardResponse" }, "SkillsVersionsRequest": { "type": "object", "properties": { "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, "title": "SkillsVersionsRequest" }, "SkillsVersionsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" }, "definition": { "type": "object", "additionalProperties": true }, "content_hash": { "type": "string" }, "change_note": { "type": [ "string", "null" ] }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "version", "definition", "content_hash", "change_note", "created_at" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "additionalProperties": false, "title": "SkillsVersionsResponse" }, "SkillsSaveRequest": { "type": "object", "required": [ "expected_revision", "name", "summary", "definition" ], "properties": { "expected_revision": { "type": "integer", "minimum": 0 }, "name": { "type": "string", "maxLength": 200 }, "summary": { "type": "string", "maxLength": 1000 }, "categories": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } }, "definition": { "oneOf": [ { "additionalProperties": false, "properties": { "instructions": { "minLength": 1, "pattern": "\\S", "title": "Instructions", "type": "string" }, "capabilities": { "items": { "maxLength": 80, "minLength": 1, "pattern": "^[a-z][a-z0-9_-]*$", "type": "string" }, "title": "Capabilities", "type": "array" }, "steps": { "items": { "additionalProperties": false, "properties": { "title": { "maxLength": 200, "minLength": 1, "pattern": "\\S", "title": "Title", "type": "string" }, "detail": { "minLength": 1, "pattern": "\\S", "title": "Detail", "type": "string" } }, "required": [ "title", "detail" ], "title": "SkillStep", "type": "object" }, "maxItems": 40, "title": "Steps", "type": "array" }, "inputs": { "description": "Input keys must be unique.", "items": { "additionalProperties": false, "properties": { "key": { "maxLength": 80, "minLength": 1, "pattern": "^[a-z0-9_]+$", "title": "Key", "type": "string" }, "type": { "enum": [ "text", "document" ], "title": "Type", "type": "string" }, "label": { "maxLength": 120, "minLength": 1, "pattern": "\\S", "title": "Label", "type": "string" }, "description": { "default": "", "maxLength": 2000, "title": "Description", "type": "string" }, "required": { "default": false, "title": "Required", "type": "boolean" } }, "required": [ "key", "type", "label" ], "title": "SkillInput", "type": "object" }, "maxItems": 10, "title": "Inputs", "type": "array", "uniqueItems": true, "x-uniqueBy": "key" }, "outputs": { "description": "Output keys must be unique.", "items": { "additionalProperties": false, "properties": { "key": { "maxLength": 80, "minLength": 1, "pattern": "^[a-z0-9_]+$", "title": "Key", "type": "string" }, "type": { "enum": [ "doc", "sheet", "page" ], "title": "Type", "type": "string" }, "nameTemplate": { "maxLength": 200, "minLength": 1, "pattern": "\\S", "title": "Nametemplate", "type": "string" }, "description": { "default": "", "maxLength": 2000, "title": "Description", "type": "string" }, "mode": { "enum": [ "new", "persistent" ], "title": "Mode", "type": "string" }, "folderId": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "title": "Folderid" }, "link": { "anyOf": [ { "additionalProperties": false, "properties": { "expiresInDays": { "anyOf": [ { "maximum": 365, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Expiresindays" }, "accessMode": { "default": "ANONYMOUS", "enum": [ "ANONYMOUS", "EMAIL", "EMAIL_VERIFIED" ], "title": "Accessmode", "type": "string" }, "submissionMode": { "default": "MULTIPLE", "enum": [ "NONE", "SINGLE", "MULTIPLE" ], "title": "Submissionmode", "type": "string" } }, "title": "SkillPageLink", "type": "object" }, { "type": "null" } ], "default": null } }, "required": [ "key", "type", "nameTemplate", "mode" ], "title": "SkillOutput", "type": "object" }, "maxItems": 10, "minItems": 1, "title": "Outputs", "type": "array", "uniqueItems": true, "x-uniqueBy": "key" }, "scope": { "anyOf": [ { "additionalProperties": false, "properties": { "folderIds": { "items": { "format": "uuid", "type": "string" }, "maxItems": 100, "title": "Folderids", "type": "array" }, "documentIds": { "items": { "format": "uuid", "type": "string" }, "maxItems": 1000, "title": "Documentids", "type": "array" }, "recordTypeIds": { "items": { "format": "uuid", "type": "string" }, "maxItems": 100, "title": "Recordtypeids", "type": "array" } }, "title": "SkillScope", "type": "object" }, { "type": "null" } ], "default": null }, "settings": { "additionalProperties": false, "properties": { "reviewerEnabled": { "default": false, "title": "Reviewerenabled", "type": "boolean" }, "reviewMaxRounds": { "default": 1, "maximum": 3, "minimum": 1, "title": "Reviewmaxrounds", "type": "integer" }, "webSearchEnabled": { "default": false, "title": "Websearchenabled", "type": "boolean" }, "webSearchContextSize": { "default": "medium", "enum": [ "low", "medium", "high" ], "title": "Websearchcontextsize", "type": "string" }, "browserEnabled": { "default": false, "title": "Browserenabled", "type": "boolean" }, "defaultModel": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "default": null, "title": "Defaultmodel" }, "defaultEffort": { "default": "medium", "enum": [ "none", "low", "medium", "high", "xhigh", "max" ], "title": "Defaulteffort", "type": "string" }, "maxTurns": { "default": 60, "maximum": 120, "minimum": 1, "title": "Maxturns", "type": "integer" } }, "title": "SkillSettings", "type": "object" }, "integrations": { "items": { "additionalProperties": false, "description": "A logical provider requirement; personal identifiers are never stored here.", "properties": { "key": { "maxLength": 80, "minLength": 1, "pattern": "^[a-z0-9_]+$", "title": "Key", "type": "string" }, "providerKey": { "maxLength": 80, "minLength": 1, "pattern": "^[a-z][a-z0-9_-]*$", "title": "Providerkey", "type": "string" }, "operations": { "items": { "additionalProperties": false, "properties": { "resource": { "maxLength": 80, "minLength": 1, "pattern": "^[a-z][a-z0-9_-]*$", "title": "Resource", "type": "string" }, "operation": { "maxLength": 80, "minLength": 1, "pattern": "^[a-z][a-z0-9_-]*$", "title": "Operation", "type": "string" } }, "required": [ "resource", "operation" ], "title": "SkillIntegrationOperation", "type": "object" }, "maxItems": 50, "minItems": 1, "title": "Operations", "type": "array" } }, "required": [ "key", "providerKey", "operations" ], "title": "SkillIntegrationAccess", "type": "object" }, "maxItems": 20, "title": "Integrations", "type": "array", "uniqueItems": true, "x-uniqueBy": "key" }, "emailAccess": { "anyOf": [ { "additionalProperties": false, "description": "A logical mailbox policy resolved to the running user's own connection.", "properties": { "key": { "const": "email", "default": "email", "title": "Key", "type": "string" }, "read": { "default": true, "title": "Read", "type": "boolean" }, "readAttachments": { "default": false, "title": "Readattachments", "type": "boolean" }, "lookbackDays": { "default": 7, "maximum": 90, "minimum": 1, "title": "Lookbackdays", "type": "integer" }, "send": { "default": false, "title": "Send", "type": "boolean" }, "maxSendPerRun": { "default": 1, "maximum": 50, "minimum": 1, "title": "Maxsendperrun", "type": "integer" }, "sendAttachments": { "default": false, "title": "Sendattachments", "type": "boolean" }, "allowedRecipients": { "items": { "minLength": 1, "pattern": "\\S", "type": "string" }, "maxItems": 50, "title": "Allowedrecipients", "type": "array" } }, "title": "SkillEmailAccess", "type": "object" }, { "type": "null" } ], "default": null }, "adaptBeforeUse": { "items": { "minLength": 1, "pattern": "\\S", "type": "string" }, "maxItems": 5, "title": "Adaptbeforeuse", "type": "array" } }, "required": [ "capabilities", "instructions", "outputs" ], "title": "SkillDefinition", "type": "object" }, { "additionalProperties": false, "properties": { "instructions": { "maxLength": 100000, "minLength": 1, "pattern": "\\S", "title": "Instructions", "type": "string" }, "files": { "items": { "additionalProperties": false, "properties": { "path": { "maxLength": 200, "minLength": 1, "pattern": "^[A-Za-z0-9_][A-Za-z0-9._-]*(/[A-Za-z0-9_][A-Za-z0-9._-]*)*$", "title": "Path", "type": "string" }, "content": { "maxLength": 100000, "title": "Content", "type": "string" } }, "required": [ "path", "content" ], "title": "AgentSkillFile", "type": "object" }, "maxItems": 50, "title": "Files", "type": "array", "uniqueItems": true, "x-uniqueBy": "path" } }, "required": [ "instructions" ], "title": "AgentSkillDefinition", "type": "object" } ] }, "change_note": { "type": [ "string", "null" ], "maxLength": 500 } }, "title": "SkillsSaveRequest" }, "SkillsSaveResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "slug": { "type": "string" }, "kind": { "type": "string", "enum": [ "PLATFORM", "AGENT" ] }, "name": { "type": "string" }, "summary": { "type": "string" }, "status": { "type": "string" }, "visibility": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } }, "is_template": { "type": "boolean" }, "current_version": { "type": [ "integer", "null" ] }, "has_draft": { "type": "boolean" }, "draft_revision": { "type": "integer" }, "draft_updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_by_id": { "type": [ "string", "null" ], "format": "uuid" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "access_mode": { "type": "string" }, "share_count": { "type": "integer" }, "access": { "type": [ "object", "null" ], "properties": { "share_role": { "type": [ "string", "null" ] }, "is_creator": { "type": "boolean" }, "access_mode": { "type": "string" }, "can_view": { "type": "boolean" }, "can_run": { "type": "boolean" }, "can_edit": { "type": "boolean" }, "can_share": { "type": "boolean" }, "can_archive": { "type": "boolean" } }, "required": [ "share_role", "is_creator", "access_mode", "can_view", "can_run", "can_edit", "can_share", "can_archive" ], "additionalProperties": false }, "updated_at": { "type": "string", "format": "date-time" }, "version": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" }, "definition": { "type": "object", "additionalProperties": true }, "content_hash": { "type": "string" }, "change_note": { "type": [ "string", "null" ] }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "version", "definition", "content_hash", "change_note", "created_at" ], "additionalProperties": false }, "draft": { "type": [ "object", "null" ], "additionalProperties": true }, "stubs": { "type": "object", "properties": { "skill": { "type": "string" }, "project": { "type": "string" } }, "required": [ "skill", "project" ], "additionalProperties": false } }, "required": [ "id", "slug", "kind", "name", "summary", "status", "visibility", "categories", "tags", "is_template", "current_version", "has_draft", "draft_revision", "draft_updated_at", "created_by_id", "created_by", "access_mode", "share_count", "access", "updated_at", "version", "draft" ], "additionalProperties": false, "title": "SkillsSaveResponse" }, "SkillsRestoreRequest": { "type": "object", "properties": {}, "title": "SkillsRestoreRequest" }, "SkillsRestoreResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "slug": { "type": "string" }, "kind": { "type": "string", "enum": [ "PLATFORM", "AGENT" ] }, "name": { "type": "string" }, "summary": { "type": "string" }, "status": { "type": "string" }, "visibility": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } }, "is_template": { "type": "boolean" }, "current_version": { "type": [ "integer", "null" ] }, "has_draft": { "type": "boolean" }, "draft_revision": { "type": "integer" }, "draft_updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_by_id": { "type": [ "string", "null" ], "format": "uuid" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "access_mode": { "type": "string" }, "share_count": { "type": "integer" }, "access": { "type": [ "object", "null" ], "properties": { "share_role": { "type": [ "string", "null" ] }, "is_creator": { "type": "boolean" }, "access_mode": { "type": "string" }, "can_view": { "type": "boolean" }, "can_run": { "type": "boolean" }, "can_edit": { "type": "boolean" }, "can_share": { "type": "boolean" }, "can_archive": { "type": "boolean" } }, "required": [ "share_role", "is_creator", "access_mode", "can_view", "can_run", "can_edit", "can_share", "can_archive" ], "additionalProperties": false }, "updated_at": { "type": "string", "format": "date-time" }, "version": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" }, "definition": { "type": "object", "additionalProperties": true }, "content_hash": { "type": "string" }, "change_note": { "type": [ "string", "null" ] }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "version", "definition", "content_hash", "change_note", "created_at" ], "additionalProperties": false }, "draft": { "type": [ "object", "null" ], "additionalProperties": true }, "stubs": { "type": "object", "properties": { "skill": { "type": "string" }, "project": { "type": "string" } }, "required": [ "skill", "project" ], "additionalProperties": false } }, "required": [ "id", "slug", "kind", "name", "summary", "status", "visibility", "categories", "tags", "is_template", "current_version", "has_draft", "draft_revision", "draft_updated_at", "created_by_id", "created_by", "access_mode", "share_count", "access", "updated_at", "version", "draft" ], "additionalProperties": false, "title": "SkillsRestoreResponse" }, "SkillsAutomationGetRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "SkillsAutomationGetRequest" }, "SkillsAutomationGetResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "title": "SkillsAutomationGetResponse" }, "SkillsAutomationSetRequest": { "type": "object", "required": [ "schedule", "event", "run" ], "properties": { "schedule": { "type": [ "object", "null" ], "required": [ "kind", "timezone", "active" ], "properties": { "kind": { "type": "string", "enum": [ "cron", "once" ] }, "cron": { "type": "string", "description": "Five-field cron expression (kind=cron)" }, "run_at": { "type": "string", "format": "date-time", "description": "Single point in time (kind=once)" }, "timezone": { "type": "string", "description": "IANA timezone name" }, "active": { "type": "boolean" } }, "additionalProperties": false }, "event": { "type": [ "object", "null" ], "required": [ "event_type", "entity_id", "severity", "filters", "active" ], "properties": { "event_type": { "type": "string", "description": "A registered platform event type such as document.processed" }, "entity_id": { "type": [ "string", "null" ] }, "severity": { "type": [ "string", "null" ], "enum": [ "info", "warning", "critical", null ] }, "filters": { "type": "array", "maxItems": 20, "items": { "type": "object", "required": [ "field", "operator", "value" ], "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "eq", "neq", "contains", "exists" ] }, "value": { "type": "string" } }, "additionalProperties": false } }, "active": { "type": "boolean" } }, "additionalProperties": false }, "run": { "type": "object", "required": [ "inputs", "scope" ], "properties": { "inputs": { "type": "object" }, "scope": { "type": "object", "properties": { "document_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "folder_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "include_all_processed_documents": { "type": "boolean" } }, "additionalProperties": false }, "instruction": { "type": [ "string", "null" ], "maxLength": 4000 } }, "additionalProperties": false } }, "additionalProperties": false, "title": "SkillsAutomationSetRequest" }, "SkillsAutomationSetResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "title": "SkillsAutomationSetResponse" }, "SkillsIntegrationBindingsListRequest": { "type": "object", "properties": { "skill_id": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "title": "SkillsIntegrationBindingsListRequest" }, "SkillsIntegrationBindingsListResponse": { "type": "object", "required": [ "items", "requirements" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "skill_id", "space_id", "requirement_key", "provider_key", "grant_id", "connection_id", "connection_label", "allowed_operations", "active" ], "properties": { "id": { "type": "string", "format": "uuid" }, "skill_id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "requirement_key": { "type": "string" }, "provider_key": { "type": "string" }, "grant_id": { "type": "string", "format": "uuid" }, "connection_id": { "type": "string", "format": "uuid" }, "connection_label": { "type": "string" }, "allowed_operations": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" }, "revoked_at": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } } }, "requirements": { "type": "array", "items": { "type": "object", "required": [ "key", "provider_key", "operations", "binding" ], "properties": { "key": { "type": "string" }, "provider_key": { "type": "string" }, "operations": { "type": "array", "items": { "type": "string" } }, "binding": { "type": [ "object", "null" ] } } } } }, "title": "SkillsIntegrationBindingsListResponse" }, "SkillsIntegrationBindingsSetRequest": { "type": "object", "required": [ "grant_id" ], "properties": { "grant_id": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "title": "SkillsIntegrationBindingsSetRequest" }, "SkillsIntegrationBindingsSetResponse": { "type": "object", "required": [ "id", "skill_id", "space_id", "requirement_key", "provider_key", "grant_id", "connection_id", "connection_label", "allowed_operations", "active" ], "properties": { "id": { "type": "string", "format": "uuid" }, "skill_id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "requirement_key": { "type": "string" }, "provider_key": { "type": "string" }, "grant_id": { "type": "string", "format": "uuid" }, "connection_id": { "type": "string", "format": "uuid" }, "connection_label": { "type": "string" }, "allowed_operations": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" }, "revoked_at": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "title": "SkillsIntegrationBindingsSetResponse" }, "SkillsIntegrationBindingsRevokeRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "SkillsIntegrationBindingsRevokeRequest" }, "SkillsIntegrationBindingsRevokeResponse": { "type": "object", "required": [ "id", "skill_id", "space_id", "requirement_key", "provider_key", "grant_id", "connection_id", "connection_label", "allowed_operations", "active" ], "properties": { "id": { "type": "string", "format": "uuid" }, "skill_id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "requirement_key": { "type": "string" }, "provider_key": { "type": "string" }, "grant_id": { "type": "string", "format": "uuid" }, "connection_id": { "type": "string", "format": "uuid" }, "connection_label": { "type": "string" }, "allowed_operations": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" }, "revoked_at": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "title": "SkillsIntegrationBindingsRevokeResponse" }, "SkillsModelsRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "SkillsModelsRequest" }, "SkillsModelsResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "title": "SkillsModelsResponse" }, "RecordsTypesRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "RecordsTypesRequest" }, "RecordsTypesResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "title": "RecordsTypesResponse" }, "MailboxConnectionsRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "MailboxConnectionsRequest" }, "MailboxConnectionsResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "title": "MailboxConnectionsResponse" }, "IntegrationsCredentialsRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "IntegrationsCredentialsRequest" }, "IntegrationsCredentialsResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "title": "IntegrationsCredentialsResponse" }, "SkillsRunsStartRequest": { "type": "object", "required": [ "skill_id", "space_id", "inputs", "scope" ], "properties": { "skill_id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "inputs": { "type": "object" }, "scope": { "type": "object", "properties": { "document_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "folder_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "include_all_processed_documents": { "type": "boolean" } }, "additionalProperties": false }, "model": { "type": "string", "description": "A model id from skills.models; defaults to the Skill setting or the runtime default." }, "reasoning_effort": { "type": "string", "enum": [ "none", "low", "medium", "high", "xhigh", "max" ], "description": "Must be one of the efforts listed for the model in skills.models." }, "review_max_rounds": { "type": "integer", "minimum": 1, "maximum": 3 }, "instruction": { "type": "string", "maxLength": 4000, "description": "Additional instruction for this run only." } }, "additionalProperties": false, "title": "SkillsRunsStartRequest" }, "SkillsRunsStartResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "installation_id": { "type": "string", "format": "uuid" }, "skill_id": { "type": "string", "format": "uuid" }, "skill_name": { "type": "string" }, "version_id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" }, "requested_by_id": { "type": "string", "format": "uuid" }, "requested_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "actor_type": { "type": "string" }, "origin": { "type": "string" }, "trigger": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "type": "string" } }, "required": [ "id", "kind" ], "additionalProperties": false }, "status": { "type": "string" }, "model": { "type": [ "string", "null" ] }, "reasoning_effort": { "type": [ "string", "null" ] }, "effective_max_turns": { "type": [ "integer", "null" ] }, "review_max_rounds": { "type": [ "integer", "null" ] }, "instruction": { "type": [ "string", "null" ] }, "cost_micro_usd": { "type": "integer" }, "micro_credits": { "type": "integer" }, "turns_used": { "type": "integer" }, "step_progress": { "type": "object", "properties": { "done": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "done", "total" ], "additionalProperties": false }, "pages": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "page_id": { "type": "string", "format": "uuid" }, "url": { "type": [ "string", "null" ] } }, "required": [ "key", "name", "page_id", "url" ], "additionalProperties": false } }, "error_code": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "started_at": { "type": [ "string", "null" ], "format": "date-time" }, "completed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "reversal": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "requested_by_id": { "type": "string", "format": "uuid" }, "skip_conflicts": { "type": "boolean" }, "summary": { "type": "object", "additionalProperties": true }, "error_code": { "type": [ "string", "null" ] }, "created_at": { "type": "string", "format": "date-time" }, "started_at": { "type": [ "string", "null" ], "format": "date-time" }, "completed_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "status", "requested_by_id", "skip_conflicts", "summary", "error_code", "created_at", "started_at", "completed_at" ], "additionalProperties": false }, "undo": { "type": "object", "properties": { "available": { "type": "boolean" }, "blocked_reason": { "type": [ "string", "null" ] } }, "required": [ "available", "blocked_reason" ], "additionalProperties": false } }, "required": [ "id", "space_id", "installation_id", "skill_id", "skill_name", "version_id", "version", "requested_by_id", "requested_by", "actor_type", "origin", "trigger", "status", "model", "reasoning_effort", "effective_max_turns", "review_max_rounds", "instruction", "cost_micro_usd", "micro_credits", "turns_used", "step_progress", "pages", "error_code", "error_message", "started_at", "completed_at", "created_at", "reversal", "undo" ], "additionalProperties": false, "title": "SkillsRunsStartResponse" }, "SkillsRunsListRequest": { "type": "object", "required": [ "space_id" ], "properties": { "space_id": { "type": "string", "format": "uuid" }, "skill_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }, "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, "additionalProperties": false, "title": "SkillsRunsListRequest" }, "SkillsRunsListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "installation_id": { "type": "string", "format": "uuid" }, "skill_id": { "type": "string", "format": "uuid" }, "skill_name": { "type": "string" }, "version_id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" }, "requested_by_id": { "type": "string", "format": "uuid" }, "requested_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "actor_type": { "type": "string" }, "origin": { "type": "string" }, "trigger": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "type": "string" } }, "required": [ "id", "kind" ], "additionalProperties": false }, "status": { "type": "string" }, "model": { "type": [ "string", "null" ] }, "reasoning_effort": { "type": [ "string", "null" ] }, "effective_max_turns": { "type": [ "integer", "null" ] }, "review_max_rounds": { "type": [ "integer", "null" ] }, "instruction": { "type": [ "string", "null" ] }, "cost_micro_usd": { "type": "integer" }, "micro_credits": { "type": "integer" }, "turns_used": { "type": "integer" }, "step_progress": { "type": "object", "properties": { "done": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "done", "total" ], "additionalProperties": false }, "pages": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "page_id": { "type": "string", "format": "uuid" }, "url": { "type": [ "string", "null" ] } }, "required": [ "key", "name", "page_id", "url" ], "additionalProperties": false } }, "error_code": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "started_at": { "type": [ "string", "null" ], "format": "date-time" }, "completed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "reversal": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "requested_by_id": { "type": "string", "format": "uuid" }, "skip_conflicts": { "type": "boolean" }, "summary": { "type": "object", "additionalProperties": true }, "error_code": { "type": [ "string", "null" ] }, "created_at": { "type": "string", "format": "date-time" }, "started_at": { "type": [ "string", "null" ], "format": "date-time" }, "completed_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "status", "requested_by_id", "skip_conflicts", "summary", "error_code", "created_at", "started_at", "completed_at" ], "additionalProperties": false }, "undo": { "type": "object", "properties": { "available": { "type": "boolean" }, "blocked_reason": { "type": [ "string", "null" ] } }, "required": [ "available", "blocked_reason" ], "additionalProperties": false } }, "required": [ "id", "space_id", "installation_id", "skill_id", "skill_name", "version_id", "version", "requested_by_id", "requested_by", "actor_type", "origin", "trigger", "status", "model", "reasoning_effort", "effective_max_turns", "review_max_rounds", "instruction", "cost_micro_usd", "micro_credits", "turns_used", "step_progress", "pages", "error_code", "error_message", "started_at", "completed_at", "created_at", "reversal", "undo" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "additionalProperties": false, "title": "SkillsRunsListResponse" }, "SkillsRunsGetRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "SkillsRunsGetRequest" }, "SkillsRunsGetResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "installation_id": { "type": "string", "format": "uuid" }, "skill_id": { "type": "string", "format": "uuid" }, "skill_name": { "type": "string" }, "version_id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" }, "requested_by_id": { "type": "string", "format": "uuid" }, "requested_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "actor_type": { "type": "string" }, "origin": { "type": "string" }, "trigger": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "type": "string" } }, "required": [ "id", "kind" ], "additionalProperties": false }, "status": { "type": "string" }, "model": { "type": [ "string", "null" ] }, "reasoning_effort": { "type": [ "string", "null" ] }, "effective_max_turns": { "type": [ "integer", "null" ] }, "review_max_rounds": { "type": [ "integer", "null" ] }, "instruction": { "type": [ "string", "null" ] }, "cost_micro_usd": { "type": "integer" }, "micro_credits": { "type": "integer" }, "turns_used": { "type": "integer" }, "step_progress": { "type": "object", "properties": { "done": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "done", "total" ], "additionalProperties": false }, "pages": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "page_id": { "type": "string", "format": "uuid" }, "url": { "type": [ "string", "null" ] } }, "required": [ "key", "name", "page_id", "url" ], "additionalProperties": false } }, "error_code": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "started_at": { "type": [ "string", "null" ], "format": "date-time" }, "completed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "reversal": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "requested_by_id": { "type": "string", "format": "uuid" }, "skip_conflicts": { "type": "boolean" }, "summary": { "type": "object", "additionalProperties": true }, "error_code": { "type": [ "string", "null" ] }, "created_at": { "type": "string", "format": "date-time" }, "started_at": { "type": [ "string", "null" ], "format": "date-time" }, "completed_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "status", "requested_by_id", "skip_conflicts", "summary", "error_code", "created_at", "started_at", "completed_at" ], "additionalProperties": false }, "undo": { "type": "object", "properties": { "available": { "type": "boolean" }, "blocked_reason": { "type": [ "string", "null" ] } }, "required": [ "available", "blocked_reason" ], "additionalProperties": false }, "parent_workflow_run": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "workflow_id": { "type": "string", "format": "uuid" }, "workflow_name": { "type": "string" } }, "required": [ "id", "workflow_id", "workflow_name" ], "additionalProperties": false }, "execution": { "type": [ "object", "null" ], "properties": { "attempt": { "type": "integer" }, "status": { "type": "string" }, "last_activity_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "attempt", "status", "last_activity_at" ], "additionalProperties": false }, "definition": { "type": "object", "additionalProperties": true }, "inputs": { "type": "object", "additionalProperties": true }, "scope": { "type": "object", "additionalProperties": true }, "usage": { "type": "object", "additionalProperties": true }, "open_points": { "type": "array", "items": {} }, "review": { "type": [ "object", "null" ], "additionalProperties": true }, "result_summary": { "type": [ "string", "null" ] }, "ai_calls": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "purpose": { "type": "string" }, "model": { "type": "string" }, "input_tokens": { "type": "integer" }, "cached_tokens": { "type": "integer" }, "output_tokens": { "type": "integer" }, "reasoning_tokens": { "type": "integer" }, "cost_micro_usd": { "type": "integer" }, "latency_ms": { "type": "integer" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "purpose", "model", "input_tokens", "cached_tokens", "output_tokens", "reasoning_tokens", "cost_micro_usd", "latency_ms", "created_at" ], "additionalProperties": false } }, "steps": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer" }, "title": { "type": "string" }, "status": { "type": "string" }, "summary": { "type": [ "string", "null" ] }, "evidence": { "type": "array", "items": {} }, "completed_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "index", "title", "status", "summary", "evidence", "completed_at" ], "additionalProperties": false } }, "outputs": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" }, "revision": { "type": "integer" }, "content": {}, "content_hash": { "type": "string" }, "byte_size": { "type": "integer" }, "page_id": { "type": [ "string", "null" ], "format": "uuid" }, "url": { "type": [ "string", "null" ] } }, "required": [ "key", "type", "name", "revision", "content", "content_hash", "byte_size", "page_id", "url" ], "additionalProperties": false } } }, "required": [ "id", "space_id", "installation_id", "skill_id", "skill_name", "version_id", "version", "requested_by_id", "requested_by", "actor_type", "origin", "trigger", "status", "model", "reasoning_effort", "effective_max_turns", "review_max_rounds", "instruction", "cost_micro_usd", "micro_credits", "turns_used", "step_progress", "pages", "error_code", "error_message", "started_at", "completed_at", "created_at", "reversal", "undo", "parent_workflow_run", "execution", "definition", "inputs", "scope", "usage", "open_points", "review", "result_summary", "ai_calls", "steps", "outputs" ], "additionalProperties": false, "title": "SkillsRunsGetResponse" }, "SkillsRunsEventsRequest": { "type": "object", "properties": { "after_event_id": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "title": "SkillsRunsEventsRequest" }, "SkillsRunsEventsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string" }, "payload": { "type": "object", "additionalProperties": true }, "actor": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "type", "payload", "actor", "created_at" ], "additionalProperties": false } }, "cursor": { "type": "integer" } }, "required": [ "items", "cursor" ], "additionalProperties": false, "title": "SkillsRunsEventsResponse" }, "SkillsRunsCancelRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "SkillsRunsCancelRequest" }, "SkillsRunsCancelResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "installation_id": { "type": "string", "format": "uuid" }, "skill_id": { "type": "string", "format": "uuid" }, "skill_name": { "type": "string" }, "version_id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" }, "requested_by_id": { "type": "string", "format": "uuid" }, "requested_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "actor_type": { "type": "string" }, "origin": { "type": "string" }, "trigger": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "type": "string" } }, "required": [ "id", "kind" ], "additionalProperties": false }, "status": { "type": "string" }, "model": { "type": [ "string", "null" ] }, "reasoning_effort": { "type": [ "string", "null" ] }, "effective_max_turns": { "type": [ "integer", "null" ] }, "review_max_rounds": { "type": [ "integer", "null" ] }, "instruction": { "type": [ "string", "null" ] }, "cost_micro_usd": { "type": "integer" }, "micro_credits": { "type": "integer" }, "turns_used": { "type": "integer" }, "step_progress": { "type": "object", "properties": { "done": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "done", "total" ], "additionalProperties": false }, "pages": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "page_id": { "type": "string", "format": "uuid" }, "url": { "type": [ "string", "null" ] } }, "required": [ "key", "name", "page_id", "url" ], "additionalProperties": false } }, "error_code": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "started_at": { "type": [ "string", "null" ], "format": "date-time" }, "completed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "reversal": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "requested_by_id": { "type": "string", "format": "uuid" }, "skip_conflicts": { "type": "boolean" }, "summary": { "type": "object", "additionalProperties": true }, "error_code": { "type": [ "string", "null" ] }, "created_at": { "type": "string", "format": "date-time" }, "started_at": { "type": [ "string", "null" ], "format": "date-time" }, "completed_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "status", "requested_by_id", "skip_conflicts", "summary", "error_code", "created_at", "started_at", "completed_at" ], "additionalProperties": false }, "undo": { "type": "object", "properties": { "available": { "type": "boolean" }, "blocked_reason": { "type": [ "string", "null" ] } }, "required": [ "available", "blocked_reason" ], "additionalProperties": false } }, "required": [ "id", "space_id", "installation_id", "skill_id", "skill_name", "version_id", "version", "requested_by_id", "requested_by", "actor_type", "origin", "trigger", "status", "model", "reasoning_effort", "effective_max_turns", "review_max_rounds", "instruction", "cost_micro_usd", "micro_credits", "turns_used", "step_progress", "pages", "error_code", "error_message", "started_at", "completed_at", "created_at", "reversal", "undo" ], "additionalProperties": false, "title": "SkillsRunsCancelResponse" }, "SkillsRunsRevertPreviewRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "SkillsRunsRevertPreviewRequest" }, "SkillsRunsRevertPreviewResponse": { "type": "object", "properties": { "units": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "target_kind": { "type": "string" }, "target_id": { "type": "string" }, "label": { "type": "string" }, "reversibility": { "type": "string" }, "outcome": { "type": "string" }, "reason": { "type": [ "string", "null" ] }, "warnings": { "type": "object", "additionalProperties": true }, "effects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "target_kind": { "type": "string" }, "target_id": { "type": "string" }, "label": { "type": "string" }, "action": { "type": "string" }, "reversibility": { "type": "string" }, "status": { "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "target_kind", "target_id", "label", "action", "reversibility", "status", "details", "created_at" ], "additionalProperties": false } } }, "required": [ "key", "target_kind", "target_id", "label", "reversibility", "outcome", "reason", "warnings", "effects" ], "additionalProperties": false } }, "counts": { "type": "object", "additionalProperties": { "type": "integer" } }, "warnings": { "type": "object", "properties": { "pending_invocations": { "type": "integer" } }, "required": [ "pending_invocations" ], "additionalProperties": false }, "undo": { "type": "object", "properties": { "available": { "type": "boolean" }, "blocked_reason": { "type": [ "string", "null" ] } }, "required": [ "available", "blocked_reason" ], "additionalProperties": false }, "reversal": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "requested_by_id": { "type": "string", "format": "uuid" }, "skip_conflicts": { "type": "boolean" }, "summary": { "type": "object", "additionalProperties": true }, "error_code": { "type": [ "string", "null" ] }, "created_at": { "type": "string", "format": "date-time" }, "started_at": { "type": [ "string", "null" ], "format": "date-time" }, "completed_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "status", "requested_by_id", "skip_conflicts", "summary", "error_code", "created_at", "started_at", "completed_at" ], "additionalProperties": false } }, "required": [ "units", "counts", "warnings", "undo", "reversal" ], "additionalProperties": false, "title": "SkillsRunsRevertPreviewResponse" }, "SkillsRunsRevertRequest": { "type": "object", "properties": { "skip_conflicts": { "type": "boolean" } }, "additionalProperties": false, "title": "SkillsRunsRevertRequest" }, "SkillsRunsRevertResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "requested_by_id": { "type": "string", "format": "uuid" }, "skip_conflicts": { "type": "boolean" }, "summary": { "type": "object", "additionalProperties": true }, "error_code": { "type": [ "string", "null" ] }, "created_at": { "type": "string", "format": "date-time" }, "started_at": { "type": [ "string", "null" ], "format": "date-time" }, "completed_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "status", "requested_by_id", "skip_conflicts", "summary", "error_code", "created_at", "started_at", "completed_at" ], "additionalProperties": false, "title": "SkillsRunsRevertResponse" }, "WorkflowsListRequest": { "type": "object", "required": [ "space_id" ], "properties": { "space_id": { "type": "string", "format": "uuid" }, "q": { "type": "string", "maxLength": 200, "description": "Name or summary text" }, "status": { "type": "string", "enum": [ "DRAFT", "ACTIVE", "ARCHIVED" ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }, "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, "additionalProperties": false, "title": "WorkflowsListRequest" }, "WorkflowsListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "summary": { "type": "string" }, "status": { "type": "string" }, "enabled": { "type": "boolean" }, "has_draft": { "type": "boolean" }, "draft_revision": { "type": "integer" }, "current_version": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "version", "created_at" ], "additionalProperties": false }, "node_count": { "type": "integer" }, "trigger_kinds": { "type": "array", "items": { "type": "string" } }, "last_run": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "status", "created_at" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "draft_differs": { "type": "boolean" }, "access": { "type": "object", "properties": { "space_role": { "type": [ "string", "null" ] }, "share_role": { "type": [ "string", "null" ] }, "access_mode": { "type": "string" }, "is_creator": { "type": "boolean" }, "can_view": { "type": "boolean" }, "can_edit": { "type": "boolean" }, "can_run": { "type": "boolean" }, "can_publish": { "type": "boolean" }, "can_share": { "type": "boolean" }, "can_archive": { "type": "boolean" }, "can_approve": { "type": "boolean" } }, "required": [ "space_role", "share_role", "access_mode", "is_creator", "can_view", "can_edit", "can_run", "can_publish", "can_share", "can_archive", "can_approve" ], "additionalProperties": false }, "access_mode": { "type": "string" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "share_count": { "type": "integer" } }, "required": [ "id", "space_id", "name", "summary", "status", "enabled", "has_draft", "draft_revision", "current_version", "node_count", "trigger_kinds", "last_run", "created_at", "updated_at", "draft_differs", "access", "access_mode", "created_by", "share_count" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "additionalProperties": false, "title": "WorkflowsListResponse" }, "WorkflowsCreateRequest": { "type": "object", "required": [ "space_id" ], "properties": { "space_id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 200 } }, "additionalProperties": false, "title": "WorkflowsCreateRequest" }, "WorkflowsCreateResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "summary": { "type": "string" }, "status": { "type": "string" }, "enabled": { "type": "boolean" }, "has_draft": { "type": "boolean" }, "draft_revision": { "type": "integer" }, "current_version": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" }, "change_note": { "type": "string" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "definition": { "type": "object", "additionalProperties": true } }, "required": [ "id", "version", "change_note", "created_by", "created_at", "definition" ], "additionalProperties": false }, "node_count": { "type": "integer" }, "trigger_kinds": { "type": "array", "items": { "type": "string" } }, "last_run": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "status", "created_at" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "draft_differs": { "type": "boolean" }, "access": { "type": "object", "properties": { "space_role": { "type": [ "string", "null" ] }, "share_role": { "type": [ "string", "null" ] }, "access_mode": { "type": "string" }, "is_creator": { "type": "boolean" }, "can_view": { "type": "boolean" }, "can_edit": { "type": "boolean" }, "can_run": { "type": "boolean" }, "can_publish": { "type": "boolean" }, "can_share": { "type": "boolean" }, "can_archive": { "type": "boolean" }, "can_approve": { "type": "boolean" } }, "required": [ "space_role", "share_role", "access_mode", "is_creator", "can_view", "can_edit", "can_run", "can_publish", "can_share", "can_archive", "can_approve" ], "additionalProperties": false }, "access_mode": { "type": "string" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "share_count": { "type": "integer" }, "draft": { "type": [ "object", "null" ], "additionalProperties": true }, "draft_updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "webhooks": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "url": { "type": "string" }, "auth_mode": { "type": "string" }, "methods": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" } }, "required": [ "node_id", "url", "auth_mode", "methods", "active" ], "additionalProperties": false } }, "triggers": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "kind": { "type": "string" }, "active": { "type": "boolean" }, "next_fire_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_fired_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_error_code": { "type": [ "string", "null" ] }, "last_error_message": { "type": [ "string", "null" ] } }, "required": [ "node_id", "kind", "active", "next_fire_at", "last_fired_at", "last_error_code", "last_error_message" ], "additionalProperties": false } }, "shares": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "user": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "role": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "user", "role", "created_at" ], "additionalProperties": false } }, "published_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "pins": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "item_counts": { "type": "object", "additionalProperties": { "type": "integer" } }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "node_id", "item_counts", "updated_at" ], "additionalProperties": false } } }, "required": [ "id", "space_id", "name", "summary", "status", "enabled", "has_draft", "draft_revision", "current_version", "node_count", "trigger_kinds", "last_run", "created_at", "updated_at", "draft_differs", "access", "access_mode", "created_by", "share_count", "draft", "draft_updated_at", "webhooks", "triggers", "shares", "published_by", "pins" ], "additionalProperties": false, "title": "WorkflowsCreateResponse" }, "WorkflowsGetRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "WorkflowsGetRequest" }, "WorkflowsGetResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "summary": { "type": "string" }, "status": { "type": "string" }, "enabled": { "type": "boolean" }, "has_draft": { "type": "boolean" }, "draft_revision": { "type": "integer" }, "current_version": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" }, "change_note": { "type": "string" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "definition": { "type": "object", "additionalProperties": true } }, "required": [ "id", "version", "change_note", "created_by", "created_at", "definition" ], "additionalProperties": false }, "node_count": { "type": "integer" }, "trigger_kinds": { "type": "array", "items": { "type": "string" } }, "last_run": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "status", "created_at" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "draft_differs": { "type": "boolean" }, "access": { "type": "object", "properties": { "space_role": { "type": [ "string", "null" ] }, "share_role": { "type": [ "string", "null" ] }, "access_mode": { "type": "string" }, "is_creator": { "type": "boolean" }, "can_view": { "type": "boolean" }, "can_edit": { "type": "boolean" }, "can_run": { "type": "boolean" }, "can_publish": { "type": "boolean" }, "can_share": { "type": "boolean" }, "can_archive": { "type": "boolean" }, "can_approve": { "type": "boolean" } }, "required": [ "space_role", "share_role", "access_mode", "is_creator", "can_view", "can_edit", "can_run", "can_publish", "can_share", "can_archive", "can_approve" ], "additionalProperties": false }, "access_mode": { "type": "string" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "share_count": { "type": "integer" }, "draft": { "type": [ "object", "null" ], "additionalProperties": true }, "draft_updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "webhooks": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "url": { "type": "string" }, "auth_mode": { "type": "string" }, "methods": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" } }, "required": [ "node_id", "url", "auth_mode", "methods", "active" ], "additionalProperties": false } }, "triggers": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "kind": { "type": "string" }, "active": { "type": "boolean" }, "next_fire_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_fired_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_error_code": { "type": [ "string", "null" ] }, "last_error_message": { "type": [ "string", "null" ] } }, "required": [ "node_id", "kind", "active", "next_fire_at", "last_fired_at", "last_error_code", "last_error_message" ], "additionalProperties": false } }, "shares": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "user": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "role": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "user", "role", "created_at" ], "additionalProperties": false } }, "published_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "pins": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "item_counts": { "type": "object", "additionalProperties": { "type": "integer" } }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "node_id", "item_counts", "updated_at" ], "additionalProperties": false } } }, "required": [ "id", "space_id", "name", "summary", "status", "enabled", "has_draft", "draft_revision", "current_version", "node_count", "trigger_kinds", "last_run", "created_at", "updated_at", "draft_differs", "access", "access_mode", "created_by", "share_count", "draft", "draft_updated_at", "webhooks", "triggers", "shares", "published_by", "pins" ], "additionalProperties": false, "title": "WorkflowsGetResponse" }, "WorkflowsRenameRequest": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "maxLength": 200 }, "summary": { "type": [ "string", "null" ], "maxLength": 2000 } }, "additionalProperties": false, "title": "WorkflowsRenameRequest" }, "WorkflowsRenameResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "summary": { "type": "string" }, "status": { "type": "string" }, "enabled": { "type": "boolean" }, "has_draft": { "type": "boolean" }, "draft_revision": { "type": "integer" }, "current_version": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" }, "change_note": { "type": "string" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "definition": { "type": "object", "additionalProperties": true } }, "required": [ "id", "version", "change_note", "created_by", "created_at", "definition" ], "additionalProperties": false }, "node_count": { "type": "integer" }, "trigger_kinds": { "type": "array", "items": { "type": "string" } }, "last_run": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "status", "created_at" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "draft_differs": { "type": "boolean" }, "access": { "type": "object", "properties": { "space_role": { "type": [ "string", "null" ] }, "share_role": { "type": [ "string", "null" ] }, "access_mode": { "type": "string" }, "is_creator": { "type": "boolean" }, "can_view": { "type": "boolean" }, "can_edit": { "type": "boolean" }, "can_run": { "type": "boolean" }, "can_publish": { "type": "boolean" }, "can_share": { "type": "boolean" }, "can_archive": { "type": "boolean" }, "can_approve": { "type": "boolean" } }, "required": [ "space_role", "share_role", "access_mode", "is_creator", "can_view", "can_edit", "can_run", "can_publish", "can_share", "can_archive", "can_approve" ], "additionalProperties": false }, "access_mode": { "type": "string" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "share_count": { "type": "integer" }, "draft": { "type": [ "object", "null" ], "additionalProperties": true }, "draft_updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "webhooks": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "url": { "type": "string" }, "auth_mode": { "type": "string" }, "methods": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" } }, "required": [ "node_id", "url", "auth_mode", "methods", "active" ], "additionalProperties": false } }, "triggers": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "kind": { "type": "string" }, "active": { "type": "boolean" }, "next_fire_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_fired_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_error_code": { "type": [ "string", "null" ] }, "last_error_message": { "type": [ "string", "null" ] } }, "required": [ "node_id", "kind", "active", "next_fire_at", "last_fired_at", "last_error_code", "last_error_message" ], "additionalProperties": false } }, "shares": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "user": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "role": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "user", "role", "created_at" ], "additionalProperties": false } }, "published_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "pins": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "item_counts": { "type": "object", "additionalProperties": { "type": "integer" } }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "node_id", "item_counts", "updated_at" ], "additionalProperties": false } } }, "required": [ "id", "space_id", "name", "summary", "status", "enabled", "has_draft", "draft_revision", "current_version", "node_count", "trigger_kinds", "last_run", "created_at", "updated_at", "draft_differs", "access", "access_mode", "created_by", "share_count", "draft", "draft_updated_at", "webhooks", "triggers", "shares", "published_by", "pins" ], "additionalProperties": false, "title": "WorkflowsRenameResponse" }, "WorkflowsDeleteRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "WorkflowsDeleteRequest" }, "WorkflowsDeleteResponse": { "type": "object", "properties": { "outcome": { "type": "string", "enum": [ "deleted" ] } }, "required": [ "outcome" ], "additionalProperties": false, "title": "WorkflowsDeleteResponse" }, "WorkflowsDraftSaveRequest": { "type": "object", "required": [ "expected_revision", "draft" ], "properties": { "expected_revision": { "type": "integer", "minimum": 0, "description": "The draft_revision the caller last saw; stale values are rejected with 409." }, "draft": { "additionalProperties": false, "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "nodes": { "items": { "additionalProperties": false, "properties": { "id": { "maxLength": 80, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "title": "Id", "type": "string" }, "kind": { "maxLength": 40, "minLength": 1, "title": "Kind", "type": "string" }, "name": { "default": "", "maxLength": 120, "title": "Name", "type": "string" }, "position": { "additionalProperties": false, "properties": { "x": { "default": 0, "title": "X", "type": "number" }, "y": { "default": 0, "title": "Y", "type": "number" } }, "title": "Point", "type": "object" }, "disabled": { "default": false, "title": "Disabled", "type": "boolean" }, "config": { "additionalProperties": true, "title": "Config", "type": "object" }, "on_error": { "default": "stop", "enum": [ "stop", "continue", "error_output" ], "title": "On Error", "type": "string" }, "retry": { "additionalProperties": false, "properties": { "max_attempts": { "default": 1, "maximum": 5, "minimum": 1, "title": "Max Attempts", "type": "integer" }, "backoff_seconds": { "default": 30, "maximum": 3600, "minimum": 0, "title": "Backoff Seconds", "type": "integer" } }, "title": "RetryPolicy", "type": "object" }, "notes": { "default": "", "maxLength": 2000, "title": "Notes", "type": "string" } }, "required": [ "id", "kind" ], "title": "WorkflowNode", "type": "object" }, "maxItems": 200, "title": "Nodes", "type": "array" }, "connections": { "items": { "additionalProperties": false, "properties": { "id": { "maxLength": 80, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "title": "Id", "type": "string" }, "source_node_id": { "maxLength": 80, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "title": "Source Node Id", "type": "string" }, "source_port": { "maxLength": 40, "minLength": 1, "title": "Source Port", "type": "string" }, "target_node_id": { "maxLength": 80, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "title": "Target Node Id", "type": "string" }, "target_port": { "maxLength": 40, "minLength": 1, "title": "Target Port", "type": "string" }, "order": { "default": 0, "maximum": 10000, "minimum": 0, "title": "Order", "type": "integer" } }, "required": [ "id", "source_node_id", "source_port", "target_node_id", "target_port" ], "title": "WorkflowConnection", "type": "object" }, "maxItems": 500, "title": "Connections", "type": "array" }, "groups": { "items": { "additionalProperties": false, "properties": { "id": { "maxLength": 80, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "title": "Id", "type": "string" }, "name": { "default": "", "maxLength": 120, "title": "Name", "type": "string" }, "node_ids": { "items": { "maxLength": 80, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "type": "string" }, "maxItems": 200, "title": "Node Ids", "type": "array" }, "position": { "additionalProperties": false, "properties": { "x": { "default": 0, "title": "X", "type": "number" }, "y": { "default": 0, "title": "Y", "type": "number" } }, "title": "Point", "type": "object" }, "size": { "additionalProperties": false, "properties": { "width": { "exclusiveMinimum": 0, "title": "Width", "type": "number" }, "height": { "exclusiveMinimum": 0, "title": "Height", "type": "number" } }, "required": [ "width", "height" ], "title": "Size", "type": "object" } }, "required": [ "id", "size" ], "title": "WorkflowGroup", "type": "object" }, "maxItems": 50, "title": "Groups", "type": "array" }, "settings": { "additionalProperties": false, "properties": { "parallelism": { "default": 4, "maximum": 16, "minimum": 1, "title": "Parallelism", "type": "integer" }, "max_activations": { "default": 1000, "maximum": 5000, "minimum": 1, "title": "Max Activations", "type": "integer" }, "timeout_seconds": { "default": 7200, "maximum": 86400, "minimum": 1, "title": "Timeout Seconds", "type": "integer" }, "cost_limit_micro_usd": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Cost Limit Micro Usd" } }, "title": "WorkflowSettings", "type": "object" } }, "title": "WorkflowDefinition", "type": "object" } }, "additionalProperties": false, "title": "WorkflowsDraftSaveRequest" }, "WorkflowsDraftSaveResponse": { "type": "object", "properties": { "workflow_id": { "type": "string", "format": "uuid" }, "draft_revision": { "type": "integer" }, "draft_updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "issues": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "required": [ "workflow_id", "draft_revision", "draft_updated_at", "issues" ], "additionalProperties": false, "title": "WorkflowsDraftSaveResponse" }, "WorkflowsDraftDiscardRequest": { "type": "object", "required": [ "expected_revision" ], "properties": { "expected_revision": { "type": "integer", "minimum": 0, "description": "The draft_revision the caller last saw; stale values are rejected with 409." } }, "additionalProperties": false, "title": "WorkflowsDraftDiscardRequest" }, "WorkflowsDraftDiscardResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "summary": { "type": "string" }, "status": { "type": "string" }, "enabled": { "type": "boolean" }, "has_draft": { "type": "boolean" }, "draft_revision": { "type": "integer" }, "current_version": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" }, "change_note": { "type": "string" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "definition": { "type": "object", "additionalProperties": true } }, "required": [ "id", "version", "change_note", "created_by", "created_at", "definition" ], "additionalProperties": false }, "node_count": { "type": "integer" }, "trigger_kinds": { "type": "array", "items": { "type": "string" } }, "last_run": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "status", "created_at" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "draft_differs": { "type": "boolean" }, "access": { "type": "object", "properties": { "space_role": { "type": [ "string", "null" ] }, "share_role": { "type": [ "string", "null" ] }, "access_mode": { "type": "string" }, "is_creator": { "type": "boolean" }, "can_view": { "type": "boolean" }, "can_edit": { "type": "boolean" }, "can_run": { "type": "boolean" }, "can_publish": { "type": "boolean" }, "can_share": { "type": "boolean" }, "can_archive": { "type": "boolean" }, "can_approve": { "type": "boolean" } }, "required": [ "space_role", "share_role", "access_mode", "is_creator", "can_view", "can_edit", "can_run", "can_publish", "can_share", "can_archive", "can_approve" ], "additionalProperties": false }, "access_mode": { "type": "string" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "share_count": { "type": "integer" }, "draft": { "type": [ "object", "null" ], "additionalProperties": true }, "draft_updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "webhooks": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "url": { "type": "string" }, "auth_mode": { "type": "string" }, "methods": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" } }, "required": [ "node_id", "url", "auth_mode", "methods", "active" ], "additionalProperties": false } }, "triggers": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "kind": { "type": "string" }, "active": { "type": "boolean" }, "next_fire_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_fired_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_error_code": { "type": [ "string", "null" ] }, "last_error_message": { "type": [ "string", "null" ] } }, "required": [ "node_id", "kind", "active", "next_fire_at", "last_fired_at", "last_error_code", "last_error_message" ], "additionalProperties": false } }, "shares": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "user": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "role": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "user", "role", "created_at" ], "additionalProperties": false } }, "published_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "pins": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "item_counts": { "type": "object", "additionalProperties": { "type": "integer" } }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "node_id", "item_counts", "updated_at" ], "additionalProperties": false } } }, "required": [ "id", "space_id", "name", "summary", "status", "enabled", "has_draft", "draft_revision", "current_version", "node_count", "trigger_kinds", "last_run", "created_at", "updated_at", "draft_differs", "access", "access_mode", "created_by", "share_count", "draft", "draft_updated_at", "webhooks", "triggers", "shares", "published_by", "pins" ], "additionalProperties": false, "title": "WorkflowsDraftDiscardResponse" }, "WorkflowsValidateRequest": { "type": "object", "properties": { "workflow_id": { "type": "string", "format": "uuid" }, "definition": { "additionalProperties": false, "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "nodes": { "items": { "additionalProperties": false, "properties": { "id": { "maxLength": 80, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "title": "Id", "type": "string" }, "kind": { "maxLength": 40, "minLength": 1, "title": "Kind", "type": "string" }, "name": { "default": "", "maxLength": 120, "title": "Name", "type": "string" }, "position": { "additionalProperties": false, "properties": { "x": { "default": 0, "title": "X", "type": "number" }, "y": { "default": 0, "title": "Y", "type": "number" } }, "title": "Point", "type": "object" }, "disabled": { "default": false, "title": "Disabled", "type": "boolean" }, "config": { "additionalProperties": true, "title": "Config", "type": "object" }, "on_error": { "default": "stop", "enum": [ "stop", "continue", "error_output" ], "title": "On Error", "type": "string" }, "retry": { "additionalProperties": false, "properties": { "max_attempts": { "default": 1, "maximum": 5, "minimum": 1, "title": "Max Attempts", "type": "integer" }, "backoff_seconds": { "default": 30, "maximum": 3600, "minimum": 0, "title": "Backoff Seconds", "type": "integer" } }, "title": "RetryPolicy", "type": "object" }, "notes": { "default": "", "maxLength": 2000, "title": "Notes", "type": "string" } }, "required": [ "id", "kind" ], "title": "WorkflowNode", "type": "object" }, "maxItems": 200, "title": "Nodes", "type": "array" }, "connections": { "items": { "additionalProperties": false, "properties": { "id": { "maxLength": 80, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "title": "Id", "type": "string" }, "source_node_id": { "maxLength": 80, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "title": "Source Node Id", "type": "string" }, "source_port": { "maxLength": 40, "minLength": 1, "title": "Source Port", "type": "string" }, "target_node_id": { "maxLength": 80, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "title": "Target Node Id", "type": "string" }, "target_port": { "maxLength": 40, "minLength": 1, "title": "Target Port", "type": "string" }, "order": { "default": 0, "maximum": 10000, "minimum": 0, "title": "Order", "type": "integer" } }, "required": [ "id", "source_node_id", "source_port", "target_node_id", "target_port" ], "title": "WorkflowConnection", "type": "object" }, "maxItems": 500, "title": "Connections", "type": "array" }, "groups": { "items": { "additionalProperties": false, "properties": { "id": { "maxLength": 80, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "title": "Id", "type": "string" }, "name": { "default": "", "maxLength": 120, "title": "Name", "type": "string" }, "node_ids": { "items": { "maxLength": 80, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "type": "string" }, "maxItems": 200, "title": "Node Ids", "type": "array" }, "position": { "additionalProperties": false, "properties": { "x": { "default": 0, "title": "X", "type": "number" }, "y": { "default": 0, "title": "Y", "type": "number" } }, "title": "Point", "type": "object" }, "size": { "additionalProperties": false, "properties": { "width": { "exclusiveMinimum": 0, "title": "Width", "type": "number" }, "height": { "exclusiveMinimum": 0, "title": "Height", "type": "number" } }, "required": [ "width", "height" ], "title": "Size", "type": "object" } }, "required": [ "id", "size" ], "title": "WorkflowGroup", "type": "object" }, "maxItems": 50, "title": "Groups", "type": "array" }, "settings": { "additionalProperties": false, "properties": { "parallelism": { "default": 4, "maximum": 16, "minimum": 1, "title": "Parallelism", "type": "integer" }, "max_activations": { "default": 1000, "maximum": 5000, "minimum": 1, "title": "Max Activations", "type": "integer" }, "timeout_seconds": { "default": 7200, "maximum": 86400, "minimum": 1, "title": "Timeout Seconds", "type": "integer" }, "cost_limit_micro_usd": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Cost Limit Micro Usd" } }, "title": "WorkflowSettings", "type": "object" } }, "title": "WorkflowDefinition", "type": "object" }, "space_id": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "title": "WorkflowsValidateRequest" }, "WorkflowsValidateResponse": { "type": "object", "properties": { "issues": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "required": [ "issues" ], "additionalProperties": false, "title": "WorkflowsValidateResponse" }, "WorkflowsPublishRequest": { "type": "object", "required": [ "expected_revision" ], "properties": { "expected_revision": { "type": "integer", "minimum": 0, "description": "The draft_revision the caller last saw; stale values are rejected with 409." }, "change_note": { "type": [ "string", "null" ], "maxLength": 500 } }, "additionalProperties": false, "title": "WorkflowsPublishRequest" }, "WorkflowsPublishResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "summary": { "type": "string" }, "status": { "type": "string" }, "enabled": { "type": "boolean" }, "has_draft": { "type": "boolean" }, "draft_revision": { "type": "integer" }, "current_version": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" }, "change_note": { "type": "string" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "definition": { "type": "object", "additionalProperties": true } }, "required": [ "id", "version", "change_note", "created_by", "created_at", "definition" ], "additionalProperties": false }, "node_count": { "type": "integer" }, "trigger_kinds": { "type": "array", "items": { "type": "string" } }, "last_run": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "status", "created_at" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "draft_differs": { "type": "boolean" }, "access": { "type": "object", "properties": { "space_role": { "type": [ "string", "null" ] }, "share_role": { "type": [ "string", "null" ] }, "access_mode": { "type": "string" }, "is_creator": { "type": "boolean" }, "can_view": { "type": "boolean" }, "can_edit": { "type": "boolean" }, "can_run": { "type": "boolean" }, "can_publish": { "type": "boolean" }, "can_share": { "type": "boolean" }, "can_archive": { "type": "boolean" }, "can_approve": { "type": "boolean" } }, "required": [ "space_role", "share_role", "access_mode", "is_creator", "can_view", "can_edit", "can_run", "can_publish", "can_share", "can_archive", "can_approve" ], "additionalProperties": false }, "access_mode": { "type": "string" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "share_count": { "type": "integer" }, "draft": { "type": [ "object", "null" ], "additionalProperties": true }, "draft_updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "webhooks": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "url": { "type": "string" }, "auth_mode": { "type": "string" }, "methods": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" } }, "required": [ "node_id", "url", "auth_mode", "methods", "active" ], "additionalProperties": false } }, "triggers": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "kind": { "type": "string" }, "active": { "type": "boolean" }, "next_fire_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_fired_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_error_code": { "type": [ "string", "null" ] }, "last_error_message": { "type": [ "string", "null" ] } }, "required": [ "node_id", "kind", "active", "next_fire_at", "last_fired_at", "last_error_code", "last_error_message" ], "additionalProperties": false } }, "shares": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "user": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "role": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "user", "role", "created_at" ], "additionalProperties": false } }, "published_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "pins": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "item_counts": { "type": "object", "additionalProperties": { "type": "integer" } }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "node_id", "item_counts", "updated_at" ], "additionalProperties": false } } }, "required": [ "id", "space_id", "name", "summary", "status", "enabled", "has_draft", "draft_revision", "current_version", "node_count", "trigger_kinds", "last_run", "created_at", "updated_at", "draft_differs", "access", "access_mode", "created_by", "share_count", "draft", "draft_updated_at", "webhooks", "triggers", "shares", "published_by", "pins" ], "additionalProperties": false, "title": "WorkflowsPublishResponse" }, "WorkflowsVersionsRequest": { "type": "object", "properties": { "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, "additionalProperties": false, "title": "WorkflowsVersionsRequest" }, "WorkflowsVersionsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" }, "change_note": { "type": "string" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "version", "change_note", "created_by", "created_at" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "additionalProperties": false, "title": "WorkflowsVersionsResponse" }, "WorkflowsRestoreRequest": { "type": "object", "required": [ "expected_revision" ], "properties": { "expected_revision": { "type": "integer", "minimum": 0, "description": "The draft_revision the caller last saw; stale values are rejected with 409." } }, "additionalProperties": false, "title": "WorkflowsRestoreRequest" }, "WorkflowsRestoreResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "summary": { "type": "string" }, "status": { "type": "string" }, "enabled": { "type": "boolean" }, "has_draft": { "type": "boolean" }, "draft_revision": { "type": "integer" }, "current_version": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" }, "change_note": { "type": "string" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "definition": { "type": "object", "additionalProperties": true } }, "required": [ "id", "version", "change_note", "created_by", "created_at", "definition" ], "additionalProperties": false }, "node_count": { "type": "integer" }, "trigger_kinds": { "type": "array", "items": { "type": "string" } }, "last_run": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "status", "created_at" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "draft_differs": { "type": "boolean" }, "access": { "type": "object", "properties": { "space_role": { "type": [ "string", "null" ] }, "share_role": { "type": [ "string", "null" ] }, "access_mode": { "type": "string" }, "is_creator": { "type": "boolean" }, "can_view": { "type": "boolean" }, "can_edit": { "type": "boolean" }, "can_run": { "type": "boolean" }, "can_publish": { "type": "boolean" }, "can_share": { "type": "boolean" }, "can_archive": { "type": "boolean" }, "can_approve": { "type": "boolean" } }, "required": [ "space_role", "share_role", "access_mode", "is_creator", "can_view", "can_edit", "can_run", "can_publish", "can_share", "can_archive", "can_approve" ], "additionalProperties": false }, "access_mode": { "type": "string" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "share_count": { "type": "integer" }, "draft": { "type": [ "object", "null" ], "additionalProperties": true }, "draft_updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "webhooks": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "url": { "type": "string" }, "auth_mode": { "type": "string" }, "methods": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" } }, "required": [ "node_id", "url", "auth_mode", "methods", "active" ], "additionalProperties": false } }, "triggers": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "kind": { "type": "string" }, "active": { "type": "boolean" }, "next_fire_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_fired_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_error_code": { "type": [ "string", "null" ] }, "last_error_message": { "type": [ "string", "null" ] } }, "required": [ "node_id", "kind", "active", "next_fire_at", "last_fired_at", "last_error_code", "last_error_message" ], "additionalProperties": false } }, "shares": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "user": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "role": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "user", "role", "created_at" ], "additionalProperties": false } }, "published_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "pins": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "item_counts": { "type": "object", "additionalProperties": { "type": "integer" } }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "node_id", "item_counts", "updated_at" ], "additionalProperties": false } } }, "required": [ "id", "space_id", "name", "summary", "status", "enabled", "has_draft", "draft_revision", "current_version", "node_count", "trigger_kinds", "last_run", "created_at", "updated_at", "draft_differs", "access", "access_mode", "created_by", "share_count", "draft", "draft_updated_at", "webhooks", "triggers", "shares", "published_by", "pins" ], "additionalProperties": false, "title": "WorkflowsRestoreResponse" }, "WorkflowsSetEnabledEnableRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "WorkflowsSetEnabledEnableRequest" }, "WorkflowsSetEnabledEnableResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "summary": { "type": "string" }, "status": { "type": "string" }, "enabled": { "type": "boolean" }, "has_draft": { "type": "boolean" }, "draft_revision": { "type": "integer" }, "current_version": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" }, "change_note": { "type": "string" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "definition": { "type": "object", "additionalProperties": true } }, "required": [ "id", "version", "change_note", "created_by", "created_at", "definition" ], "additionalProperties": false }, "node_count": { "type": "integer" }, "trigger_kinds": { "type": "array", "items": { "type": "string" } }, "last_run": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "status", "created_at" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "draft_differs": { "type": "boolean" }, "access": { "type": "object", "properties": { "space_role": { "type": [ "string", "null" ] }, "share_role": { "type": [ "string", "null" ] }, "access_mode": { "type": "string" }, "is_creator": { "type": "boolean" }, "can_view": { "type": "boolean" }, "can_edit": { "type": "boolean" }, "can_run": { "type": "boolean" }, "can_publish": { "type": "boolean" }, "can_share": { "type": "boolean" }, "can_archive": { "type": "boolean" }, "can_approve": { "type": "boolean" } }, "required": [ "space_role", "share_role", "access_mode", "is_creator", "can_view", "can_edit", "can_run", "can_publish", "can_share", "can_archive", "can_approve" ], "additionalProperties": false }, "access_mode": { "type": "string" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "share_count": { "type": "integer" }, "draft": { "type": [ "object", "null" ], "additionalProperties": true }, "draft_updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "webhooks": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "url": { "type": "string" }, "auth_mode": { "type": "string" }, "methods": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" } }, "required": [ "node_id", "url", "auth_mode", "methods", "active" ], "additionalProperties": false } }, "triggers": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "kind": { "type": "string" }, "active": { "type": "boolean" }, "next_fire_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_fired_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_error_code": { "type": [ "string", "null" ] }, "last_error_message": { "type": [ "string", "null" ] } }, "required": [ "node_id", "kind", "active", "next_fire_at", "last_fired_at", "last_error_code", "last_error_message" ], "additionalProperties": false } }, "shares": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "user": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "role": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "user", "role", "created_at" ], "additionalProperties": false } }, "published_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "pins": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "item_counts": { "type": "object", "additionalProperties": { "type": "integer" } }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "node_id", "item_counts", "updated_at" ], "additionalProperties": false } } }, "required": [ "id", "space_id", "name", "summary", "status", "enabled", "has_draft", "draft_revision", "current_version", "node_count", "trigger_kinds", "last_run", "created_at", "updated_at", "draft_differs", "access", "access_mode", "created_by", "share_count", "draft", "draft_updated_at", "webhooks", "triggers", "shares", "published_by", "pins" ], "additionalProperties": false, "title": "WorkflowsSetEnabledEnableResponse" }, "WorkflowsSetEnabledDisableRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "WorkflowsSetEnabledDisableRequest" }, "WorkflowsSetEnabledDisableResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "summary": { "type": "string" }, "status": { "type": "string" }, "enabled": { "type": "boolean" }, "has_draft": { "type": "boolean" }, "draft_revision": { "type": "integer" }, "current_version": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" }, "change_note": { "type": "string" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "definition": { "type": "object", "additionalProperties": true } }, "required": [ "id", "version", "change_note", "created_by", "created_at", "definition" ], "additionalProperties": false }, "node_count": { "type": "integer" }, "trigger_kinds": { "type": "array", "items": { "type": "string" } }, "last_run": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "status", "created_at" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "draft_differs": { "type": "boolean" }, "access": { "type": "object", "properties": { "space_role": { "type": [ "string", "null" ] }, "share_role": { "type": [ "string", "null" ] }, "access_mode": { "type": "string" }, "is_creator": { "type": "boolean" }, "can_view": { "type": "boolean" }, "can_edit": { "type": "boolean" }, "can_run": { "type": "boolean" }, "can_publish": { "type": "boolean" }, "can_share": { "type": "boolean" }, "can_archive": { "type": "boolean" }, "can_approve": { "type": "boolean" } }, "required": [ "space_role", "share_role", "access_mode", "is_creator", "can_view", "can_edit", "can_run", "can_publish", "can_share", "can_archive", "can_approve" ], "additionalProperties": false }, "access_mode": { "type": "string" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "share_count": { "type": "integer" }, "draft": { "type": [ "object", "null" ], "additionalProperties": true }, "draft_updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "webhooks": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "url": { "type": "string" }, "auth_mode": { "type": "string" }, "methods": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" } }, "required": [ "node_id", "url", "auth_mode", "methods", "active" ], "additionalProperties": false } }, "triggers": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "kind": { "type": "string" }, "active": { "type": "boolean" }, "next_fire_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_fired_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_error_code": { "type": [ "string", "null" ] }, "last_error_message": { "type": [ "string", "null" ] } }, "required": [ "node_id", "kind", "active", "next_fire_at", "last_fired_at", "last_error_code", "last_error_message" ], "additionalProperties": false } }, "shares": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "user": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "role": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "user", "role", "created_at" ], "additionalProperties": false } }, "published_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "pins": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "item_counts": { "type": "object", "additionalProperties": { "type": "integer" } }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "node_id", "item_counts", "updated_at" ], "additionalProperties": false } } }, "required": [ "id", "space_id", "name", "summary", "status", "enabled", "has_draft", "draft_revision", "current_version", "node_count", "trigger_kinds", "last_run", "created_at", "updated_at", "draft_differs", "access", "access_mode", "created_by", "share_count", "draft", "draft_updated_at", "webhooks", "triggers", "shares", "published_by", "pins" ], "additionalProperties": false, "title": "WorkflowsSetEnabledDisableResponse" }, "WorkflowsArchiveRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "WorkflowsArchiveRequest" }, "WorkflowsArchiveResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "summary": { "type": "string" }, "status": { "type": "string" }, "enabled": { "type": "boolean" }, "has_draft": { "type": "boolean" }, "draft_revision": { "type": "integer" }, "current_version": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" }, "change_note": { "type": "string" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "definition": { "type": "object", "additionalProperties": true } }, "required": [ "id", "version", "change_note", "created_by", "created_at", "definition" ], "additionalProperties": false }, "node_count": { "type": "integer" }, "trigger_kinds": { "type": "array", "items": { "type": "string" } }, "last_run": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "status", "created_at" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "draft_differs": { "type": "boolean" }, "access": { "type": "object", "properties": { "space_role": { "type": [ "string", "null" ] }, "share_role": { "type": [ "string", "null" ] }, "access_mode": { "type": "string" }, "is_creator": { "type": "boolean" }, "can_view": { "type": "boolean" }, "can_edit": { "type": "boolean" }, "can_run": { "type": "boolean" }, "can_publish": { "type": "boolean" }, "can_share": { "type": "boolean" }, "can_archive": { "type": "boolean" }, "can_approve": { "type": "boolean" } }, "required": [ "space_role", "share_role", "access_mode", "is_creator", "can_view", "can_edit", "can_run", "can_publish", "can_share", "can_archive", "can_approve" ], "additionalProperties": false }, "access_mode": { "type": "string" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "share_count": { "type": "integer" }, "draft": { "type": [ "object", "null" ], "additionalProperties": true }, "draft_updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "webhooks": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "url": { "type": "string" }, "auth_mode": { "type": "string" }, "methods": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" } }, "required": [ "node_id", "url", "auth_mode", "methods", "active" ], "additionalProperties": false } }, "triggers": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "kind": { "type": "string" }, "active": { "type": "boolean" }, "next_fire_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_fired_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_error_code": { "type": [ "string", "null" ] }, "last_error_message": { "type": [ "string", "null" ] } }, "required": [ "node_id", "kind", "active", "next_fire_at", "last_fired_at", "last_error_code", "last_error_message" ], "additionalProperties": false } }, "shares": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "user": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "role": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "user", "role", "created_at" ], "additionalProperties": false } }, "published_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "pins": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "item_counts": { "type": "object", "additionalProperties": { "type": "integer" } }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "node_id", "item_counts", "updated_at" ], "additionalProperties": false } } }, "required": [ "id", "space_id", "name", "summary", "status", "enabled", "has_draft", "draft_revision", "current_version", "node_count", "trigger_kinds", "last_run", "created_at", "updated_at", "draft_differs", "access", "access_mode", "created_by", "share_count", "draft", "draft_updated_at", "webhooks", "triggers", "shares", "published_by", "pins" ], "additionalProperties": false, "title": "WorkflowsArchiveResponse" }, "WorkflowsSharesListRequest": { "type": "object", "properties": { "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, "additionalProperties": false, "title": "WorkflowsSharesListRequest" }, "WorkflowsSharesListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "user": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "role": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "user", "role", "created_at" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "additionalProperties": false, "title": "WorkflowsSharesListResponse" }, "WorkflowsShareRequest": { "type": "object", "required": [ "role" ], "properties": { "user_id": { "type": "string", "format": "uuid" }, "email": { "type": "string", "format": "email" }, "role": { "type": "string", "enum": [ "VIEWER", "RUNNER", "EDITOR", "OWNER" ], "description": "VIEWER sees the workflow, RUNNER also starts runs, EDITOR edits, runs and approves, OWNER may also publish, share and archive." } }, "additionalProperties": false, "title": "WorkflowsShareRequest" }, "WorkflowsShareResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "user": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "role": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "user", "role", "created_at" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false, "title": "WorkflowsShareResponse" }, "WorkflowsShareUpdateRequest": { "type": "object", "required": [ "role" ], "properties": { "role": { "type": "string", "enum": [ "VIEWER", "RUNNER", "EDITOR", "OWNER" ], "description": "VIEWER sees the workflow, RUNNER also starts runs, EDITOR edits, runs and approves, OWNER may also publish, share and archive." } }, "additionalProperties": false, "title": "WorkflowsShareUpdateRequest" }, "WorkflowsShareUpdateResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "user": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "role": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "user", "role", "created_at" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false, "title": "WorkflowsShareUpdateResponse" }, "WorkflowsShareRevokeRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "WorkflowsShareRevokeRequest" }, "WorkflowsShareRevokeResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "user": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "role": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "user", "role", "created_at" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false, "title": "WorkflowsShareRevokeResponse" }, "WorkflowsWebhooksRotateRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "WorkflowsWebhooksRotateRequest" }, "WorkflowsWebhooksRotateResponse": { "type": "object", "properties": { "url": { "type": "string" }, "secret": { "type": "string" } }, "required": [ "url", "secret" ], "additionalProperties": false, "title": "WorkflowsWebhooksRotateResponse" }, "WorkflowsNodeKindsRequest": { "type": "object", "properties": { "kinds": { "type": "array", "items": { "type": "string" }, "minItems": 1, "maxItems": 50, "description": "Node kind keys to return; omit for every kind." }, "detail": { "type": "string", "enum": [ "summary", "full" ], "description": "summary: key, category, description, ports; full: adds schemas." } }, "additionalProperties": false, "title": "WorkflowsNodeKindsRequest" }, "WorkflowsNodeKindsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "category": { "type": "string" }, "description": { "type": "string" }, "inputs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "outputs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "dynamic_outputs": { "type": "boolean" }, "config_schema": { "type": "object", "additionalProperties": true }, "default_config": { "type": "object", "additionalProperties": true }, "output_schema": { "type": [ "object", "null" ], "additionalProperties": true } }, "required": [ "key", "category", "description", "inputs", "outputs", "dynamic_outputs" ] } } }, "required": [ "items" ], "additionalProperties": false, "title": "WorkflowsNodeKindsResponse" }, "WorkflowsRunsStartRequest": { "type": "object", "required": [ "workflow_id" ], "properties": { "workflow_id": { "type": "string", "format": "uuid" }, "node_id": { "type": "string", "maxLength": 80, "description": "Trigger node to start from; defaults to the first enabled manual trigger." }, "input": { "type": "object", "properties": { "instruction": { "type": "string", "maxLength": 4000, "description": "Free-text instruction passed to the manual trigger item." }, "inputs": { "type": "object", "description": "Values for the inputs declared on the manual trigger node, keyed by input key." }, "document_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "folder_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false }, "version_id": { "type": "string", "format": "uuid", "description": "Run an earlier published version instead of the current one." }, "origin": { "type": "string", "enum": [ "manual", "schedule", "event", "webhook", "partner", "sub_workflow", "test" ], "description": "Only manual is allowed for callers; the platform sets schedule, event and webhook." }, "trigger_payload": { "type": [ "object", "null" ] }, "webhook_id": { "type": "string", "format": "uuid", "description": "Platform only: webhook that received the request." }, "trigger_id": { "type": "string", "format": "uuid", "description": "Platform only: trigger that fired." }, "trigger_firing_id": { "type": "string", "format": "uuid", "description": "Platform only: firing that started this run." } }, "additionalProperties": false, "title": "WorkflowsRunsStartRequest" }, "WorkflowsRunsStartResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workflow_id": { "type": "string", "format": "uuid" }, "workflow_name": { "type": "string" }, "space_id": { "type": "string", "format": "uuid" }, "version": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" } }, "required": [ "id", "version" ], "additionalProperties": false }, "origin": { "type": "string" }, "actor_type": { "type": "string" }, "trigger_id": { "type": [ "string", "null" ], "format": "uuid" }, "webhook_id": { "type": [ "string", "null" ], "format": "uuid" }, "parent_run_id": { "type": [ "string", "null" ], "format": "uuid" }, "trigger_node_id": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "error_code": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "error_details": { "type": "object", "additionalProperties": true }, "retry_of": { "type": [ "string", "null" ], "format": "uuid" }, "activations_total": { "type": "integer" }, "cost_micro_usd": { "type": "integer" }, "requested_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "started_at": { "type": [ "string", "null" ], "format": "date-time" }, "completed_at": { "type": [ "string", "null" ], "format": "date-time" }, "wake_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "workflow_id", "workflow_name", "space_id", "version", "origin", "actor_type", "trigger_id", "webhook_id", "parent_run_id", "trigger_node_id", "status", "error_code", "error_message", "error_details", "retry_of", "activations_total", "cost_micro_usd", "requested_by", "created_at", "started_at", "completed_at", "wake_at" ], "additionalProperties": false, "title": "WorkflowsRunsStartResponse" }, "WorkflowsRunsListRequest": { "type": "object", "required": [ "space_id" ], "properties": { "space_id": { "type": "string", "format": "uuid" }, "workflow_id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "QUEUED", "RUNNING", "WAITING", "CANCEL_REQUESTED", "SUCCEEDED", "FAILED", "CANCELLED" ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }, "include_tests": { "type": "boolean", "description": "Also list runs that tested a single node from the editor." }, "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, "additionalProperties": false, "title": "WorkflowsRunsListRequest" }, "WorkflowsRunsListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workflow_id": { "type": "string", "format": "uuid" }, "workflow_name": { "type": "string" }, "space_id": { "type": "string", "format": "uuid" }, "version": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" } }, "required": [ "id", "version" ], "additionalProperties": false }, "origin": { "type": "string" }, "actor_type": { "type": "string" }, "trigger_id": { "type": [ "string", "null" ], "format": "uuid" }, "webhook_id": { "type": [ "string", "null" ], "format": "uuid" }, "parent_run_id": { "type": [ "string", "null" ], "format": "uuid" }, "trigger_node_id": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "error_code": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "error_details": { "type": "object", "additionalProperties": true }, "retry_of": { "type": [ "string", "null" ], "format": "uuid" }, "activations_total": { "type": "integer" }, "cost_micro_usd": { "type": "integer" }, "requested_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "started_at": { "type": [ "string", "null" ], "format": "date-time" }, "completed_at": { "type": [ "string", "null" ], "format": "date-time" }, "wake_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "workflow_id", "workflow_name", "space_id", "version", "origin", "actor_type", "trigger_id", "webhook_id", "parent_run_id", "trigger_node_id", "status", "error_code", "error_message", "error_details", "retry_of", "activations_total", "cost_micro_usd", "requested_by", "created_at", "started_at", "completed_at", "wake_at" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "additionalProperties": false, "title": "WorkflowsRunsListResponse" }, "WorkflowsRunsGetRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "WorkflowsRunsGetRequest" }, "WorkflowsRunsGetResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workflow_id": { "type": "string", "format": "uuid" }, "workflow_name": { "type": "string" }, "space_id": { "type": "string", "format": "uuid" }, "version": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" } }, "required": [ "id", "version" ], "additionalProperties": false }, "origin": { "type": "string" }, "actor_type": { "type": "string" }, "trigger_id": { "type": [ "string", "null" ], "format": "uuid" }, "webhook_id": { "type": [ "string", "null" ], "format": "uuid" }, "parent_run_id": { "type": [ "string", "null" ], "format": "uuid" }, "trigger_node_id": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "error_code": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "error_details": { "type": "object", "additionalProperties": true }, "retry_of": { "type": [ "string", "null" ], "format": "uuid" }, "activations_total": { "type": "integer" }, "cost_micro_usd": { "type": "integer" }, "requested_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "started_at": { "type": [ "string", "null" ], "format": "date-time" }, "completed_at": { "type": [ "string", "null" ], "format": "date-time" }, "wake_at": { "type": [ "string", "null" ], "format": "date-time" }, "definition": { "type": "object", "additionalProperties": true }, "settings": { "type": "object", "additionalProperties": true }, "trace_id": { "type": "string" }, "node_runs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "node_id": { "type": "string" }, "node_kind": { "type": "string" }, "node_name": { "type": "string" }, "context_key": { "type": [ "string", "null" ] }, "iteration_path": { "type": "array", "items": { "type": "integer" } }, "attempt": { "type": "integer" }, "sequence": { "type": "integer" }, "status": { "type": "string" }, "input_count": { "type": "integer" }, "output_counts": { "type": "object", "additionalProperties": true }, "error_code": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "error_details": { "type": "object", "additionalProperties": true }, "retryable": { "type": "boolean" }, "cost_micro_usd": { "type": "integer" }, "duration_ms": { "type": [ "integer", "null" ] }, "wake_at": { "type": [ "string", "null" ], "format": "date-time" }, "started_at": { "type": [ "string", "null" ], "format": "date-time" }, "completed_at": { "type": [ "string", "null" ], "format": "date-time" }, "wait": { "type": [ "object", "null" ], "additionalProperties": true } }, "required": [ "id", "node_id", "node_kind", "node_name", "context_key", "iteration_path", "attempt", "sequence", "status", "input_count", "output_counts", "error_code", "error_message", "error_details", "retryable", "cost_micro_usd", "duration_ms", "wake_at", "started_at", "completed_at", "wait" ], "additionalProperties": false } }, "events_cursor": { "type": "integer" } }, "required": [ "id", "workflow_id", "workflow_name", "space_id", "version", "origin", "actor_type", "trigger_id", "webhook_id", "parent_run_id", "trigger_node_id", "status", "error_code", "error_message", "error_details", "retry_of", "activations_total", "cost_micro_usd", "requested_by", "created_at", "started_at", "completed_at", "wake_at", "definition", "settings", "trace_id", "node_runs", "events_cursor" ], "additionalProperties": false, "title": "WorkflowsRunsGetResponse" }, "WorkflowsRunsEventsRequest": { "type": "object", "properties": { "after_event_id": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "title": "WorkflowsRunsEventsRequest" }, "WorkflowsRunsEventsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string" }, "node_id": { "type": [ "string", "null" ] }, "payload": { "type": "object", "additionalProperties": true }, "actor": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "type", "node_id", "payload", "actor", "created_at" ], "additionalProperties": false } }, "cursor": { "type": "integer" } }, "required": [ "items", "cursor" ], "additionalProperties": false, "title": "WorkflowsRunsEventsResponse" }, "WorkflowsRunsCancelRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "WorkflowsRunsCancelRequest" }, "WorkflowsRunsCancelResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workflow_id": { "type": "string", "format": "uuid" }, "workflow_name": { "type": "string" }, "space_id": { "type": "string", "format": "uuid" }, "version": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" } }, "required": [ "id", "version" ], "additionalProperties": false }, "origin": { "type": "string" }, "actor_type": { "type": "string" }, "trigger_id": { "type": [ "string", "null" ], "format": "uuid" }, "webhook_id": { "type": [ "string", "null" ], "format": "uuid" }, "parent_run_id": { "type": [ "string", "null" ], "format": "uuid" }, "trigger_node_id": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "error_code": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "error_details": { "type": "object", "additionalProperties": true }, "retry_of": { "type": [ "string", "null" ], "format": "uuid" }, "activations_total": { "type": "integer" }, "cost_micro_usd": { "type": "integer" }, "requested_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "started_at": { "type": [ "string", "null" ], "format": "date-time" }, "completed_at": { "type": [ "string", "null" ], "format": "date-time" }, "wake_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "workflow_id", "workflow_name", "space_id", "version", "origin", "actor_type", "trigger_id", "webhook_id", "parent_run_id", "trigger_node_id", "status", "error_code", "error_message", "error_details", "retry_of", "activations_total", "cost_micro_usd", "requested_by", "created_at", "started_at", "completed_at", "wake_at" ], "additionalProperties": false, "title": "WorkflowsRunsCancelResponse" }, "WorkflowsRunsRetryRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "WorkflowsRunsRetryRequest" }, "WorkflowsRunsRetryResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workflow_id": { "type": "string", "format": "uuid" }, "workflow_name": { "type": "string" }, "space_id": { "type": "string", "format": "uuid" }, "version": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" } }, "required": [ "id", "version" ], "additionalProperties": false }, "origin": { "type": "string" }, "actor_type": { "type": "string" }, "trigger_id": { "type": [ "string", "null" ], "format": "uuid" }, "webhook_id": { "type": [ "string", "null" ], "format": "uuid" }, "parent_run_id": { "type": [ "string", "null" ], "format": "uuid" }, "trigger_node_id": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "error_code": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "error_details": { "type": "object", "additionalProperties": true }, "retry_of": { "type": [ "string", "null" ], "format": "uuid" }, "activations_total": { "type": "integer" }, "cost_micro_usd": { "type": "integer" }, "requested_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "started_at": { "type": [ "string", "null" ], "format": "date-time" }, "completed_at": { "type": [ "string", "null" ], "format": "date-time" }, "wake_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "workflow_id", "workflow_name", "space_id", "version", "origin", "actor_type", "trigger_id", "webhook_id", "parent_run_id", "trigger_node_id", "status", "error_code", "error_message", "error_details", "retry_of", "activations_total", "cost_micro_usd", "requested_by", "created_at", "started_at", "completed_at", "wake_at" ], "additionalProperties": false, "title": "WorkflowsRunsRetryResponse" }, "WorkflowsRunsNodeItemsRequest": { "type": "object", "required": [ "side" ], "properties": { "side": { "type": "string", "enum": [ "input", "output" ] }, "port": { "type": "string", "maxLength": 40 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }, "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, "additionalProperties": false, "title": "WorkflowsRunsNodeItemsRequest" }, "WorkflowsRunsNodeItemsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "total": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "total", "offset", "limit", "next_cursor" ], "additionalProperties": false, "title": "WorkflowsRunsNodeItemsResponse" }, "WorkflowsRunsResumeRequest": { "type": "object", "required": [ "decision" ], "properties": { "decision": { "type": "string", "enum": [ "approved", "rejected" ] }, "comment": { "type": "string", "maxLength": 4000 }, "form_values": { "type": "object" } }, "additionalProperties": false, "title": "WorkflowsRunsResumeRequest" }, "WorkflowsRunsResumeResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "node_id": { "type": "string" }, "node_kind": { "type": "string" }, "node_name": { "type": "string" }, "context_key": { "type": [ "string", "null" ] }, "iteration_path": { "type": "array", "items": { "type": "integer" } }, "attempt": { "type": "integer" }, "sequence": { "type": "integer" }, "status": { "type": "string" }, "input_count": { "type": "integer" }, "output_counts": { "type": "object", "additionalProperties": true }, "error_code": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "error_details": { "type": "object", "additionalProperties": true }, "retryable": { "type": "boolean" }, "cost_micro_usd": { "type": "integer" }, "duration_ms": { "type": [ "integer", "null" ] }, "wake_at": { "type": [ "string", "null" ], "format": "date-time" }, "started_at": { "type": [ "string", "null" ], "format": "date-time" }, "completed_at": { "type": [ "string", "null" ], "format": "date-time" }, "wait": { "type": [ "object", "null" ], "additionalProperties": true } }, "required": [ "id", "node_id", "node_kind", "node_name", "context_key", "iteration_path", "attempt", "sequence", "status", "input_count", "output_counts", "error_code", "error_message", "error_details", "retryable", "cost_micro_usd", "duration_ms", "wake_at", "started_at", "completed_at", "wait" ], "additionalProperties": false, "title": "WorkflowsRunsResumeResponse" }, "WorkflowsApprovalsListRequest": { "type": "object", "required": [ "space_id" ], "properties": { "space_id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "OPEN", "RESOLVED", "EXPIRED", "CANCELLED" ] }, "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, "additionalProperties": false, "title": "WorkflowsApprovalsListRequest" }, "WorkflowsApprovalsListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "wait_id": { "type": "string", "format": "uuid" }, "run_id": { "type": "string", "format": "uuid" }, "node_run_id": { "type": "string", "format": "uuid" }, "node_id": { "type": "string" }, "workflow": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "title": { "type": "string" }, "message": { "type": "string" }, "form": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "required": [ "wait_id", "run_id", "node_run_id", "node_id", "workflow", "title", "message", "form" ], "additionalProperties": true } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "additionalProperties": false, "title": "WorkflowsApprovalsListResponse" }, "PagesListRequest": { "additionalProperties": false, "properties": { "space_id": { "format": "uuid", "title": "Space Id", "type": "string" }, "kind": { "anyOf": [ { "enum": [ "blocks", "live_document", "html" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Kind" }, "status": { "anyOf": [ { "enum": [ "DRAFT", "PUBLISHED", "ARCHIVED" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "limit": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, "required": [ "space_id" ], "title": "PagesListRequest", "type": "object" }, "PagesListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object" } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "title": "PagesListResponse" }, "PagesCreateRequestCalloutBlock": { "additionalProperties": false, "properties": { "type": { "const": "callout", "title": "Type", "type": "string" }, "tone": { "default": "info", "enum": [ "info", "success", "warning", "danger" ], "title": "Tone", "type": "string" }, "markdown": { "maxLength": 20000, "title": "Markdown", "type": "string" } }, "required": [ "type", "markdown" ], "title": "PagesCreateRequestCalloutBlock", "type": "object" }, "PagesCreateRequestChoiceBlock": { "additionalProperties": false, "properties": { "key": { "maxLength": 64, "title": "Key", "type": "string" }, "label": { "maxLength": 200, "title": "Label", "type": "string" }, "description": { "default": "", "maxLength": 2000, "title": "Description", "type": "string" }, "required": { "default": false, "title": "Required", "type": "boolean" }, "type": { "const": "choice", "title": "Type", "type": "string" }, "options": { "items": { "$ref": "#/components/schemas/PagesCreateRequestChoiceOption" }, "maxItems": 50, "minItems": 1, "title": "Options", "type": "array" }, "multiple": { "default": false, "title": "Multiple", "type": "boolean" }, "display": { "default": "radio", "enum": [ "radio", "select", "buttons" ], "title": "Display", "type": "string" }, "submit_on_select": { "default": false, "title": "Submit On Select", "type": "boolean" } }, "required": [ "key", "label", "type", "options" ], "title": "PagesCreateRequestChoiceBlock", "type": "object" }, "PagesCreateRequestChoiceOption": { "additionalProperties": false, "properties": { "key": { "maxLength": 64, "title": "Key", "type": "string" }, "label": { "maxLength": 200, "title": "Label", "type": "string" }, "tone": { "default": "neutral", "enum": [ "neutral", "primary", "destructive" ], "title": "Tone", "type": "string" } }, "required": [ "key", "label" ], "title": "PagesCreateRequestChoiceOption", "type": "object" }, "PagesCreateRequestDividerBlock": { "additionalProperties": false, "properties": { "type": { "const": "divider", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "PagesCreateRequestDividerBlock", "type": "object" }, "PagesCreateRequestDownloadBlock": { "additionalProperties": false, "properties": { "type": { "const": "download", "title": "Type", "type": "string" }, "asset_key": { "maxLength": 64, "title": "Asset Key", "type": "string" }, "label": { "maxLength": 200, "title": "Label", "type": "string" } }, "required": [ "type", "asset_key", "label" ], "title": "PagesCreateRequestDownloadBlock", "type": "object" }, "PagesCreateRequestFieldBlock": { "additionalProperties": false, "properties": { "key": { "maxLength": 64, "title": "Key", "type": "string" }, "label": { "maxLength": 200, "title": "Label", "type": "string" }, "description": { "default": "", "maxLength": 2000, "title": "Description", "type": "string" }, "required": { "default": false, "title": "Required", "type": "boolean" }, "type": { "const": "field", "title": "Type", "type": "string" }, "field_type": { "enum": [ "text", "long_text", "number", "email", "url", "date", "datetime", "boolean" ], "title": "Field Type", "type": "string" }, "placeholder": { "default": "", "maxLength": 200, "title": "Placeholder", "type": "string" }, "validation": { "$ref": "#/components/schemas/PagesCreateRequestFieldValidation" } }, "required": [ "key", "label", "type", "field_type" ], "title": "PagesCreateRequestFieldBlock", "type": "object" }, "PagesCreateRequestFieldValidation": { "additionalProperties": false, "properties": { "min": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Min" }, "max": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Max" }, "pattern": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "default": null, "title": "Pattern" }, "max_length": { "anyOf": [ { "maximum": 20000, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Max Length" } }, "title": "PagesCreateRequestFieldValidation", "type": "object" }, "PagesCreateRequestHeadingBlock": { "additionalProperties": false, "properties": { "type": { "const": "heading", "title": "Type", "type": "string" }, "text": { "maxLength": 300, "title": "Text", "type": "string" }, "level": { "default": 2, "maximum": 3, "minimum": 1, "title": "Level", "type": "integer" } }, "required": [ "type", "text" ], "title": "PagesCreateRequestHeadingBlock", "type": "object" }, "PagesCreateRequestHtmlDefinition": { "additionalProperties": false, "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "fields": { "items": { "discriminator": { "mapping": { "choice": "#/components/schemas/PagesCreateRequestChoiceBlock", "field": "#/components/schemas/PagesCreateRequestFieldBlock", "upload": "#/components/schemas/PagesCreateRequestUploadBlock" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/PagesCreateRequestFieldBlock" }, { "$ref": "#/components/schemas/PagesCreateRequestChoiceBlock" }, { "$ref": "#/components/schemas/PagesCreateRequestUploadBlock" } ] }, "maxItems": 40, "title": "Fields", "type": "array" }, "submit": { "$ref": "#/components/schemas/PagesCreateRequestSubmitSettings" }, "artifact": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Read-only; the server records size, sha256 and warnings of the stored html here.", "title": "Artifact" } }, "title": "PagesCreateRequestHtmlDefinition", "type": "object" }, "PagesCreateRequestPageDefinition": { "additionalProperties": false, "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "title": { "maxLength": 200, "title": "Title", "type": "string" }, "intro": { "default": "", "maxLength": 20000, "title": "Intro", "type": "string" }, "blocks": { "items": { "discriminator": { "mapping": { "callout": "#/components/schemas/PagesCreateRequestCalloutBlock", "choice": "#/components/schemas/PagesCreateRequestChoiceBlock", "divider": "#/components/schemas/PagesCreateRequestDividerBlock", "download": "#/components/schemas/PagesCreateRequestDownloadBlock", "field": "#/components/schemas/PagesCreateRequestFieldBlock", "heading": "#/components/schemas/PagesCreateRequestHeadingBlock", "table": "#/components/schemas/PagesCreateRequestTableBlock", "text": "#/components/schemas/PagesCreateRequestTextBlock", "upload": "#/components/schemas/PagesCreateRequestUploadBlock" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/PagesCreateRequestHeadingBlock" }, { "$ref": "#/components/schemas/PagesCreateRequestTextBlock" }, { "$ref": "#/components/schemas/PagesCreateRequestCalloutBlock" }, { "$ref": "#/components/schemas/PagesCreateRequestDividerBlock" }, { "$ref": "#/components/schemas/PagesCreateRequestTableBlock" }, { "$ref": "#/components/schemas/PagesCreateRequestDownloadBlock" }, { "$ref": "#/components/schemas/PagesCreateRequestFieldBlock" }, { "$ref": "#/components/schemas/PagesCreateRequestChoiceBlock" }, { "$ref": "#/components/schemas/PagesCreateRequestUploadBlock" } ] }, "maxItems": 60, "title": "Blocks", "type": "array" }, "submit": { "$ref": "#/components/schemas/PagesCreateRequestSubmitSettings" }, "variables": { "items": { "$ref": "#/components/schemas/PagesCreateRequestVariable" }, "maxItems": 20, "title": "Variables", "type": "array" } }, "required": [ "title" ], "title": "PagesCreateRequestPageDefinition", "type": "object" }, "PagesCreateRequestPageSettings": { "additionalProperties": false, "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "locale": { "default": "en", "enum": [ "de", "en", "es" ], "title": "Locale", "type": "string" }, "theme": { "default": "system", "enum": [ "system", "light", "dark" ], "title": "Theme", "type": "string" }, "uploads": { "$ref": "#/components/schemas/PagesCreateRequestUploadSettings" }, "show_brand": { "default": true, "title": "Show Brand", "type": "boolean" } }, "title": "PagesCreateRequestPageSettings", "type": "object" }, "PagesCreateRequestSubmitSettings": { "additionalProperties": false, "properties": { "label": { "default": "Submit", "maxLength": 100, "title": "Label", "type": "string" }, "success_title": { "default": "", "maxLength": 200, "title": "Success Title", "type": "string" }, "success_text": { "default": "", "maxLength": 20000, "title": "Success Text", "type": "string" }, "redirect_url": { "anyOf": [ { "maxLength": 2000, "type": "string" }, { "type": "null" } ], "default": null, "title": "Redirect Url" } }, "title": "PagesCreateRequestSubmitSettings", "type": "object" }, "PagesCreateRequestTableBlock": { "additionalProperties": false, "properties": { "type": { "const": "table", "title": "Type", "type": "string" }, "columns": { "items": { "$ref": "#/components/schemas/PagesCreateRequestTableColumn" }, "maxItems": 20, "minItems": 1, "title": "Columns", "type": "array" }, "rows": { "items": { "items": { "type": "string" }, "type": "array" }, "maxItems": 200, "title": "Rows", "type": "array" } }, "required": [ "type", "columns" ], "title": "PagesCreateRequestTableBlock", "type": "object" }, "PagesCreateRequestTableColumn": { "additionalProperties": false, "properties": { "key": { "maxLength": 64, "title": "Key", "type": "string" }, "label": { "maxLength": 200, "title": "Label", "type": "string" }, "align": { "default": "left", "enum": [ "left", "center", "right" ], "title": "Align", "type": "string" } }, "required": [ "key", "label" ], "title": "PagesCreateRequestTableColumn", "type": "object" }, "PagesCreateRequestTextBlock": { "additionalProperties": false, "properties": { "type": { "const": "text", "title": "Type", "type": "string" }, "markdown": { "maxLength": 20000, "title": "Markdown", "type": "string" } }, "required": [ "type", "markdown" ], "title": "PagesCreateRequestTextBlock", "type": "object" }, "PagesCreateRequestUploadBlock": { "additionalProperties": false, "properties": { "key": { "maxLength": 64, "title": "Key", "type": "string" }, "label": { "maxLength": 200, "title": "Label", "type": "string" }, "description": { "default": "", "maxLength": 2000, "title": "Description", "type": "string" }, "required": { "default": false, "title": "Required", "type": "boolean" }, "type": { "const": "upload", "title": "Type", "type": "string" }, "multiple": { "default": false, "title": "Multiple", "type": "boolean" }, "accept": { "items": { "type": "string" }, "maxItems": 50, "title": "Accept", "type": "array" }, "max_files": { "default": 1, "maximum": 20, "minimum": 1, "title": "Max Files", "type": "integer" }, "max_bytes": { "default": 52428800, "maximum": 52428800, "minimum": 1, "title": "Max Bytes", "type": "integer" } }, "required": [ "key", "label", "type" ], "title": "PagesCreateRequestUploadBlock", "type": "object" }, "PagesCreateRequestUploadSettings": { "additionalProperties": false, "properties": { "folder_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Folder Id" }, "extract": { "default": false, "title": "Extract", "type": "boolean" } }, "title": "PagesCreateRequestUploadSettings", "type": "object" }, "PagesCreateRequestVariable": { "additionalProperties": false, "properties": { "key": { "maxLength": 64, "title": "Key", "type": "string" }, "label": { "default": "", "maxLength": 200, "title": "Label", "type": "string" }, "type": { "default": "text", "enum": [ "text", "number", "boolean" ], "title": "Type", "type": "string" }, "default": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Default" } }, "required": [ "key" ], "title": "PagesCreateRequestVariable", "type": "object" }, "PagesCreateRequest": { "additionalProperties": false, "properties": { "space_id": { "format": "uuid", "title": "Space Id", "type": "string" }, "kind": { "default": "blocks", "enum": [ "blocks", "live_document", "html" ], "title": "Kind", "type": "string" }, "name": { "maxLength": 200, "minLength": 1, "title": "Name", "type": "string" }, "definition": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/PagesCreateRequestPageDefinition" }, { "$ref": "#/components/schemas/PagesCreateRequestHtmlDefinition" } ] }, { "type": "null" } ], "default": null, "description": "Block definition for kind 'blocks'; optional field declaration for kind 'html'.", "title": "Definition" }, "html": { "anyOf": [ { "maxLength": 5242880, "type": "string" }, { "type": "null" } ], "default": null, "description": "Self-contained HTML document (max 5 MiB); required for kind 'html'.", "title": "Html" }, "source_document_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "Native live document (markdown, sheet or database) of the same space; required for kind 'live_document'.", "title": "Source Document Id" }, "settings": { "anyOf": [ { "$ref": "#/components/schemas/PagesCreateRequestPageSettings" }, { "type": "null" } ], "default": null }, "source_metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Source Metadata" } }, "required": [ "space_id", "name" ], "title": "PagesCreateRequest", "type": "object" }, "PagesCreateResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "title": "PagesCreateResponse" }, "PagesGetRequest": { "additionalProperties": false, "properties": {}, "title": "PagesGetRequest", "type": "object" }, "PagesGetResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "title": "PagesGetResponse" }, "PagesUpdateDraftRequestAssetInput": { "additionalProperties": false, "properties": { "key": { "pattern": "^[a-z][a-z0-9_]{0,63}$", "title": "Key", "type": "string" }, "label": { "default": "", "maxLength": 200, "title": "Label", "type": "string" }, "resource_type": { "const": "DOCUMENT", "default": "DOCUMENT", "title": "Resource Type", "type": "string" }, "resource_id": { "format": "uuid", "title": "Resource Id", "type": "string" } }, "required": [ "key", "resource_id" ], "title": "PagesUpdateDraftRequestAssetInput", "type": "object" }, "PagesUpdateDraftRequestCalloutBlock": { "additionalProperties": false, "properties": { "type": { "const": "callout", "title": "Type", "type": "string" }, "tone": { "default": "info", "enum": [ "info", "success", "warning", "danger" ], "title": "Tone", "type": "string" }, "markdown": { "maxLength": 20000, "title": "Markdown", "type": "string" } }, "required": [ "type", "markdown" ], "title": "PagesUpdateDraftRequestCalloutBlock", "type": "object" }, "PagesUpdateDraftRequestChoiceBlock": { "additionalProperties": false, "properties": { "key": { "maxLength": 64, "title": "Key", "type": "string" }, "label": { "maxLength": 200, "title": "Label", "type": "string" }, "description": { "default": "", "maxLength": 2000, "title": "Description", "type": "string" }, "required": { "default": false, "title": "Required", "type": "boolean" }, "type": { "const": "choice", "title": "Type", "type": "string" }, "options": { "items": { "$ref": "#/components/schemas/PagesUpdateDraftRequestChoiceOption" }, "maxItems": 50, "minItems": 1, "title": "Options", "type": "array" }, "multiple": { "default": false, "title": "Multiple", "type": "boolean" }, "display": { "default": "radio", "enum": [ "radio", "select", "buttons" ], "title": "Display", "type": "string" }, "submit_on_select": { "default": false, "title": "Submit On Select", "type": "boolean" } }, "required": [ "key", "label", "type", "options" ], "title": "PagesUpdateDraftRequestChoiceBlock", "type": "object" }, "PagesUpdateDraftRequestChoiceOption": { "additionalProperties": false, "properties": { "key": { "maxLength": 64, "title": "Key", "type": "string" }, "label": { "maxLength": 200, "title": "Label", "type": "string" }, "tone": { "default": "neutral", "enum": [ "neutral", "primary", "destructive" ], "title": "Tone", "type": "string" } }, "required": [ "key", "label" ], "title": "PagesUpdateDraftRequestChoiceOption", "type": "object" }, "PagesUpdateDraftRequestDividerBlock": { "additionalProperties": false, "properties": { "type": { "const": "divider", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "PagesUpdateDraftRequestDividerBlock", "type": "object" }, "PagesUpdateDraftRequestDownloadBlock": { "additionalProperties": false, "properties": { "type": { "const": "download", "title": "Type", "type": "string" }, "asset_key": { "maxLength": 64, "title": "Asset Key", "type": "string" }, "label": { "maxLength": 200, "title": "Label", "type": "string" } }, "required": [ "type", "asset_key", "label" ], "title": "PagesUpdateDraftRequestDownloadBlock", "type": "object" }, "PagesUpdateDraftRequestFieldBlock": { "additionalProperties": false, "properties": { "key": { "maxLength": 64, "title": "Key", "type": "string" }, "label": { "maxLength": 200, "title": "Label", "type": "string" }, "description": { "default": "", "maxLength": 2000, "title": "Description", "type": "string" }, "required": { "default": false, "title": "Required", "type": "boolean" }, "type": { "const": "field", "title": "Type", "type": "string" }, "field_type": { "enum": [ "text", "long_text", "number", "email", "url", "date", "datetime", "boolean" ], "title": "Field Type", "type": "string" }, "placeholder": { "default": "", "maxLength": 200, "title": "Placeholder", "type": "string" }, "validation": { "$ref": "#/components/schemas/PagesUpdateDraftRequestFieldValidation" } }, "required": [ "key", "label", "type", "field_type" ], "title": "PagesUpdateDraftRequestFieldBlock", "type": "object" }, "PagesUpdateDraftRequestFieldValidation": { "additionalProperties": false, "properties": { "min": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Min" }, "max": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Max" }, "pattern": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "default": null, "title": "Pattern" }, "max_length": { "anyOf": [ { "maximum": 20000, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Max Length" } }, "title": "PagesUpdateDraftRequestFieldValidation", "type": "object" }, "PagesUpdateDraftRequestHeadingBlock": { "additionalProperties": false, "properties": { "type": { "const": "heading", "title": "Type", "type": "string" }, "text": { "maxLength": 300, "title": "Text", "type": "string" }, "level": { "default": 2, "maximum": 3, "minimum": 1, "title": "Level", "type": "integer" } }, "required": [ "type", "text" ], "title": "PagesUpdateDraftRequestHeadingBlock", "type": "object" }, "PagesUpdateDraftRequestHtmlDefinition": { "additionalProperties": false, "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "fields": { "items": { "discriminator": { "mapping": { "choice": "#/components/schemas/PagesUpdateDraftRequestChoiceBlock", "field": "#/components/schemas/PagesUpdateDraftRequestFieldBlock", "upload": "#/components/schemas/PagesUpdateDraftRequestUploadBlock" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/PagesUpdateDraftRequestFieldBlock" }, { "$ref": "#/components/schemas/PagesUpdateDraftRequestChoiceBlock" }, { "$ref": "#/components/schemas/PagesUpdateDraftRequestUploadBlock" } ] }, "maxItems": 40, "title": "Fields", "type": "array" }, "submit": { "$ref": "#/components/schemas/PagesUpdateDraftRequestSubmitSettings" }, "artifact": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Read-only; the server records size, sha256 and warnings of the stored html here.", "title": "Artifact" } }, "title": "PagesUpdateDraftRequestHtmlDefinition", "type": "object" }, "PagesUpdateDraftRequestPageDefinition": { "additionalProperties": false, "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "title": { "maxLength": 200, "title": "Title", "type": "string" }, "intro": { "default": "", "maxLength": 20000, "title": "Intro", "type": "string" }, "blocks": { "items": { "discriminator": { "mapping": { "callout": "#/components/schemas/PagesUpdateDraftRequestCalloutBlock", "choice": "#/components/schemas/PagesUpdateDraftRequestChoiceBlock", "divider": "#/components/schemas/PagesUpdateDraftRequestDividerBlock", "download": "#/components/schemas/PagesUpdateDraftRequestDownloadBlock", "field": "#/components/schemas/PagesUpdateDraftRequestFieldBlock", "heading": "#/components/schemas/PagesUpdateDraftRequestHeadingBlock", "table": "#/components/schemas/PagesUpdateDraftRequestTableBlock", "text": "#/components/schemas/PagesUpdateDraftRequestTextBlock", "upload": "#/components/schemas/PagesUpdateDraftRequestUploadBlock" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/PagesUpdateDraftRequestHeadingBlock" }, { "$ref": "#/components/schemas/PagesUpdateDraftRequestTextBlock" }, { "$ref": "#/components/schemas/PagesUpdateDraftRequestCalloutBlock" }, { "$ref": "#/components/schemas/PagesUpdateDraftRequestDividerBlock" }, { "$ref": "#/components/schemas/PagesUpdateDraftRequestTableBlock" }, { "$ref": "#/components/schemas/PagesUpdateDraftRequestDownloadBlock" }, { "$ref": "#/components/schemas/PagesUpdateDraftRequestFieldBlock" }, { "$ref": "#/components/schemas/PagesUpdateDraftRequestChoiceBlock" }, { "$ref": "#/components/schemas/PagesUpdateDraftRequestUploadBlock" } ] }, "maxItems": 60, "title": "Blocks", "type": "array" }, "submit": { "$ref": "#/components/schemas/PagesUpdateDraftRequestSubmitSettings" }, "variables": { "items": { "$ref": "#/components/schemas/PagesUpdateDraftRequestVariable" }, "maxItems": 20, "title": "Variables", "type": "array" } }, "required": [ "title" ], "title": "PagesUpdateDraftRequestPageDefinition", "type": "object" }, "PagesUpdateDraftRequestPageSettings": { "additionalProperties": false, "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "locale": { "default": "en", "enum": [ "de", "en", "es" ], "title": "Locale", "type": "string" }, "theme": { "default": "system", "enum": [ "system", "light", "dark" ], "title": "Theme", "type": "string" }, "uploads": { "$ref": "#/components/schemas/PagesUpdateDraftRequestUploadSettings" }, "show_brand": { "default": true, "title": "Show Brand", "type": "boolean" } }, "title": "PagesUpdateDraftRequestPageSettings", "type": "object" }, "PagesUpdateDraftRequestSubmitSettings": { "additionalProperties": false, "properties": { "label": { "default": "Submit", "maxLength": 100, "title": "Label", "type": "string" }, "success_title": { "default": "", "maxLength": 200, "title": "Success Title", "type": "string" }, "success_text": { "default": "", "maxLength": 20000, "title": "Success Text", "type": "string" }, "redirect_url": { "anyOf": [ { "maxLength": 2000, "type": "string" }, { "type": "null" } ], "default": null, "title": "Redirect Url" } }, "title": "PagesUpdateDraftRequestSubmitSettings", "type": "object" }, "PagesUpdateDraftRequestTableBlock": { "additionalProperties": false, "properties": { "type": { "const": "table", "title": "Type", "type": "string" }, "columns": { "items": { "$ref": "#/components/schemas/PagesUpdateDraftRequestTableColumn" }, "maxItems": 20, "minItems": 1, "title": "Columns", "type": "array" }, "rows": { "items": { "items": { "type": "string" }, "type": "array" }, "maxItems": 200, "title": "Rows", "type": "array" } }, "required": [ "type", "columns" ], "title": "PagesUpdateDraftRequestTableBlock", "type": "object" }, "PagesUpdateDraftRequestTableColumn": { "additionalProperties": false, "properties": { "key": { "maxLength": 64, "title": "Key", "type": "string" }, "label": { "maxLength": 200, "title": "Label", "type": "string" }, "align": { "default": "left", "enum": [ "left", "center", "right" ], "title": "Align", "type": "string" } }, "required": [ "key", "label" ], "title": "PagesUpdateDraftRequestTableColumn", "type": "object" }, "PagesUpdateDraftRequestTextBlock": { "additionalProperties": false, "properties": { "type": { "const": "text", "title": "Type", "type": "string" }, "markdown": { "maxLength": 20000, "title": "Markdown", "type": "string" } }, "required": [ "type", "markdown" ], "title": "PagesUpdateDraftRequestTextBlock", "type": "object" }, "PagesUpdateDraftRequestUploadBlock": { "additionalProperties": false, "properties": { "key": { "maxLength": 64, "title": "Key", "type": "string" }, "label": { "maxLength": 200, "title": "Label", "type": "string" }, "description": { "default": "", "maxLength": 2000, "title": "Description", "type": "string" }, "required": { "default": false, "title": "Required", "type": "boolean" }, "type": { "const": "upload", "title": "Type", "type": "string" }, "multiple": { "default": false, "title": "Multiple", "type": "boolean" }, "accept": { "items": { "type": "string" }, "maxItems": 50, "title": "Accept", "type": "array" }, "max_files": { "default": 1, "maximum": 20, "minimum": 1, "title": "Max Files", "type": "integer" }, "max_bytes": { "default": 52428800, "maximum": 52428800, "minimum": 1, "title": "Max Bytes", "type": "integer" } }, "required": [ "key", "label", "type" ], "title": "PagesUpdateDraftRequestUploadBlock", "type": "object" }, "PagesUpdateDraftRequestUploadSettings": { "additionalProperties": false, "properties": { "folder_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Folder Id" }, "extract": { "default": false, "title": "Extract", "type": "boolean" } }, "title": "PagesUpdateDraftRequestUploadSettings", "type": "object" }, "PagesUpdateDraftRequestVariable": { "additionalProperties": false, "properties": { "key": { "maxLength": 64, "title": "Key", "type": "string" }, "label": { "default": "", "maxLength": 200, "title": "Label", "type": "string" }, "type": { "default": "text", "enum": [ "text", "number", "boolean" ], "title": "Type", "type": "string" }, "default": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Default" } }, "required": [ "key" ], "title": "PagesUpdateDraftRequestVariable", "type": "object" }, "PagesUpdateDraftRequest": { "additionalProperties": false, "properties": { "name": { "anyOf": [ { "maxLength": 200, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "definition": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/PagesUpdateDraftRequestPageDefinition" }, { "$ref": "#/components/schemas/PagesUpdateDraftRequestHtmlDefinition" } ] }, { "type": "null" } ], "default": null, "title": "Definition" }, "html": { "anyOf": [ { "maxLength": 5242880, "type": "string" }, { "type": "null" } ], "default": null, "description": "Replaces the HTML draft (kind 'html').", "title": "Html" }, "settings": { "anyOf": [ { "$ref": "#/components/schemas/PagesUpdateDraftRequestPageSettings" }, { "type": "null" } ], "default": null }, "assets": { "anyOf": [ { "items": { "$ref": "#/components/schemas/PagesUpdateDraftRequestAssetInput" }, "maxItems": 10, "type": "array" }, { "type": "null" } ], "default": null, "description": "Replaces the draft's download bindings (key -> document of the space). Omit to keep them, send [] to clear.", "title": "Assets" }, "expected_updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "updated_at from pages.get; rejects lost updates.", "title": "Expected Updated At" } }, "title": "PagesUpdateDraftRequest", "type": "object" }, "PagesUpdateDraftResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "title": "PagesUpdateDraftResponse" }, "PagesPublishRequest": { "additionalProperties": false, "properties": {}, "title": "PagesPublishRequest", "type": "object" }, "PagesPublishResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "title": "PagesPublishResponse" }, "PagesHtmlGetRequest": { "additionalProperties": false, "properties": { "version_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "Published version; omitted for the current draft.", "title": "Version Id" } }, "title": "PagesHtmlGetRequest", "type": "object" }, "PagesHtmlGetResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "title": "PagesHtmlGetResponse" }, "PagesVersionsListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, "title": "PagesVersionsListRequest", "type": "object" }, "PagesVersionsListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object" } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "title": "PagesVersionsListResponse" }, "PagesArchiveRequest": { "additionalProperties": false, "properties": {}, "title": "PagesArchiveRequest", "type": "object" }, "PagesArchiveResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "title": "PagesArchiveResponse" }, "PagesDeleteRequest": { "additionalProperties": false, "properties": {}, "title": "PagesDeleteRequest", "type": "object" }, "PagesDeleteResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "title": "PagesDeleteResponse" }, "PagesAssetsSetRequestAssetInput": { "additionalProperties": false, "properties": { "key": { "pattern": "^[a-z][a-z0-9_]{0,63}$", "title": "Key", "type": "string" }, "label": { "default": "", "maxLength": 200, "title": "Label", "type": "string" }, "resource_type": { "const": "DOCUMENT", "default": "DOCUMENT", "title": "Resource Type", "type": "string" }, "resource_id": { "format": "uuid", "title": "Resource Id", "type": "string" } }, "required": [ "key", "resource_id" ], "title": "PagesAssetsSetRequestAssetInput", "type": "object" }, "PagesAssetsSetRequest": { "additionalProperties": false, "properties": { "assets": { "items": { "$ref": "#/components/schemas/PagesAssetsSetRequestAssetInput" }, "maxItems": 10, "title": "Assets", "type": "array" } }, "title": "PagesAssetsSetRequest", "type": "object" }, "PagesAssetsSetResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "title": "PagesAssetsSetResponse" }, "PagesLinksListRequest": { "additionalProperties": false, "properties": { "status": { "anyOf": [ { "enum": [ "ACTIVE", "DISABLED", "REVOKED" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "limit": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, "title": "PagesLinksListRequest", "type": "object" }, "PagesLinksListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object" } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "title": "PagesLinksListResponse" }, "PagesLinksCreateRequestLinkContext": { "additionalProperties": false, "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "values": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "boolean" } ] }, "maxProperties": 20, "title": "Values", "type": "object" } }, "title": "PagesLinksCreateRequestLinkContext", "type": "object" }, "PagesLinksCreateRequestLinkPermissions": { "additionalProperties": false, "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "live": { "default": "read", "enum": [ "read", "write" ], "title": "Live", "type": "string" }, "download": { "default": true, "title": "Download", "type": "boolean" } }, "title": "PagesLinksCreateRequestLinkPermissions", "type": "object" }, "PagesLinksCreateRequest": { "additionalProperties": false, "properties": { "label": { "default": "", "maxLength": 200, "title": "Label", "type": "string" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 date-time.", "title": "Expires At" }, "max_visits": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Max Visits" }, "password": { "anyOf": [ { "maxLength": 200, "minLength": 4, "type": "string" }, { "type": "null" } ], "default": null, "title": "Password", "writeOnly": true }, "access_mode": { "default": "ANONYMOUS", "enum": [ "ANONYMOUS", "EMAIL", "EMAIL_VERIFIED" ], "title": "Access Mode", "type": "string" }, "allowed_emails": { "items": { "type": "string" }, "maxItems": 200, "title": "Allowed Emails", "type": "array" }, "allowed_domains": { "items": { "type": "string" }, "maxItems": 200, "title": "Allowed Domains", "type": "array" }, "submission_mode": { "default": "MULTIPLE", "enum": [ "NONE", "SINGLE", "MULTIPLE" ], "title": "Submission Mode", "type": "string" }, "locale": { "anyOf": [ { "enum": [ "de", "en", "es" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "permissions": { "anyOf": [ { "$ref": "#/components/schemas/PagesLinksCreateRequestLinkPermissions" }, { "type": "null" } ], "default": null }, "context": { "anyOf": [ { "$ref": "#/components/schemas/PagesLinksCreateRequestLinkContext" }, { "type": "null" } ], "default": null, "description": "Values for the definition's variables, frozen into this link." }, "source_metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Source Metadata" } }, "title": "PagesLinksCreateRequest", "type": "object" }, "PagesLinksCreateResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "title": "PagesLinksCreateResponse" }, "PagesLinksGetRequest": { "additionalProperties": false, "properties": {}, "title": "PagesLinksGetRequest", "type": "object" }, "PagesLinksGetResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "title": "PagesLinksGetResponse" }, "PagesLinksUpdateRequestLinkPermissions": { "additionalProperties": false, "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "live": { "default": "read", "enum": [ "read", "write" ], "title": "Live", "type": "string" }, "download": { "default": true, "title": "Download", "type": "boolean" } }, "title": "PagesLinksUpdateRequestLinkPermissions", "type": "object" }, "PagesLinksUpdateRequest": { "additionalProperties": false, "properties": { "label": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "default": null, "title": "Label" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Expires At" }, "max_visits": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Max Visits" }, "password": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "New password; null clears the password gate.", "title": "Password", "writeOnly": true }, "access_mode": { "anyOf": [ { "enum": [ "ANONYMOUS", "EMAIL", "EMAIL_VERIFIED" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Access Mode" }, "allowed_emails": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Allowed Emails" }, "allowed_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Allowed Domains" }, "submission_mode": { "anyOf": [ { "enum": [ "NONE", "SINGLE", "MULTIPLE" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Submission Mode" }, "locale": { "anyOf": [ { "enum": [ "de", "en", "es" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "permissions": { "anyOf": [ { "$ref": "#/components/schemas/PagesLinksUpdateRequestLinkPermissions" }, { "type": "null" } ], "default": null }, "status": { "anyOf": [ { "enum": [ "ACTIVE", "DISABLED" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" } }, "title": "PagesLinksUpdateRequest", "type": "object" }, "PagesLinksUpdateResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "title": "PagesLinksUpdateResponse" }, "PagesLinksRotateRequest": { "additionalProperties": false, "properties": {}, "title": "PagesLinksRotateRequest", "type": "object" }, "PagesLinksRotateResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "title": "PagesLinksRotateResponse" }, "PagesLinksRetargetRequest": { "additionalProperties": false, "properties": { "page_version_id": { "format": "uuid", "title": "Page Version Id", "type": "string" } }, "required": [ "page_version_id" ], "title": "PagesLinksRetargetRequest", "type": "object" }, "PagesLinksRetargetResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "title": "PagesLinksRetargetResponse" }, "PagesLinksRevokeRequest": { "additionalProperties": false, "properties": {}, "title": "PagesLinksRevokeRequest", "type": "object" }, "PagesLinksRevokeResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "title": "PagesLinksRevokeResponse" }, "PagesSubmissionsListRequest": { "additionalProperties": false, "properties": { "link_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "title": "Link Id" }, "status": { "anyOf": [ { "enum": [ "RECEIVED", "PROCESSING", "PROCESSED", "FAILED" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "limit": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, "title": "PagesSubmissionsListRequest", "type": "object" }, "PagesSubmissionsListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object" } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "title": "PagesSubmissionsListResponse" }, "PagesSubmissionsGetRequest": { "additionalProperties": false, "properties": {}, "title": "PagesSubmissionsGetRequest", "type": "object" }, "PagesSubmissionsGetResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "title": "PagesSubmissionsGetResponse" }, "PagesSubmissionsSetStatusRequest": { "additionalProperties": false, "properties": { "status": { "enum": [ "RECEIVED", "PROCESSING", "PROCESSED", "FAILED" ], "title": "Status", "type": "string" }, "failure_code": { "default": "", "maxLength": 80, "title": "Failure Code", "type": "string" } }, "required": [ "status" ], "title": "PagesSubmissionsSetStatusRequest", "type": "object" }, "PagesSubmissionsSetStatusResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "title": "PagesSubmissionsSetStatusResponse" }, "PagesStatsRequest": { "additionalProperties": false, "properties": { "link_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "title": "Link Id" }, "days": { "default": 30, "description": "Window ending today (UTC).", "maximum": 365, "minimum": 1, "title": "Days", "type": "integer" } }, "title": "PagesStatsRequest", "type": "object" }, "PagesStatsResponse": { "type": "object", "additionalProperties": true, "description": "Operation-specific resource fields.", "title": "PagesStatsResponse" }, "PagesVisitsListRequest": { "additionalProperties": false, "properties": { "link_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "title": "Link Id" }, "limit": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." } }, "title": "PagesVisitsListRequest", "type": "object" }, "PagesVisitsListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object" } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "title": "PagesVisitsListResponse" }, "IntegrationsCatalogListRequest": { "type": "object", "properties": { "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, "additionalProperties": false, "title": "IntegrationsCatalogListRequest" }, "IntegrationsCatalogListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "contract_digest": { "type": "string" }, "display_name": { "type": "string" }, "description": { "type": "string" }, "category": { "type": "string" }, "icon_key": { "type": "string" }, "auth_schemes": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "strategy": { "type": "string" }, "public_config_schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "credential_schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "ui_schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "form_contract": { "type": "object", "properties": { "profile_version": { "type": "string" }, "public_config": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "credential": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } }, "required": [ "profile_version", "public_config" ], "additionalProperties": false } }, "required": [ "key", "strategy", "public_config_schema", "credential_schema", "ui_schema", "form_contract" ], "additionalProperties": false } }, "operations": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "resource": { "type": "string" }, "operation": { "type": "string" }, "description": { "type": "string" }, "input_schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "output_schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "effect": { "type": "string" }, "execution_mode": { "type": "string" }, "risk_level": { "type": "string" }, "requires_space": { "type": "boolean" }, "timeout_seconds": { "type": "integer" }, "max_retries": { "type": "integer" }, "rate_limit_requests": { "type": "integer" }, "rate_limit_window_seconds": { "type": "integer" }, "max_payload_bytes": { "type": "integer" }, "audit_fields": { "type": "array", "items": { "type": "string" } }, "value_sources": { "type": "object", "properties": {}, "required": [], "additionalProperties": { "type": "object", "properties": { "operation": { "type": "string" }, "name_field": { "type": "string" } }, "required": [ "operation", "name_field" ], "additionalProperties": false } }, "credits_per_call": { "type": [ "number", "null" ] } }, "required": [ "key", "resource", "operation", "description", "input_schema", "output_schema", "effect", "execution_mode", "risk_level", "requires_space", "timeout_seconds", "max_retries", "rate_limit_requests", "rate_limit_window_seconds", "max_payload_bytes", "audit_fields", "value_sources" ], "additionalProperties": false } } }, "required": [ "key", "contract_digest", "display_name", "description", "category", "icon_key", "auth_schemes", "operations" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "additionalProperties": false, "title": "IntegrationsCatalogListResponse" }, "IntegrationsCatalogGetRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "IntegrationsCatalogGetRequest" }, "IntegrationsCatalogGetResponse": { "type": "object", "properties": { "key": { "type": "string" }, "contract_digest": { "type": "string" }, "display_name": { "type": "string" }, "description": { "type": "string" }, "category": { "type": "string" }, "icon_key": { "type": "string" }, "auth_schemes": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "strategy": { "type": "string" }, "public_config_schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "credential_schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "ui_schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "form_contract": { "type": "object", "properties": { "profile_version": { "type": "string" }, "public_config": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "credential": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } }, "required": [ "profile_version", "public_config" ], "additionalProperties": false } }, "required": [ "key", "strategy", "public_config_schema", "credential_schema", "ui_schema", "form_contract" ], "additionalProperties": false } }, "operations": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "resource": { "type": "string" }, "operation": { "type": "string" }, "description": { "type": "string" }, "input_schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "output_schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "effect": { "type": "string" }, "execution_mode": { "type": "string" }, "risk_level": { "type": "string" }, "requires_space": { "type": "boolean" }, "timeout_seconds": { "type": "integer" }, "max_retries": { "type": "integer" }, "rate_limit_requests": { "type": "integer" }, "rate_limit_window_seconds": { "type": "integer" }, "max_payload_bytes": { "type": "integer" }, "audit_fields": { "type": "array", "items": { "type": "string" } }, "value_sources": { "type": "object", "properties": {}, "required": [], "additionalProperties": { "type": "object", "properties": { "operation": { "type": "string" }, "name_field": { "type": "string" } }, "required": [ "operation", "name_field" ], "additionalProperties": false } }, "credits_per_call": { "type": [ "number", "null" ] } }, "required": [ "key", "resource", "operation", "description", "input_schema", "output_schema", "effect", "execution_mode", "risk_level", "requires_space", "timeout_seconds", "max_retries", "rate_limit_requests", "rate_limit_window_seconds", "max_payload_bytes", "audit_fields", "value_sources" ], "additionalProperties": false } } }, "required": [ "key", "contract_digest", "display_name", "description", "category", "icon_key", "auth_schemes", "operations" ], "additionalProperties": false, "title": "IntegrationsCatalogGetResponse" }, "IntegrationsFoundationStatusRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "IntegrationsFoundationStatusRequest" }, "IntegrationsFoundationStatusResponse": { "type": "object", "properties": { "status": { "type": "string" }, "generated_at": { "type": "string" }, "build_revision": { "type": "string" }, "artifact_digests": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "gates": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "passed": { "type": "boolean" }, "reason": { "type": "string" } }, "required": [ "key", "passed", "reason" ], "additionalProperties": false } } }, "required": [ "status", "generated_at", "build_revision", "artifact_digests", "gates" ], "additionalProperties": false, "title": "IntegrationsFoundationStatusResponse" }, "IntegrationsConnectionsListRequest": { "type": "object", "properties": { "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, "additionalProperties": false, "title": "IntegrationsConnectionsListRequest" }, "IntegrationsConnectionsListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "provider_key": { "type": "string" }, "auth_scheme": { "type": "string" }, "label": { "type": "string" }, "external_identity": { "type": "string" }, "public_config": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "status": { "type": "string" }, "enabled": { "type": "boolean" }, "safe_error_code": { "type": "string" }, "test_summary": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "provider_contract_digest": { "type": "string" }, "last_tested_at": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "last_used_at": { "type": [ "string", "null" ] }, "usage_count_30d": { "type": "integer" }, "error_count_30d": { "type": "integer" }, "grant_count": { "type": "integer" } }, "required": [ "id", "provider_key", "auth_scheme", "label", "external_identity", "public_config", "status", "enabled", "safe_error_code", "test_summary", "provider_contract_digest", "last_tested_at", "created_at", "updated_at" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "additionalProperties": false, "title": "IntegrationsConnectionsListResponse" }, "IntegrationsConnectionsCreateRequest": { "type": "object", "properties": { "provider_key": { "type": "string" }, "label": { "type": "string" }, "public_config": { "type": "object" }, "credentials": { "type": "object", "writeOnly": true } }, "required": [ "provider_key", "label", "credentials" ], "additionalProperties": false, "title": "IntegrationsConnectionsCreateRequest" }, "IntegrationsConnectionsCreateResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "provider_key": { "type": "string" }, "auth_scheme": { "type": "string" }, "label": { "type": "string" }, "external_identity": { "type": "string" }, "public_config": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "status": { "type": "string" }, "enabled": { "type": "boolean" }, "safe_error_code": { "type": "string" }, "test_summary": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "provider_contract_digest": { "type": "string" }, "last_tested_at": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "last_used_at": { "type": [ "string", "null" ] }, "usage_count_30d": { "type": "integer" }, "error_count_30d": { "type": "integer" }, "grant_count": { "type": "integer" } }, "required": [ "id", "provider_key", "auth_scheme", "label", "external_identity", "public_config", "status", "enabled", "safe_error_code", "test_summary", "provider_contract_digest", "last_tested_at", "created_at", "updated_at" ], "additionalProperties": false, "title": "IntegrationsConnectionsCreateResponse" }, "IntegrationsConnectionsGetRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "IntegrationsConnectionsGetRequest" }, "IntegrationsConnectionsGetResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "provider_key": { "type": "string" }, "auth_scheme": { "type": "string" }, "label": { "type": "string" }, "external_identity": { "type": "string" }, "public_config": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "status": { "type": "string" }, "enabled": { "type": "boolean" }, "safe_error_code": { "type": "string" }, "test_summary": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "provider_contract_digest": { "type": "string" }, "last_tested_at": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "last_used_at": { "type": [ "string", "null" ] }, "usage_count_30d": { "type": "integer" }, "error_count_30d": { "type": "integer" }, "grant_count": { "type": "integer" } }, "required": [ "id", "provider_key", "auth_scheme", "label", "external_identity", "public_config", "status", "enabled", "safe_error_code", "test_summary", "provider_contract_digest", "last_tested_at", "created_at", "updated_at" ], "additionalProperties": false, "title": "IntegrationsConnectionsGetResponse" }, "IntegrationsConnectionsUpdateRequest": { "type": "object", "properties": { "label": { "type": "string" }, "public_config": { "type": "object" }, "enabled": { "type": "boolean" } }, "additionalProperties": false, "title": "IntegrationsConnectionsUpdateRequest" }, "IntegrationsConnectionsUpdateResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "provider_key": { "type": "string" }, "auth_scheme": { "type": "string" }, "label": { "type": "string" }, "external_identity": { "type": "string" }, "public_config": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "status": { "type": "string" }, "enabled": { "type": "boolean" }, "safe_error_code": { "type": "string" }, "test_summary": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "provider_contract_digest": { "type": "string" }, "last_tested_at": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "last_used_at": { "type": [ "string", "null" ] }, "usage_count_30d": { "type": "integer" }, "error_count_30d": { "type": "integer" }, "grant_count": { "type": "integer" } }, "required": [ "id", "provider_key", "auth_scheme", "label", "external_identity", "public_config", "status", "enabled", "safe_error_code", "test_summary", "provider_contract_digest", "last_tested_at", "created_at", "updated_at" ], "additionalProperties": false, "title": "IntegrationsConnectionsUpdateResponse" }, "IntegrationsConnectionsCredentialsRotateRequest": { "type": "object", "properties": { "credentials": { "type": "object", "writeOnly": true } }, "required": [ "credentials" ], "additionalProperties": false, "title": "IntegrationsConnectionsCredentialsRotateRequest" }, "IntegrationsConnectionsCredentialsRotateResponse": { "type": "object", "properties": { "connection_id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" } }, "required": [ "connection_id", "version" ], "additionalProperties": false, "title": "IntegrationsConnectionsCredentialsRotateResponse" }, "IntegrationsConnectionsTestRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "IntegrationsConnectionsTestRequest" }, "IntegrationsConnectionsTestResponse": { "type": "object", "properties": { "connection_id": { "type": "string", "format": "uuid" }, "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" } }, "required": [ "connection_id", "invocation_id", "status" ], "additionalProperties": false, "title": "IntegrationsConnectionsTestResponse" }, "IntegrationsConnectionsDisconnectRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "IntegrationsConnectionsDisconnectRequest" }, "IntegrationsConnectionsDisconnectResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "provider_key": { "type": "string" }, "auth_scheme": { "type": "string" }, "label": { "type": "string" }, "external_identity": { "type": "string" }, "public_config": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "status": { "type": "string" }, "enabled": { "type": "boolean" }, "safe_error_code": { "type": "string" }, "test_summary": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "provider_contract_digest": { "type": "string" }, "last_tested_at": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "last_used_at": { "type": [ "string", "null" ] }, "usage_count_30d": { "type": "integer" }, "error_count_30d": { "type": "integer" }, "grant_count": { "type": "integer" } }, "required": [ "id", "provider_key", "auth_scheme", "label", "external_identity", "public_config", "status", "enabled", "safe_error_code", "test_summary", "provider_contract_digest", "last_tested_at", "created_at", "updated_at" ], "additionalProperties": false, "title": "IntegrationsConnectionsDisconnectResponse" }, "IntegrationsConnectionsDeleteRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "IntegrationsConnectionsDeleteRequest" }, "IntegrationsConnectionsDeleteResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "deleted": { "type": "boolean" } }, "required": [ "id", "deleted" ], "additionalProperties": false, "title": "IntegrationsConnectionsDeleteResponse" }, "IntegrationsConnectionsUsageRequest": { "type": "object", "properties": { "connection_id": { "type": "string", "format": "uuid" }, "connection_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "days": { "type": "integer", "minimum": 1, "maximum": 90 } }, "additionalProperties": false, "title": "IntegrationsConnectionsUsageRequest" }, "IntegrationsConnectionsUsageResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "connection_id": { "type": "string", "format": "uuid" }, "series": { "type": "array", "items": { "type": "object", "properties": { "day": { "type": "string" }, "count": { "type": "integer" }, "errors": { "type": "integer" } }, "required": [ "day", "count", "errors" ], "additionalProperties": false } } }, "required": [ "connection_id", "series" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false, "title": "IntegrationsConnectionsUsageResponse" }, "IntegrationsConnectionsDependenciesRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "IntegrationsConnectionsDependenciesRequest" }, "IntegrationsConnectionsDependenciesResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "consumer": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "space_id": { "type": [ "string", "null" ] } }, "required": [ "consumer", "id", "name", "space_id" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false, "title": "IntegrationsConnectionsDependenciesResponse" }, "IntegrationsAuthorizationsBeginRequest": { "type": "object", "properties": { "provider_key": { "type": "string" }, "auth_scheme": { "type": "string" }, "label": { "type": "string" }, "public_config": { "type": "object" }, "credentials": { "type": "object", "writeOnly": true }, "redirect_key": { "type": "string" }, "target_connection_id": { "type": "string", "format": "uuid" } }, "required": [ "provider_key", "auth_scheme", "label" ], "additionalProperties": false, "title": "IntegrationsAuthorizationsBeginRequest" }, "IntegrationsAuthorizationsBeginResponse": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid" }, "expires_at": { "type": "string" }, "authorization_url": { "type": "string" }, "connection": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "provider_key": { "type": "string" }, "auth_scheme": { "type": "string" }, "label": { "type": "string" }, "external_identity": { "type": "string" }, "public_config": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "status": { "type": "string" }, "enabled": { "type": "boolean" }, "safe_error_code": { "type": "string" }, "test_summary": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "provider_contract_digest": { "type": "string" }, "last_tested_at": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "last_used_at": { "type": [ "string", "null" ] }, "usage_count_30d": { "type": "integer" }, "error_count_30d": { "type": "integer" }, "grant_count": { "type": "integer" } }, "required": [ "id", "provider_key", "auth_scheme", "label", "external_identity", "public_config", "status", "enabled", "safe_error_code", "test_summary", "provider_contract_digest", "last_tested_at", "created_at", "updated_at" ], "additionalProperties": false }, "status": { "type": "string" } }, "required": [], "additionalProperties": false, "oneOf": [ { "required": [ "connection" ] }, { "required": [ "session_id", "expires_at" ] } ], "title": "IntegrationsAuthorizationsBeginResponse" }, "IntegrationsAuthorizationsStatusRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "IntegrationsAuthorizationsStatusRequest" }, "IntegrationsAuthorizationsStatusResponse": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "expires_at": { "type": "string" } }, "required": [ "session_id", "status", "expires_at" ], "additionalProperties": false, "title": "IntegrationsAuthorizationsStatusResponse" }, "IntegrationsAuthorizationsCancelRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "IntegrationsAuthorizationsCancelRequest" }, "IntegrationsAuthorizationsCancelResponse": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "expires_at": { "type": "string" } }, "required": [ "session_id", "status", "expires_at" ], "additionalProperties": false, "title": "IntegrationsAuthorizationsCancelResponse" }, "IntegrationsGrantsListRequest": { "type": "object", "properties": { "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, "additionalProperties": false, "title": "IntegrationsGrantsListRequest" }, "IntegrationsGrantsListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "connection_id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "allowed_operations": { "type": "array", "items": { "type": "string" } }, "safe_constraints": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "status": { "type": "string" }, "provider_contract_digest": { "type": "string" }, "risk_acknowledgements": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "requires_reapproval": { "type": "boolean" }, "contract_current": { "type": "boolean" } }, "required": [ "id", "connection_id", "space_id", "allowed_operations", "safe_constraints", "status", "provider_contract_digest", "risk_acknowledgements", "requires_reapproval", "contract_current" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "additionalProperties": false, "title": "IntegrationsGrantsListResponse" }, "IntegrationsGrantsCreateRequest": { "type": "object", "properties": { "connection_id": { "type": "string", "format": "uuid" }, "space_id": { "type": "string", "format": "uuid" }, "allowed_operations": { "type": "array", "items": { "type": "string" } }, "safe_constraints": { "type": "object" }, "risk_acknowledgements": { "type": "object" } }, "required": [ "connection_id", "space_id", "allowed_operations" ], "additionalProperties": false, "title": "IntegrationsGrantsCreateRequest" }, "IntegrationsGrantsCreateResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string" } }, "required": [ "id", "status" ], "additionalProperties": false, "title": "IntegrationsGrantsCreateResponse" }, "IntegrationsGrantsUpdateRequest": { "type": "object", "properties": { "allowed_operations": { "type": "array", "items": { "type": "string" } }, "safe_constraints": { "type": "object" }, "risk_acknowledgements": { "type": "object" } }, "additionalProperties": false, "title": "IntegrationsGrantsUpdateRequest" }, "IntegrationsGrantsUpdateResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string" } }, "required": [ "id", "status" ], "additionalProperties": false, "title": "IntegrationsGrantsUpdateResponse" }, "IntegrationsGrantsRevokeRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "IntegrationsGrantsRevokeRequest" }, "IntegrationsGrantsRevokeResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string" } }, "required": [ "id", "status" ], "additionalProperties": false, "title": "IntegrationsGrantsRevokeResponse" }, "IntegrationsAuditListRequest": { "type": "object", "properties": { "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, "additionalProperties": false, "title": "IntegrationsAuditListRequest" }, "IntegrationsAuditListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "connection_id": { "type": [ "string", "null" ], "format": "uuid" }, "provider_key": { "type": "string" }, "event_type": { "type": "string" }, "safe_details": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "origin": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "connection_id", "provider_key", "event_type", "safe_details", "origin", "created_at" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "additionalProperties": false, "title": "IntegrationsAuditListResponse" }, "IntegrationsInvocationsListRequest": { "type": "object", "properties": { "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, "additionalProperties": false, "title": "IntegrationsInvocationsListRequest" }, "IntegrationsInvocationsListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "connection_id": { "type": [ "string", "null" ] }, "provider_key": { "type": "string" }, "operation_key": { "type": "string" }, "source": { "type": "string" }, "effect": { "type": "string" }, "execution_mode": { "type": "string" }, "status": { "type": "string" }, "safe_error_code": { "type": "string" }, "safe_summary": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "item_count": { "type": "integer" }, "byte_count": { "type": "integer" }, "retry_count": { "type": "integer" }, "actor": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "space_id": { "type": [ "string", "null" ] }, "consumer_kind": { "type": "string" }, "consumer_id": { "type": "string" }, "change_set_id": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "completed_at": { "type": [ "string", "null" ] } }, "required": [ "id", "connection_id", "provider_key", "operation_key", "source", "effect", "execution_mode", "status", "safe_error_code", "safe_summary", "item_count", "byte_count", "retry_count", "actor", "space_id", "consumer_kind", "consumer_id", "change_set_id", "created_at", "completed_at" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "additionalProperties": false, "title": "IntegrationsInvocationsListResponse" }, "IntegrationsInvocationsGetRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "IntegrationsInvocationsGetRequest" }, "IntegrationsInvocationsGetResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "connection_id": { "type": [ "string", "null" ] }, "provider_key": { "type": "string" }, "operation_key": { "type": "string" }, "source": { "type": "string" }, "effect": { "type": "string" }, "execution_mode": { "type": "string" }, "status": { "type": "string" }, "safe_error_code": { "type": "string" }, "safe_summary": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "item_count": { "type": "integer" }, "byte_count": { "type": "integer" }, "retry_count": { "type": "integer" }, "actor": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "space_id": { "type": [ "string", "null" ] }, "consumer_kind": { "type": "string" }, "consumer_id": { "type": "string" }, "change_set_id": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "completed_at": { "type": [ "string", "null" ] }, "output": { "type": [ "object", "null" ] } }, "required": [ "id", "connection_id", "provider_key", "operation_key", "source", "effect", "execution_mode", "status", "safe_error_code", "safe_summary", "item_count", "byte_count", "retry_count", "actor", "space_id", "consumer_kind", "consumer_id", "change_set_id", "created_at", "completed_at", "output" ], "additionalProperties": false, "title": "IntegrationsInvocationsGetResponse" }, "UsersMeRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "UsersMeRequest" }, "UsersMeResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string", "format": "email", "maxLength": 254 }, "name": { "type": "string", "maxLength": 200 }, "image_url": { "type": "string", "format": "uri" }, "role": { "enum": [ "ADMIN", "MEMBER" ], "type": "string" }, "locale": { "enum": [ "en", "es", "de" ], "type": "string" }, "tenant_id": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time" }, "is_platform_operator": { "type": "boolean" } }, "required": [ "id", "email", "name", "image_url", "role", "locale", "tenant_id", "created_at", "is_platform_operator" ], "additionalProperties": false, "title": "UsersMeResponse" }, "UsersMeUpdateRequest": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "locale": { "type": "string", "enum": [ "en", "es", "de" ] } }, "additionalProperties": false, "title": "UsersMeUpdateRequest" }, "UsersMeUpdateResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string", "format": "email", "maxLength": 254 }, "name": { "type": "string", "maxLength": 200 }, "image_url": { "type": "string", "format": "uri" }, "role": { "enum": [ "ADMIN", "MEMBER" ], "type": "string" }, "locale": { "enum": [ "en", "es", "de" ], "type": "string" }, "tenant_id": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time" }, "is_platform_operator": { "type": "boolean" } }, "required": [ "id", "email", "name", "image_url", "role", "locale", "tenant_id", "created_at", "is_platform_operator" ], "additionalProperties": false, "title": "UsersMeUpdateResponse" }, "UsersListRequest": { "type": "object", "properties": { "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, "additionalProperties": false, "title": "UsersListRequest" }, "UsersListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string", "format": "email", "maxLength": 254 }, "name": { "type": "string", "maxLength": 200 }, "image_url": { "type": "string", "format": "uri" }, "role": { "enum": [ "ADMIN", "MEMBER" ], "type": "string" }, "locale": { "enum": [ "en", "es", "de" ], "type": "string" }, "tenant_id": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "email", "name", "image_url", "role", "locale", "tenant_id", "created_at" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "additionalProperties": false, "title": "UsersListResponse" }, "UsersGetRequest": { "type": "object", "properties": {}, "title": "UsersGetRequest" }, "UsersGetResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string", "format": "email", "maxLength": 254 }, "name": { "type": "string", "maxLength": 200 }, "image_url": { "type": "string", "format": "uri" }, "role": { "enum": [ "ADMIN", "MEMBER" ], "type": "string" }, "locale": { "enum": [ "en", "es", "de" ], "type": "string" }, "tenant_id": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "email", "name", "image_url", "role", "locale", "tenant_id", "created_at" ], "additionalProperties": false, "title": "UsersGetResponse" }, "UsersUpdateRoleRequest": { "type": "object", "required": [ "role" ], "properties": { "role": { "type": "string", "enum": [ "ADMIN", "MEMBER" ] } }, "title": "UsersUpdateRoleRequest" }, "UsersUpdateRoleResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string", "format": "email", "maxLength": 254 }, "name": { "type": "string", "maxLength": 200 }, "image_url": { "type": "string", "format": "uri" }, "role": { "enum": [ "ADMIN", "MEMBER" ], "type": "string" }, "locale": { "enum": [ "en", "es", "de" ], "type": "string" }, "tenant_id": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "email", "name", "image_url", "role", "locale", "tenant_id", "created_at" ], "additionalProperties": false, "title": "UsersUpdateRoleResponse" }, "UsersRemoveRequest": { "type": "object", "properties": {}, "title": "UsersRemoveRequest" }, "UsersRemoveResponse": { "type": "object", "properties": { "user_id": { "type": "string", "format": "uuid" }, "outcome": { "type": "string", "enum": [ "deleted" ] } }, "required": [ "user_id", "outcome" ], "additionalProperties": false, "title": "UsersRemoveResponse" }, "TenantsGetRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "TenantsGetRequest" }, "TenantsGetResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 200 }, "status": { "enum": [ "ACTIVE", "SUSPENDED", "DELETED" ], "type": "string" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "status", "created_at" ], "additionalProperties": false, "title": "TenantsGetResponse" }, "TenantsUpdateRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 } }, "additionalProperties": false, "title": "TenantsUpdateRequest" }, "TenantsUpdateResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 200 }, "status": { "enum": [ "ACTIVE", "SUSPENDED", "DELETED" ], "type": "string" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "status", "created_at" ], "additionalProperties": false, "title": "TenantsUpdateResponse" }, "AuditEventsListRequest": { "type": "object", "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "domain": { "type": "string" }, "operation_key": { "type": "string" }, "entity_type": { "type": "string" }, "entity_id": { "type": "string" }, "actor_id": { "type": "string", "format": "uuid" }, "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, "title": "AuditEventsListRequest" }, "AuditEventsListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sequence": { "type": "integer" }, "operation_key": { "type": "string" }, "entity_type": { "type": "string" }, "entity_id": { "type": "string" }, "actor_id": { "type": "string", "format": "uuid" }, "actor": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "actor_type": { "type": "string" }, "credential_id": { "type": [ "string", "null" ], "format": "uuid" }, "origin_kind": { "type": "string" }, "origin_id": { "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "payload": { "type": "object", "additionalProperties": true }, "created_at": { "type": "string", "format": "date-time" }, "event_hash": { "type": "string" } }, "required": [ "id", "sequence", "operation_key", "entity_type", "entity_id", "actor_id", "actor", "actor_type", "credential_id", "origin_kind", "origin_id", "space_id", "payload", "created_at", "event_hash" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "additionalProperties": false, "title": "AuditEventsListResponse" }, "AuditEventsGetRequest": { "type": "object", "properties": {}, "title": "AuditEventsGetRequest" }, "AuditEventsGetResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sequence": { "type": "integer" }, "operation_key": { "type": "string" }, "entity_type": { "type": "string" }, "entity_id": { "type": "string" }, "actor_id": { "type": "string", "format": "uuid" }, "actor": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "actor_type": { "type": "string" }, "credential_id": { "type": [ "string", "null" ], "format": "uuid" }, "origin_kind": { "type": "string" }, "origin_id": { "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "payload": { "type": "object", "additionalProperties": true }, "created_at": { "type": "string", "format": "date-time" }, "event_hash": { "type": "string" } }, "required": [ "id", "sequence", "operation_key", "entity_type", "entity_id", "actor_id", "actor", "actor_type", "credential_id", "origin_kind", "origin_id", "space_id", "payload", "created_at", "event_hash" ], "additionalProperties": false, "title": "AuditEventsGetResponse" }, "AuditChangeSetsGetRequest": { "type": "object", "properties": {}, "title": "AuditChangeSetsGetRequest" }, "AuditChangeSetsGetResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "operation_key": { "type": "string" }, "actor_id": { "type": "string", "format": "uuid" }, "actor": { "type": [ "object", "null" ], "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name", "image_url" ], "additionalProperties": false }, "actor_type": { "type": "string" }, "credential_id": { "type": [ "string", "null" ], "format": "uuid" }, "origin_kind": { "type": "string" }, "origin_id": { "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "entity_type": { "type": "string" }, "entity_id": { "type": "string" }, "request_data": { "type": "object", "additionalProperties": true }, "before_snapshot": { "type": "object", "additionalProperties": true }, "after_snapshot": { "type": "object", "additionalProperties": true }, "result_data": { "type": "object", "additionalProperties": true }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "operation_key", "actor_id", "actor", "actor_type", "credential_id", "origin_kind", "origin_id", "space_id", "entity_type", "entity_id", "request_data", "before_snapshot", "after_snapshot", "result_data", "created_at" ], "additionalProperties": false, "title": "AuditChangeSetsGetResponse" }, "AuditChainVerifyRequest": { "type": "object", "properties": { "from_sequence": { "type": "integer", "minimum": 1 }, "to_sequence": { "type": "integer", "minimum": 1 } }, "title": "AuditChainVerifyRequest" }, "AuditChainVerifyResponse": { "type": "object", "properties": { "valid": { "type": "boolean" }, "checked_events": { "type": "integer" }, "errors": { "type": "array", "items": { "type": "string" } } }, "required": [ "valid", "checked_events", "errors" ], "additionalProperties": false, "title": "AuditChainVerifyResponse" }, "AuditApiRequestsListRequest": { "type": "object", "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "api_key_id": { "type": "string", "format": "uuid" }, "status": { "type": "integer", "minimum": 100, "maximum": 599 }, "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, "title": "AuditApiRequestsListRequest" }, "AuditApiRequestsListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "api_key_id": { "type": [ "string", "null" ], "format": "uuid" }, "user_id": { "type": [ "string", "null" ], "format": "uuid" }, "request_id": { "type": "string" }, "method": { "type": "string" }, "path_template": { "type": "string" }, "operation_key": { "type": "string" }, "status": { "type": "integer" }, "duration_ms": { "type": "integer" }, "ip": { "type": [ "string", "null" ] }, "user_agent": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "api_key_id", "user_id", "request_id", "method", "path_template", "operation_key", "status", "duration_ms", "ip", "user_agent", "created_at" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "additionalProperties": false, "title": "AuditApiRequestsListResponse" }, "ApiKeysListRequest": { "type": "object", "properties": { "cursor": { "type": "string", "maxLength": 2048, "description": "Opaque continuation cursor from the previous response." }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, "additionalProperties": false, "title": "ApiKeysListRequest" }, "ApiKeysListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "user_id": { "type": "string", "format": "uuid" }, "label": { "type": "string" }, "prefix": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_used_at": { "type": [ "string", "null" ], "format": "date-time" }, "revoked_at": { "type": [ "string", "null" ], "format": "date-time" }, "grace_until": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "rate_limit_per_minute": { "type": [ "integer", "null" ] }, "rotated_from": { "type": [ "string", "null" ], "format": "uuid" }, "status": { "type": "string", "enum": [ "active", "rotating", "expired", "revoked" ] } }, "required": [ "id", "user_id", "label", "prefix", "scopes", "expires_at", "last_used_at", "revoked_at", "grace_until", "created_at", "rate_limit_per_minute", "rotated_from", "status" ] } }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque continuation cursor, or null after the last page." } }, "required": [ "items", "next_cursor" ], "additionalProperties": false, "title": "ApiKeysListResponse" }, "ApiKeysGetRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "ApiKeysGetRequest" }, "ApiKeysGetResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "user_id": { "type": "string", "format": "uuid" }, "label": { "type": "string" }, "prefix": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_used_at": { "type": [ "string", "null" ], "format": "date-time" }, "revoked_at": { "type": [ "string", "null" ], "format": "date-time" }, "grace_until": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "rate_limit_per_minute": { "type": [ "integer", "null" ] }, "rotated_from": { "type": [ "string", "null" ], "format": "uuid" }, "status": { "type": "string", "enum": [ "active", "rotating", "expired", "revoked" ] } }, "required": [ "id", "user_id", "label", "prefix", "scopes", "expires_at", "last_used_at", "revoked_at", "grace_until", "created_at", "rate_limit_per_minute", "rotated_from", "status" ], "title": "ApiKeysGetResponse" }, "ApiKeysUpdateRequest": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "scopes": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "*:read", "api_keys:destroy", "api_keys:read", "api_keys:write", "audit:destroy", "audit:read", "audit:write", "documents:destroy", "documents:read", "documents:write", "integrations:destroy", "integrations:read", "integrations:write", "pages:destroy", "pages:read", "pages:write", "skills:destroy", "skills:read", "skills:write", "spaces:destroy", "spaces:read", "spaces:write", "tenant:destroy", "tenant:read", "tenant:write", "users:destroy", "users:read", "users:write", "workflows:destroy", "workflows:read", "workflows:write" ] } } }, "additionalProperties": false, "title": "ApiKeysUpdateRequest" }, "ApiKeysUpdateResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "user_id": { "type": "string", "format": "uuid" }, "label": { "type": "string" }, "prefix": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_used_at": { "type": [ "string", "null" ], "format": "date-time" }, "revoked_at": { "type": [ "string", "null" ], "format": "date-time" }, "grace_until": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "rate_limit_per_minute": { "type": [ "integer", "null" ] }, "rotated_from": { "type": [ "string", "null" ], "format": "uuid" }, "status": { "type": "string", "enum": [ "active", "rotating", "expired", "revoked" ] } }, "required": [ "id", "user_id", "label", "prefix", "scopes", "expires_at", "last_used_at", "revoked_at", "grace_until", "created_at", "rate_limit_per_minute", "rotated_from", "status" ], "title": "ApiKeysUpdateResponse" }, "ApiKeysRevokeRequest": { "type": "object", "properties": {}, "additionalProperties": false, "title": "ApiKeysRevokeRequest" }, "ApiKeysRevokeResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "user_id": { "type": "string", "format": "uuid" }, "label": { "type": "string" }, "prefix": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_used_at": { "type": [ "string", "null" ], "format": "date-time" }, "revoked_at": { "type": [ "string", "null" ], "format": "date-time" }, "grace_until": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "rate_limit_per_minute": { "type": [ "integer", "null" ] }, "rotated_from": { "type": [ "string", "null" ], "format": "uuid" }, "status": { "type": "string", "enum": [ "active", "rotating", "expired", "revoked" ] } }, "required": [ "id", "user_id", "label", "prefix", "scopes", "expires_at", "last_used_at", "revoked_at", "grace_until", "created_at", "rate_limit_per_minute", "rotated_from", "status" ], "title": "ApiKeysRevokeResponse" }, "ApiKeysUsageRequest": { "type": "object", "properties": { "days": { "type": "integer", "minimum": 1, "maximum": 90, "default": 30 } }, "additionalProperties": false, "title": "ApiKeysUsageRequest" }, "ApiKeysUsageResponse": { "type": "object", "properties": { "key_id": { "type": "string", "format": "uuid" }, "days": { "type": "integer" }, "total_requests": { "type": "integer" }, "successful_requests": { "type": "integer" }, "error_requests": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "requests": { "type": "integer" }, "errors": { "type": "integer" } }, "required": [ "date", "requests", "errors" ], "additionalProperties": false } } }, "required": [ "key_id", "days", "total_requests", "successful_requests", "error_requests", "items" ], "additionalProperties": false, "title": "ApiKeysUsageResponse" }, "IntegrationsAttioAttributesListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 100, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "maximum": 100000, "minimum": 0, "title": "Offset", "type": "integer" }, "target": { "default": "objects", "enum": [ "objects", "lists" ], "title": "Target", "type": "string" }, "identifier": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "title": "Identifier", "type": "string" }, "show_archived": { "default": false, "title": "Show Archived", "type": "boolean" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "identifier" ], "title": "IntegrationsAttioAttributesListRequest", "type": "object" }, "IntegrationsAttioAttributesListResponseAttributeItem": { "additionalProperties": false, "properties": { "attribute_id": { "title": "Attribute Id", "type": "string" }, "api_slug": { "title": "Api Slug", "type": "string" }, "title": { "title": "Title", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "type": { "title": "Type", "type": "string" }, "is_system_attribute": { "title": "Is System Attribute", "type": "boolean" }, "is_required": { "title": "Is Required", "type": "boolean" }, "is_unique": { "title": "Is Unique", "type": "boolean" }, "is_multiselect": { "title": "Is Multiselect", "type": "boolean" }, "is_archived": { "title": "Is Archived", "type": "boolean" }, "allowed_objects": { "items": { "type": "string" }, "title": "Allowed Objects", "type": "array" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" } }, "required": [ "attribute_id", "api_slug", "title", "description", "type", "is_system_attribute", "is_required", "is_unique", "is_multiselect", "is_archived", "allowed_objects", "created_at" ], "title": "IntegrationsAttioAttributesListResponseAttributeItem", "type": "object" }, "IntegrationsAttioAttributesListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsAttioAttributesListResponseAttributeItem" }, "title": "Items", "type": "array" }, "has_more": { "title": "Has More", "type": "boolean" }, "next_offset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Offset" } }, "required": [ "items", "has_more", "next_offset" ], "title": "IntegrationsAttioAttributesListResponse", "type": "object" }, "IntegrationsAttioEmailsListRequest": { "additionalProperties": false, "properties": { "linked_object": { "anyOf": [ { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Linked Object" }, "linked_record_ids": { "items": { "type": "string" }, "maxItems": 10, "title": "Linked Record Ids", "type": "array" }, "participants": { "items": { "type": "string" }, "maxItems": 10, "title": "Participants", "type": "array" }, "domain": { "anyOf": [ { "pattern": "^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?(\\.[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)+$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Domain" }, "sent_after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Sent After" }, "sent_before": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Sent Before" }, "limit": { "default": 25, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,512}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsAttioEmailsListRequest", "type": "object" }, "IntegrationsAttioEmailsListResponseEmailItem": { "additionalProperties": false, "properties": { "email_id": { "title": "Email Id", "type": "string" }, "sent_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sent At" }, "direction": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Direction" }, "subject_line": { "title": "Subject Line", "type": "string" }, "participants": { "items": { "$ref": "#/components/schemas/IntegrationsAttioEmailsListResponseEmailParticipant" }, "title": "Participants", "type": "array" }, "linked_records": { "items": { "$ref": "#/components/schemas/IntegrationsAttioEmailsListResponseLinkedRecord" }, "title": "Linked Records", "type": "array" } }, "required": [ "email_id", "sent_at", "direction", "subject_line", "participants", "linked_records" ], "title": "IntegrationsAttioEmailsListResponseEmailItem", "type": "object" }, "IntegrationsAttioEmailsListResponseEmailParticipant": { "additionalProperties": false, "properties": { "role": { "title": "Role", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "email_address": { "title": "Email Address", "type": "string" }, "email_domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Domain" } }, "required": [ "role", "name", "email_address", "email_domain" ], "title": "IntegrationsAttioEmailsListResponseEmailParticipant", "type": "object" }, "IntegrationsAttioEmailsListResponseLinkedRecord": { "additionalProperties": false, "properties": { "object": { "title": "Object", "type": "string" }, "record_id": { "title": "Record Id", "type": "string" } }, "required": [ "object", "record_id" ], "title": "IntegrationsAttioEmailsListResponseLinkedRecord", "type": "object" }, "IntegrationsAttioEmailsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsAttioEmailsListResponseEmailItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsAttioEmailsListResponse", "type": "object" }, "IntegrationsAttioEntriesGetRequest": { "additionalProperties": false, "properties": { "list": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "title": "List", "type": "string" }, "entry_id": { "title": "Entry Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "list", "entry_id" ], "title": "IntegrationsAttioEntriesGetRequest", "type": "object" }, "IntegrationsAttioEntriesGetResponse": { "additionalProperties": false, "properties": { "entry_id": { "title": "Entry Id", "type": "string" }, "list_id": { "title": "List Id", "type": "string" }, "parent_object": { "title": "Parent Object", "type": "string" }, "parent_record_id": { "title": "Parent Record Id", "type": "string" }, "created_at": { "title": "Created At", "type": "string" }, "values": { "additionalProperties": { "items": {}, "type": "array" }, "title": "Values", "type": "object" } }, "required": [ "entry_id", "list_id", "parent_object", "parent_record_id", "created_at", "values" ], "title": "IntegrationsAttioEntriesGetResponse", "type": "object" }, "IntegrationsAttioEntriesQueryRequestSortSpec": { "additionalProperties": false, "properties": { "direction": { "default": "asc", "enum": [ "asc", "desc" ], "title": "Direction", "type": "string" }, "attribute": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "title": "Attribute", "type": "string" }, "field": { "anyOf": [ { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Field" } }, "required": [ "attribute" ], "title": "IntegrationsAttioEntriesQueryRequestSortSpec", "type": "object" }, "IntegrationsAttioEntriesQueryRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "maximum": 100000, "minimum": 0, "title": "Offset", "type": "integer" }, "filter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Filter" }, "filter_view_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter View Id" }, "sorts": { "items": { "$ref": "#/components/schemas/IntegrationsAttioEntriesQueryRequestSortSpec" }, "maxItems": 5, "title": "Sorts", "type": "array" }, "list": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "title": "List", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "list" ], "title": "IntegrationsAttioEntriesQueryRequest", "type": "object" }, "IntegrationsAttioEntriesQueryResponseEntryItem": { "additionalProperties": false, "properties": { "entry_id": { "title": "Entry Id", "type": "string" }, "list_id": { "title": "List Id", "type": "string" }, "parent_object": { "title": "Parent Object", "type": "string" }, "parent_record_id": { "title": "Parent Record Id", "type": "string" }, "created_at": { "title": "Created At", "type": "string" }, "values": { "additionalProperties": { "items": {}, "type": "array" }, "title": "Values", "type": "object" } }, "required": [ "entry_id", "list_id", "parent_object", "parent_record_id", "created_at", "values" ], "title": "IntegrationsAttioEntriesQueryResponseEntryItem", "type": "object" }, "IntegrationsAttioEntriesQueryResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsAttioEntriesQueryResponseEntryItem" }, "title": "Items", "type": "array" }, "has_more": { "title": "Has More", "type": "boolean" }, "next_offset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Offset" } }, "required": [ "items", "has_more", "next_offset" ], "title": "IntegrationsAttioEntriesQueryResponse", "type": "object" }, "IntegrationsAttioListsGetRequest": { "additionalProperties": false, "properties": { "list": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "title": "List", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "list" ], "title": "IntegrationsAttioListsGetRequest", "type": "object" }, "IntegrationsAttioListsGetResponseActor": { "additionalProperties": false, "properties": { "type": { "title": "Type", "type": "string" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "required": [ "type", "id" ], "title": "IntegrationsAttioListsGetResponseActor", "type": "object" }, "IntegrationsAttioListsGetResponse": { "additionalProperties": false, "properties": { "list_id": { "title": "List Id", "type": "string" }, "api_slug": { "title": "Api Slug", "type": "string" }, "name": { "title": "Name", "type": "string" }, "parent_object": { "items": { "type": "string" }, "title": "Parent Object", "type": "array" }, "workspace_access": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Access" }, "created_by": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsAttioListsGetResponseActor" }, { "type": "null" } ] }, "created_at": { "title": "Created At", "type": "string" } }, "required": [ "list_id", "api_slug", "name", "parent_object", "workspace_access", "created_by", "created_at" ], "title": "IntegrationsAttioListsGetResponse", "type": "object" }, "IntegrationsAttioListsListRequest": { "additionalProperties": false, "properties": { "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsAttioListsListRequest", "type": "object" }, "IntegrationsAttioListsListResponseActor": { "additionalProperties": false, "properties": { "type": { "title": "Type", "type": "string" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "required": [ "type", "id" ], "title": "IntegrationsAttioListsListResponseActor", "type": "object" }, "IntegrationsAttioListsListResponseListItem": { "additionalProperties": false, "properties": { "list_id": { "title": "List Id", "type": "string" }, "api_slug": { "title": "Api Slug", "type": "string" }, "name": { "title": "Name", "type": "string" }, "parent_object": { "items": { "type": "string" }, "title": "Parent Object", "type": "array" }, "workspace_access": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Access" }, "created_by": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsAttioListsListResponseActor" }, { "type": "null" } ] }, "created_at": { "title": "Created At", "type": "string" } }, "required": [ "list_id", "api_slug", "name", "parent_object", "workspace_access", "created_by", "created_at" ], "title": "IntegrationsAttioListsListResponseListItem", "type": "object" }, "IntegrationsAttioListsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsAttioListsListResponseListItem" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "IntegrationsAttioListsListResponse", "type": "object" }, "IntegrationsAttioMeetingsGetRequest": { "additionalProperties": false, "properties": { "meeting_id": { "title": "Meeting Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "meeting_id" ], "title": "IntegrationsAttioMeetingsGetRequest", "type": "object" }, "IntegrationsAttioMeetingsGetResponseActor": { "additionalProperties": false, "properties": { "type": { "title": "Type", "type": "string" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "required": [ "type", "id" ], "title": "IntegrationsAttioMeetingsGetResponseActor", "type": "object" }, "IntegrationsAttioMeetingsGetResponseLinkedRecord": { "additionalProperties": false, "properties": { "object": { "title": "Object", "type": "string" }, "record_id": { "title": "Record Id", "type": "string" } }, "required": [ "object", "record_id" ], "title": "IntegrationsAttioMeetingsGetResponseLinkedRecord", "type": "object" }, "IntegrationsAttioMeetingsGetResponseMeetingParticipant": { "additionalProperties": false, "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Address" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "is_organizer": { "title": "Is Organizer", "type": "boolean" } }, "required": [ "name", "email_address", "status", "is_organizer" ], "title": "IntegrationsAttioMeetingsGetResponseMeetingParticipant", "type": "object" }, "IntegrationsAttioMeetingsGetResponseMeetingTime": { "additionalProperties": false, "properties": { "datetime": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Datetime" }, "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Timezone" } }, "required": [ "datetime", "date", "timezone" ], "title": "IntegrationsAttioMeetingsGetResponseMeetingTime", "type": "object" }, "IntegrationsAttioMeetingsGetResponse": { "additionalProperties": false, "properties": { "meeting_id": { "title": "Meeting Id", "type": "string" }, "title": { "title": "Title", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "is_all_day": { "title": "Is All Day", "type": "boolean" }, "start": { "$ref": "#/components/schemas/IntegrationsAttioMeetingsGetResponseMeetingTime" }, "end": { "$ref": "#/components/schemas/IntegrationsAttioMeetingsGetResponseMeetingTime" }, "participants": { "items": { "$ref": "#/components/schemas/IntegrationsAttioMeetingsGetResponseMeetingParticipant" }, "title": "Participants", "type": "array" }, "linked_records": { "items": { "$ref": "#/components/schemas/IntegrationsAttioMeetingsGetResponseLinkedRecord" }, "title": "Linked Records", "type": "array" }, "created_by": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsAttioMeetingsGetResponseActor" }, { "type": "null" } ] }, "created_at": { "title": "Created At", "type": "string" } }, "required": [ "meeting_id", "title", "description", "is_all_day", "start", "end", "participants", "linked_records", "created_by", "created_at" ], "title": "IntegrationsAttioMeetingsGetResponse", "type": "object" }, "IntegrationsAttioMeetingsListRequest": { "additionalProperties": false, "properties": { "linked_object": { "anyOf": [ { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Linked Object" }, "linked_record_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Linked Record Id" }, "participants": { "items": { "type": "string" }, "maxItems": 10, "title": "Participants", "type": "array" }, "sort": { "default": "start_desc", "enum": [ "start_asc", "start_desc" ], "title": "Sort", "type": "string" }, "ends_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Ends From" }, "starts_before": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Starts Before" }, "limit": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,512}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsAttioMeetingsListRequest", "type": "object" }, "IntegrationsAttioMeetingsListResponseActor": { "additionalProperties": false, "properties": { "type": { "title": "Type", "type": "string" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "required": [ "type", "id" ], "title": "IntegrationsAttioMeetingsListResponseActor", "type": "object" }, "IntegrationsAttioMeetingsListResponseLinkedRecord": { "additionalProperties": false, "properties": { "object": { "title": "Object", "type": "string" }, "record_id": { "title": "Record Id", "type": "string" } }, "required": [ "object", "record_id" ], "title": "IntegrationsAttioMeetingsListResponseLinkedRecord", "type": "object" }, "IntegrationsAttioMeetingsListResponseMeetingItem": { "additionalProperties": false, "properties": { "meeting_id": { "title": "Meeting Id", "type": "string" }, "title": { "title": "Title", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "is_all_day": { "title": "Is All Day", "type": "boolean" }, "start": { "$ref": "#/components/schemas/IntegrationsAttioMeetingsListResponseMeetingTime" }, "end": { "$ref": "#/components/schemas/IntegrationsAttioMeetingsListResponseMeetingTime" }, "participants": { "items": { "$ref": "#/components/schemas/IntegrationsAttioMeetingsListResponseMeetingParticipant" }, "title": "Participants", "type": "array" }, "linked_records": { "items": { "$ref": "#/components/schemas/IntegrationsAttioMeetingsListResponseLinkedRecord" }, "title": "Linked Records", "type": "array" }, "created_by": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsAttioMeetingsListResponseActor" }, { "type": "null" } ] }, "created_at": { "title": "Created At", "type": "string" } }, "required": [ "meeting_id", "title", "description", "is_all_day", "start", "end", "participants", "linked_records", "created_by", "created_at" ], "title": "IntegrationsAttioMeetingsListResponseMeetingItem", "type": "object" }, "IntegrationsAttioMeetingsListResponseMeetingParticipant": { "additionalProperties": false, "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Address" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "is_organizer": { "title": "Is Organizer", "type": "boolean" } }, "required": [ "name", "email_address", "status", "is_organizer" ], "title": "IntegrationsAttioMeetingsListResponseMeetingParticipant", "type": "object" }, "IntegrationsAttioMeetingsListResponseMeetingTime": { "additionalProperties": false, "properties": { "datetime": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Datetime" }, "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Timezone" } }, "required": [ "datetime", "date", "timezone" ], "title": "IntegrationsAttioMeetingsListResponseMeetingTime", "type": "object" }, "IntegrationsAttioMeetingsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsAttioMeetingsListResponseMeetingItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsAttioMeetingsListResponse", "type": "object" }, "IntegrationsAttioNotesGetRequest": { "additionalProperties": false, "properties": { "note_id": { "title": "Note Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "note_id" ], "title": "IntegrationsAttioNotesGetRequest", "type": "object" }, "IntegrationsAttioNotesGetResponseActor": { "additionalProperties": false, "properties": { "type": { "title": "Type", "type": "string" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "required": [ "type", "id" ], "title": "IntegrationsAttioNotesGetResponseActor", "type": "object" }, "IntegrationsAttioNotesGetResponse": { "additionalProperties": false, "properties": { "note_id": { "title": "Note Id", "type": "string" }, "parent_object": { "title": "Parent Object", "type": "string" }, "parent_record_id": { "title": "Parent Record Id", "type": "string" }, "title": { "title": "Title", "type": "string" }, "content_plaintext": { "title": "Content Plaintext", "type": "string" }, "created_by": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsAttioNotesGetResponseActor" }, { "type": "null" } ] }, "created_at": { "title": "Created At", "type": "string" }, "content_markdown": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content Markdown" } }, "required": [ "note_id", "parent_object", "parent_record_id", "title", "content_plaintext", "created_by", "created_at", "content_markdown" ], "title": "IntegrationsAttioNotesGetResponse", "type": "object" }, "IntegrationsAttioNotesListRequest": { "additionalProperties": false, "properties": { "parent_object": { "anyOf": [ { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent Object" }, "parent_record_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent Record Id" }, "limit": { "default": 10, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "maximum": 100000, "minimum": 0, "title": "Offset", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsAttioNotesListRequest", "type": "object" }, "IntegrationsAttioNotesListResponseActor": { "additionalProperties": false, "properties": { "type": { "title": "Type", "type": "string" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "required": [ "type", "id" ], "title": "IntegrationsAttioNotesListResponseActor", "type": "object" }, "IntegrationsAttioNotesListResponseNoteItem": { "additionalProperties": false, "properties": { "note_id": { "title": "Note Id", "type": "string" }, "parent_object": { "title": "Parent Object", "type": "string" }, "parent_record_id": { "title": "Parent Record Id", "type": "string" }, "title": { "title": "Title", "type": "string" }, "content_plaintext": { "title": "Content Plaintext", "type": "string" }, "created_by": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsAttioNotesListResponseActor" }, { "type": "null" } ] }, "created_at": { "title": "Created At", "type": "string" } }, "required": [ "note_id", "parent_object", "parent_record_id", "title", "content_plaintext", "created_by", "created_at" ], "title": "IntegrationsAttioNotesListResponseNoteItem", "type": "object" }, "IntegrationsAttioNotesListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsAttioNotesListResponseNoteItem" }, "title": "Items", "type": "array" }, "has_more": { "title": "Has More", "type": "boolean" }, "next_offset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Offset" } }, "required": [ "items", "has_more", "next_offset" ], "title": "IntegrationsAttioNotesListResponse", "type": "object" }, "IntegrationsAttioObjectsGetRequest": { "additionalProperties": false, "properties": { "object": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "title": "Object", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "object" ], "title": "IntegrationsAttioObjectsGetRequest", "type": "object" }, "IntegrationsAttioObjectsGetResponse": { "additionalProperties": false, "properties": { "object_id": { "title": "Object Id", "type": "string" }, "api_slug": { "title": "Api Slug", "type": "string" }, "singular_noun": { "title": "Singular Noun", "type": "string" }, "plural_noun": { "title": "Plural Noun", "type": "string" }, "created_at": { "title": "Created At", "type": "string" } }, "required": [ "object_id", "api_slug", "singular_noun", "plural_noun", "created_at" ], "title": "IntegrationsAttioObjectsGetResponse", "type": "object" }, "IntegrationsAttioObjectsListRequest": { "additionalProperties": false, "properties": { "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsAttioObjectsListRequest", "type": "object" }, "IntegrationsAttioObjectsListResponseObjectItem": { "additionalProperties": false, "properties": { "object_id": { "title": "Object Id", "type": "string" }, "api_slug": { "title": "Api Slug", "type": "string" }, "singular_noun": { "title": "Singular Noun", "type": "string" }, "plural_noun": { "title": "Plural Noun", "type": "string" }, "created_at": { "title": "Created At", "type": "string" } }, "required": [ "object_id", "api_slug", "singular_noun", "plural_noun", "created_at" ], "title": "IntegrationsAttioObjectsListResponseObjectItem", "type": "object" }, "IntegrationsAttioObjectsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsAttioObjectsListResponseObjectItem" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "IntegrationsAttioObjectsListResponse", "type": "object" }, "IntegrationsAttioRecordEntriesListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "maximum": 100000, "minimum": 0, "title": "Offset", "type": "integer" }, "object": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "title": "Object", "type": "string" }, "record_id": { "title": "Record Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "object", "record_id" ], "title": "IntegrationsAttioRecordEntriesListRequest", "type": "object" }, "IntegrationsAttioRecordEntriesListResponseRecordEntryItem": { "additionalProperties": false, "properties": { "list_id": { "title": "List Id", "type": "string" }, "list_api_slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "List Api Slug" }, "entry_id": { "title": "Entry Id", "type": "string" }, "created_at": { "title": "Created At", "type": "string" } }, "required": [ "list_id", "list_api_slug", "entry_id", "created_at" ], "title": "IntegrationsAttioRecordEntriesListResponseRecordEntryItem", "type": "object" }, "IntegrationsAttioRecordEntriesListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsAttioRecordEntriesListResponseRecordEntryItem" }, "title": "Items", "type": "array" }, "has_more": { "title": "Has More", "type": "boolean" }, "next_offset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Offset" } }, "required": [ "items", "has_more", "next_offset" ], "title": "IntegrationsAttioRecordEntriesListResponse", "type": "object" }, "IntegrationsAttioRecordValuesListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "maximum": 100000, "minimum": 0, "title": "Offset", "type": "integer" }, "object": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "title": "Object", "type": "string" }, "record_id": { "title": "Record Id", "type": "string" }, "attribute": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "title": "Attribute", "type": "string" }, "show_historic": { "default": false, "title": "Show Historic", "type": "boolean" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "object", "record_id", "attribute" ], "title": "IntegrationsAttioRecordValuesListRequest", "type": "object" }, "IntegrationsAttioRecordValuesListResponseActor": { "additionalProperties": false, "properties": { "type": { "title": "Type", "type": "string" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "required": [ "type", "id" ], "title": "IntegrationsAttioRecordValuesListResponseActor", "type": "object" }, "IntegrationsAttioRecordValuesListResponseAttributeValueItem": { "additionalProperties": false, "properties": { "attribute_type": { "title": "Attribute Type", "type": "string" }, "value": { "title": "Value" }, "active_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Active From" }, "active_until": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Active Until" }, "created_by": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsAttioRecordValuesListResponseActor" }, { "type": "null" } ] } }, "required": [ "attribute_type", "value", "active_from", "active_until", "created_by" ], "title": "IntegrationsAttioRecordValuesListResponseAttributeValueItem", "type": "object" }, "IntegrationsAttioRecordValuesListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsAttioRecordValuesListResponseAttributeValueItem" }, "title": "Items", "type": "array" }, "has_more": { "title": "Has More", "type": "boolean" }, "next_offset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Offset" } }, "required": [ "items", "has_more", "next_offset" ], "title": "IntegrationsAttioRecordValuesListResponse", "type": "object" }, "IntegrationsAttioRecordsGetRequest": { "additionalProperties": false, "properties": { "object": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "title": "Object", "type": "string" }, "record_id": { "title": "Record Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "object", "record_id" ], "title": "IntegrationsAttioRecordsGetRequest", "type": "object" }, "IntegrationsAttioRecordsGetResponse": { "additionalProperties": false, "properties": { "record_id": { "title": "Record Id", "type": "string" }, "object": { "title": "Object", "type": "string" }, "web_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Web Url" }, "created_at": { "title": "Created At", "type": "string" }, "values": { "additionalProperties": { "items": {}, "type": "array" }, "title": "Values", "type": "object" } }, "required": [ "record_id", "object", "web_url", "created_at", "values" ], "title": "IntegrationsAttioRecordsGetResponse", "type": "object" }, "IntegrationsAttioRecordsQueryRequestSortSpec": { "additionalProperties": false, "properties": { "direction": { "default": "asc", "enum": [ "asc", "desc" ], "title": "Direction", "type": "string" }, "attribute": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "title": "Attribute", "type": "string" }, "field": { "anyOf": [ { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Field" } }, "required": [ "attribute" ], "title": "IntegrationsAttioRecordsQueryRequestSortSpec", "type": "object" }, "IntegrationsAttioRecordsQueryRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "maximum": 100000, "minimum": 0, "title": "Offset", "type": "integer" }, "object": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "title": "Object", "type": "string" }, "filter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Filter" }, "filter_view_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter View Id" }, "sorts": { "items": { "$ref": "#/components/schemas/IntegrationsAttioRecordsQueryRequestSortSpec" }, "maxItems": 5, "title": "Sorts", "type": "array" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "object" ], "title": "IntegrationsAttioRecordsQueryRequest", "type": "object" }, "IntegrationsAttioRecordsQueryResponseRecordItem": { "additionalProperties": false, "properties": { "record_id": { "title": "Record Id", "type": "string" }, "object": { "title": "Object", "type": "string" }, "web_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Web Url" }, "created_at": { "title": "Created At", "type": "string" }, "values": { "additionalProperties": { "items": {}, "type": "array" }, "title": "Values", "type": "object" } }, "required": [ "record_id", "object", "web_url", "created_at", "values" ], "title": "IntegrationsAttioRecordsQueryResponseRecordItem", "type": "object" }, "IntegrationsAttioRecordsQueryResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsAttioRecordsQueryResponseRecordItem" }, "title": "Items", "type": "array" }, "has_more": { "title": "Has More", "type": "boolean" }, "next_offset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Offset" } }, "required": [ "items", "has_more", "next_offset" ], "title": "IntegrationsAttioRecordsQueryResponse", "type": "object" }, "IntegrationsAttioRecordsSearchRequest": { "additionalProperties": false, "properties": { "query": { "maxLength": 256, "minLength": 0, "title": "Query", "type": "string" }, "objects": { "items": { "type": "string" }, "maxItems": 10, "minItems": 1, "title": "Objects", "type": "array" }, "limit": { "default": 25, "maximum": 25, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "query", "objects" ], "title": "IntegrationsAttioRecordsSearchRequest", "type": "object" }, "IntegrationsAttioRecordsSearchResponseSearchResultItem": { "additionalProperties": false, "properties": { "record_id": { "title": "Record Id", "type": "string" }, "object": { "title": "Object", "type": "string" }, "record_text": { "title": "Record Text", "type": "string" }, "record_image": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Record Image" }, "email_addresses": { "items": { "type": "string" }, "title": "Email Addresses", "type": "array" }, "phone_numbers": { "items": { "type": "string" }, "title": "Phone Numbers", "type": "array" }, "domains": { "items": { "type": "string" }, "title": "Domains", "type": "array" } }, "required": [ "record_id", "object", "record_text", "record_image", "email_addresses", "phone_numbers", "domains" ], "title": "IntegrationsAttioRecordsSearchResponseSearchResultItem", "type": "object" }, "IntegrationsAttioRecordsSearchResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsAttioRecordsSearchResponseSearchResultItem" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "IntegrationsAttioRecordsSearchResponse", "type": "object" }, "IntegrationsAttioSelectOptionsListRequest": { "additionalProperties": false, "properties": { "target": { "default": "objects", "enum": [ "objects", "lists" ], "title": "Target", "type": "string" }, "identifier": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "title": "Identifier", "type": "string" }, "attribute": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "title": "Attribute", "type": "string" }, "show_archived": { "default": false, "title": "Show Archived", "type": "boolean" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "identifier", "attribute" ], "title": "IntegrationsAttioSelectOptionsListRequest", "type": "object" }, "IntegrationsAttioSelectOptionsListResponseSelectOptionItem": { "additionalProperties": false, "properties": { "option_id": { "title": "Option Id", "type": "string" }, "title": { "title": "Title", "type": "string" }, "is_archived": { "title": "Is Archived", "type": "boolean" } }, "required": [ "option_id", "title", "is_archived" ], "title": "IntegrationsAttioSelectOptionsListResponseSelectOptionItem", "type": "object" }, "IntegrationsAttioSelectOptionsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsAttioSelectOptionsListResponseSelectOptionItem" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "IntegrationsAttioSelectOptionsListResponse", "type": "object" }, "IntegrationsAttioStatusesListRequest": { "additionalProperties": false, "properties": { "target": { "default": "objects", "enum": [ "objects", "lists" ], "title": "Target", "type": "string" }, "identifier": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "title": "Identifier", "type": "string" }, "attribute": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "title": "Attribute", "type": "string" }, "show_archived": { "default": false, "title": "Show Archived", "type": "boolean" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "identifier", "attribute" ], "title": "IntegrationsAttioStatusesListRequest", "type": "object" }, "IntegrationsAttioStatusesListResponseStatusItem": { "additionalProperties": false, "properties": { "status_id": { "title": "Status Id", "type": "string" }, "title": { "title": "Title", "type": "string" }, "is_archived": { "title": "Is Archived", "type": "boolean" }, "celebration_enabled": { "title": "Celebration Enabled", "type": "boolean" }, "target_time_in_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Time In Status" } }, "required": [ "status_id", "title", "is_archived", "celebration_enabled", "target_time_in_status" ], "title": "IntegrationsAttioStatusesListResponseStatusItem", "type": "object" }, "IntegrationsAttioStatusesListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsAttioStatusesListResponseStatusItem" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "IntegrationsAttioStatusesListResponse", "type": "object" }, "IntegrationsAttioTasksGetRequest": { "additionalProperties": false, "properties": { "task_id": { "title": "Task Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "task_id" ], "title": "IntegrationsAttioTasksGetRequest", "type": "object" }, "IntegrationsAttioTasksGetResponseActor": { "additionalProperties": false, "properties": { "type": { "title": "Type", "type": "string" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "required": [ "type", "id" ], "title": "IntegrationsAttioTasksGetResponseActor", "type": "object" }, "IntegrationsAttioTasksGetResponseLinkedRecord": { "additionalProperties": false, "properties": { "object": { "title": "Object", "type": "string" }, "record_id": { "title": "Record Id", "type": "string" } }, "required": [ "object", "record_id" ], "title": "IntegrationsAttioTasksGetResponseLinkedRecord", "type": "object" }, "IntegrationsAttioTasksGetResponse": { "additionalProperties": false, "properties": { "task_id": { "title": "Task Id", "type": "string" }, "content_plaintext": { "title": "Content Plaintext", "type": "string" }, "deadline_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deadline At" }, "is_completed": { "title": "Is Completed", "type": "boolean" }, "completed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "linked_records": { "items": { "$ref": "#/components/schemas/IntegrationsAttioTasksGetResponseLinkedRecord" }, "title": "Linked Records", "type": "array" }, "assignees": { "items": { "$ref": "#/components/schemas/IntegrationsAttioTasksGetResponseActor" }, "title": "Assignees", "type": "array" }, "created_by": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsAttioTasksGetResponseActor" }, { "type": "null" } ] }, "created_at": { "title": "Created At", "type": "string" } }, "required": [ "task_id", "content_plaintext", "deadline_at", "is_completed", "completed_at", "linked_records", "assignees", "created_by", "created_at" ], "title": "IntegrationsAttioTasksGetResponse", "type": "object" }, "IntegrationsAttioTasksListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "maximum": 100000, "minimum": 0, "title": "Offset", "type": "integer" }, "sort": { "default": "created_at:desc", "enum": [ "created_at:asc", "created_at:desc", "completed_at:asc", "completed_at:desc" ], "title": "Sort", "type": "string" }, "linked_object": { "anyOf": [ { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Linked Object" }, "linked_record_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Linked Record Id" }, "assignee": { "anyOf": [ { "maxLength": 320, "type": "string" }, { "type": "null" } ], "default": null, "title": "Assignee" }, "is_completed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Is Completed" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsAttioTasksListRequest", "type": "object" }, "IntegrationsAttioTasksListResponseActor": { "additionalProperties": false, "properties": { "type": { "title": "Type", "type": "string" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "required": [ "type", "id" ], "title": "IntegrationsAttioTasksListResponseActor", "type": "object" }, "IntegrationsAttioTasksListResponseLinkedRecord": { "additionalProperties": false, "properties": { "object": { "title": "Object", "type": "string" }, "record_id": { "title": "Record Id", "type": "string" } }, "required": [ "object", "record_id" ], "title": "IntegrationsAttioTasksListResponseLinkedRecord", "type": "object" }, "IntegrationsAttioTasksListResponseTaskItem": { "additionalProperties": false, "properties": { "task_id": { "title": "Task Id", "type": "string" }, "content_plaintext": { "title": "Content Plaintext", "type": "string" }, "deadline_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deadline At" }, "is_completed": { "title": "Is Completed", "type": "boolean" }, "completed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "linked_records": { "items": { "$ref": "#/components/schemas/IntegrationsAttioTasksListResponseLinkedRecord" }, "title": "Linked Records", "type": "array" }, "assignees": { "items": { "$ref": "#/components/schemas/IntegrationsAttioTasksListResponseActor" }, "title": "Assignees", "type": "array" }, "created_by": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsAttioTasksListResponseActor" }, { "type": "null" } ] }, "created_at": { "title": "Created At", "type": "string" } }, "required": [ "task_id", "content_plaintext", "deadline_at", "is_completed", "completed_at", "linked_records", "assignees", "created_by", "created_at" ], "title": "IntegrationsAttioTasksListResponseTaskItem", "type": "object" }, "IntegrationsAttioTasksListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsAttioTasksListResponseTaskItem" }, "title": "Items", "type": "array" }, "has_more": { "title": "Has More", "type": "boolean" }, "next_offset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Offset" } }, "required": [ "items", "has_more", "next_offset" ], "title": "IntegrationsAttioTasksListResponse", "type": "object" }, "IntegrationsAttioThreadsGetRequest": { "additionalProperties": false, "properties": { "thread_id": { "title": "Thread Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "thread_id" ], "title": "IntegrationsAttioThreadsGetRequest", "type": "object" }, "IntegrationsAttioThreadsGetResponseActor": { "additionalProperties": false, "properties": { "type": { "title": "Type", "type": "string" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "required": [ "type", "id" ], "title": "IntegrationsAttioThreadsGetResponseActor", "type": "object" }, "IntegrationsAttioThreadsGetResponseCommentItem": { "additionalProperties": false, "properties": { "comment_id": { "title": "Comment Id", "type": "string" }, "thread_id": { "title": "Thread Id", "type": "string" }, "content_plaintext": { "title": "Content Plaintext", "type": "string" }, "author": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsAttioThreadsGetResponseActor" }, { "type": "null" } ] }, "record": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsAttioThreadsGetResponseLinkedRecord" }, { "type": "null" } ] }, "entry": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsAttioThreadsGetResponseLinkedEntry" }, { "type": "null" } ] }, "created_at": { "title": "Created At", "type": "string" }, "resolved_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resolved At" }, "resolved_by": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsAttioThreadsGetResponseActor" }, { "type": "null" } ] } }, "required": [ "comment_id", "thread_id", "content_plaintext", "author", "record", "entry", "created_at", "resolved_at", "resolved_by" ], "title": "IntegrationsAttioThreadsGetResponseCommentItem", "type": "object" }, "IntegrationsAttioThreadsGetResponseLinkedEntry": { "additionalProperties": false, "properties": { "list_id": { "title": "List Id", "type": "string" }, "entry_id": { "title": "Entry Id", "type": "string" } }, "required": [ "list_id", "entry_id" ], "title": "IntegrationsAttioThreadsGetResponseLinkedEntry", "type": "object" }, "IntegrationsAttioThreadsGetResponseLinkedRecord": { "additionalProperties": false, "properties": { "object": { "title": "Object", "type": "string" }, "record_id": { "title": "Record Id", "type": "string" } }, "required": [ "object", "record_id" ], "title": "IntegrationsAttioThreadsGetResponseLinkedRecord", "type": "object" }, "IntegrationsAttioThreadsGetResponse": { "additionalProperties": false, "properties": { "thread_id": { "title": "Thread Id", "type": "string" }, "comments": { "items": { "$ref": "#/components/schemas/IntegrationsAttioThreadsGetResponseCommentItem" }, "title": "Comments", "type": "array" }, "created_at": { "title": "Created At", "type": "string" } }, "required": [ "thread_id", "comments", "created_at" ], "title": "IntegrationsAttioThreadsGetResponse", "type": "object" }, "IntegrationsAttioThreadsListRequest": { "additionalProperties": false, "properties": { "object": { "anyOf": [ { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Object" }, "record_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Record Id" }, "list": { "anyOf": [ { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "List" }, "entry_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Entry Id" }, "limit": { "default": 10, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "maximum": 100000, "minimum": 0, "title": "Offset", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsAttioThreadsListRequest", "type": "object" }, "IntegrationsAttioThreadsListResponseActor": { "additionalProperties": false, "properties": { "type": { "title": "Type", "type": "string" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "required": [ "type", "id" ], "title": "IntegrationsAttioThreadsListResponseActor", "type": "object" }, "IntegrationsAttioThreadsListResponseCommentItem": { "additionalProperties": false, "properties": { "comment_id": { "title": "Comment Id", "type": "string" }, "thread_id": { "title": "Thread Id", "type": "string" }, "content_plaintext": { "title": "Content Plaintext", "type": "string" }, "author": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsAttioThreadsListResponseActor" }, { "type": "null" } ] }, "record": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsAttioThreadsListResponseLinkedRecord" }, { "type": "null" } ] }, "entry": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsAttioThreadsListResponseLinkedEntry" }, { "type": "null" } ] }, "created_at": { "title": "Created At", "type": "string" }, "resolved_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resolved At" }, "resolved_by": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsAttioThreadsListResponseActor" }, { "type": "null" } ] } }, "required": [ "comment_id", "thread_id", "content_plaintext", "author", "record", "entry", "created_at", "resolved_at", "resolved_by" ], "title": "IntegrationsAttioThreadsListResponseCommentItem", "type": "object" }, "IntegrationsAttioThreadsListResponseLinkedEntry": { "additionalProperties": false, "properties": { "list_id": { "title": "List Id", "type": "string" }, "entry_id": { "title": "Entry Id", "type": "string" } }, "required": [ "list_id", "entry_id" ], "title": "IntegrationsAttioThreadsListResponseLinkedEntry", "type": "object" }, "IntegrationsAttioThreadsListResponseLinkedRecord": { "additionalProperties": false, "properties": { "object": { "title": "Object", "type": "string" }, "record_id": { "title": "Record Id", "type": "string" } }, "required": [ "object", "record_id" ], "title": "IntegrationsAttioThreadsListResponseLinkedRecord", "type": "object" }, "IntegrationsAttioThreadsListResponseThreadItem": { "additionalProperties": false, "properties": { "thread_id": { "title": "Thread Id", "type": "string" }, "comments": { "items": { "$ref": "#/components/schemas/IntegrationsAttioThreadsListResponseCommentItem" }, "title": "Comments", "type": "array" }, "created_at": { "title": "Created At", "type": "string" } }, "required": [ "thread_id", "comments", "created_at" ], "title": "IntegrationsAttioThreadsListResponseThreadItem", "type": "object" }, "IntegrationsAttioThreadsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsAttioThreadsListResponseThreadItem" }, "title": "Items", "type": "array" }, "has_more": { "title": "Has More", "type": "boolean" }, "next_offset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Offset" } }, "required": [ "items", "has_more", "next_offset" ], "title": "IntegrationsAttioThreadsListResponse", "type": "object" }, "IntegrationsAttioViewsListRequest": { "additionalProperties": false, "properties": { "target": { "default": "objects", "enum": [ "objects", "lists" ], "title": "Target", "type": "string" }, "identifier": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "title": "Identifier", "type": "string" }, "show_archived": { "default": false, "title": "Show Archived", "type": "boolean" }, "limit": { "default": 100, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,512}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "identifier" ], "title": "IntegrationsAttioViewsListRequest", "type": "object" }, "IntegrationsAttioViewsListResponseViewItem": { "additionalProperties": false, "properties": { "view_id": { "title": "View Id", "type": "string" }, "title": { "title": "Title", "type": "string" }, "created_at": { "title": "Created At", "type": "string" } }, "required": [ "view_id", "title", "created_at" ], "title": "IntegrationsAttioViewsListResponseViewItem", "type": "object" }, "IntegrationsAttioViewsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsAttioViewsListResponseViewItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsAttioViewsListResponse", "type": "object" }, "IntegrationsAttioWorkspaceMembersGetRequest": { "additionalProperties": false, "properties": { "workspace_member_id": { "title": "Workspace Member Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "workspace_member_id" ], "title": "IntegrationsAttioWorkspaceMembersGetRequest", "type": "object" }, "IntegrationsAttioWorkspaceMembersGetResponse": { "additionalProperties": false, "properties": { "workspace_member_id": { "title": "Workspace Member Id", "type": "string" }, "first_name": { "title": "First Name", "type": "string" }, "last_name": { "title": "Last Name", "type": "string" }, "email_address": { "title": "Email Address", "type": "string" }, "access_level": { "title": "Access Level", "type": "string" }, "created_at": { "title": "Created At", "type": "string" } }, "required": [ "workspace_member_id", "first_name", "last_name", "email_address", "access_level", "created_at" ], "title": "IntegrationsAttioWorkspaceMembersGetResponse", "type": "object" }, "IntegrationsAttioWorkspaceMembersListRequest": { "additionalProperties": false, "properties": { "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsAttioWorkspaceMembersListRequest", "type": "object" }, "IntegrationsAttioWorkspaceMembersListResponseWorkspaceMemberItem": { "additionalProperties": false, "properties": { "workspace_member_id": { "title": "Workspace Member Id", "type": "string" }, "first_name": { "title": "First Name", "type": "string" }, "last_name": { "title": "Last Name", "type": "string" }, "email_address": { "title": "Email Address", "type": "string" }, "access_level": { "title": "Access Level", "type": "string" }, "created_at": { "title": "Created At", "type": "string" } }, "required": [ "workspace_member_id", "first_name", "last_name", "email_address", "access_level", "created_at" ], "title": "IntegrationsAttioWorkspaceMembersListResponseWorkspaceMemberItem", "type": "object" }, "IntegrationsAttioWorkspaceMembersListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsAttioWorkspaceMembersListResponseWorkspaceMemberItem" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "IntegrationsAttioWorkspaceMembersListResponse", "type": "object" }, "IntegrationsFacturacionCatalogsListRequest": { "additionalProperties": false, "properties": { "table": { "enum": [ "identification_types", "organization_types", "fiscal_responsibility_types", "tax_types", "unit_codes", "payment_forms", "payment_methods", "currencies", "countries", "departments", "municipalities", "correction_concepts_credit_notes", "correction_concepts_debit_notes" ], "title": "Table", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "table" ], "title": "IntegrationsFacturacionCatalogsListRequest", "type": "object" }, "IntegrationsFacturacionCatalogsListResponseCatalogEntry": { "additionalProperties": false, "properties": { "code": { "title": "Code", "type": "string" }, "value": { "title": "Value", "type": "string" } }, "required": [ "code", "value" ], "title": "IntegrationsFacturacionCatalogsListResponseCatalogEntry", "type": "object" }, "IntegrationsFacturacionCatalogsListResponse": { "additionalProperties": false, "properties": { "table": { "enum": [ "identification_types", "organization_types", "fiscal_responsibility_types", "tax_types", "unit_codes", "payment_forms", "payment_methods", "currencies", "countries", "departments", "municipalities", "correction_concepts_credit_notes", "correction_concepts_debit_notes" ], "title": "Table", "type": "string" }, "items": { "items": { "$ref": "#/components/schemas/IntegrationsFacturacionCatalogsListResponseCatalogEntry" }, "title": "Items", "type": "array" } }, "required": [ "table", "items" ], "title": "IntegrationsFacturacionCatalogsListResponse", "type": "object" }, "IntegrationsFacturacionCompanyGetRequest": { "additionalProperties": false, "properties": { "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsFacturacionCompanyGetRequest", "type": "object" }, "IntegrationsFacturacionCompanyGetResponse": { "additionalProperties": false, "properties": { "provider_company_id": { "title": "Provider Company Id", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "trade_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Trade Name" }, "nit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nit" }, "dv": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dv" }, "government_status_invoices": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Government Status Invoices" }, "government_status_payrolls": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Government Status Payrolls" }, "uses_alegra_certificate": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Uses Alegra Certificate" }, "certificate_valid_until": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Certificate Valid Until" }, "notification_by_email_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Notification By Email Enabled" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "has_logo": { "title": "Has Logo", "type": "boolean" }, "habilitated": { "title": "Habilitated", "type": "boolean" } }, "required": [ "provider_company_id", "name", "trade_name", "nit", "dv", "government_status_invoices", "government_status_payrolls", "uses_alegra_certificate", "certificate_valid_until", "notification_by_email_enabled", "email", "has_logo", "habilitated" ], "title": "IntegrationsFacturacionCompanyGetResponse", "type": "object" }, "IntegrationsFacturacionCompanyUpdateRequest": { "additionalProperties": false, "properties": { "logo_base64": { "anyOf": [ { "maxLength": 200000, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Logo Base64" }, "notification_email_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Notification Email Enabled" }, "notification_message": { "anyOf": [ { "maxLength": 1000, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Notification Message" }, "sync_profile": { "default": true, "title": "Sync Profile", "type": "boolean" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsFacturacionCompanyUpdateRequest", "type": "object" }, "IntegrationsFacturacionCompanyUpdateResponse": { "type": "object", "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "job_id": { "type": "string" }, "safe_error_code": { "type": "string" } }, "required": [ "invocation_id", "status", "job_id" ], "additionalProperties": false, "title": "IntegrationsFacturacionCompanyUpdateResponse" }, "IntegrationsFacturacionCreditNotesCreateRequestAdjustmentInput": { "additionalProperties": false, "properties": { "is_charge": { "default": false, "title": "Is Charge", "type": "boolean" }, "reason": { "maxLength": 5000, "minLength": 10, "title": "Reason", "type": "string" }, "reason_code": { "anyOf": [ { "enum": [ "00", "01", "02", "03" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Reason Code" }, "percentage": { "maximum": 100, "minimum": 0, "title": "Percentage", "type": "number" }, "amount": { "minimum": 0, "title": "Amount", "type": "number" }, "base_amount": { "minimum": 0, "title": "Base Amount", "type": "number" } }, "required": [ "reason", "percentage", "amount", "base_amount" ], "title": "IntegrationsFacturacionCreditNotesCreateRequestAdjustmentInput", "type": "object" }, "IntegrationsFacturacionCreditNotesCreateRequestAffectedDocumentInput": { "additionalProperties": false, "properties": { "dian_uuid": { "pattern": "^[0-9a-fA-F]{40,128}$", "title": "Dian Uuid", "type": "string" }, "number": { "minimum": 0, "title": "Number", "type": "integer" }, "prefix": { "anyOf": [ { "pattern": "^[A-Za-z0-9]{1,4}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "issue_date": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "title": "Issue Date", "type": "string" }, "document_type": { "default": "01", "maxLength": 5, "minLength": 1, "title": "Document Type", "type": "string" } }, "required": [ "dian_uuid", "number", "issue_date" ], "title": "IntegrationsFacturacionCreditNotesCreateRequestAffectedDocumentInput", "type": "object" }, "IntegrationsFacturacionCreditNotesCreateRequestItemInput": { "additionalProperties": false, "properties": { "code": { "anyOf": [ { "maxLength": 50, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Code" }, "description": { "maxLength": 300, "minLength": 1, "title": "Description", "type": "string" }, "quantity": { "exclusiveMinimum": 0, "title": "Quantity", "type": "number" }, "unit_code": { "default": "94", "maxLength": 5, "minLength": 1, "title": "Unit Code", "type": "string" }, "price": { "minimum": 0, "title": "Price", "type": "number" }, "discount_percentage": { "anyOf": [ { "maximum": 100, "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "title": "Discount Percentage" }, "discount_amount": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "title": "Discount Amount" }, "taxes": { "items": { "$ref": "#/components/schemas/IntegrationsFacturacionCreditNotesCreateRequestTaxInput" }, "maxItems": 10, "title": "Taxes", "type": "array" }, "withholdings": { "items": { "$ref": "#/components/schemas/IntegrationsFacturacionCreditNotesCreateRequestTaxInput" }, "maxItems": 10, "title": "Withholdings", "type": "array" }, "brand_name": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Brand Name" }, "model_name": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Model Name" }, "note": { "anyOf": [ { "maxLength": 5000, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Note" } }, "required": [ "description", "quantity", "price" ], "title": "IntegrationsFacturacionCreditNotesCreateRequestItemInput", "type": "object" }, "IntegrationsFacturacionCreditNotesCreateRequestOrderReferenceInput": { "additionalProperties": false, "properties": { "number": { "maxLength": 120, "minLength": 1, "title": "Number", "type": "string" }, "issue_date": { "anyOf": [ { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Issue Date" } }, "required": [ "number" ], "title": "IntegrationsFacturacionCreditNotesCreateRequestOrderReferenceInput", "type": "object" }, "IntegrationsFacturacionCreditNotesCreateRequestPartyInput": { "additionalProperties": false, "properties": { "name": { "maxLength": 450, "minLength": 1, "title": "Name", "type": "string" }, "trade_name": { "anyOf": [ { "maxLength": 450, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Trade Name" }, "organization_type": { "default": "2", "enum": [ "1", "2" ], "title": "Organization Type", "type": "string" }, "identification_type": { "default": "13", "enum": [ "11", "12", "13", "21", "22", "31", "41", "42", "47", "48", "50", "91" ], "title": "Identification Type", "type": "string" }, "identification_number": { "maxLength": 30, "minLength": 1, "title": "Identification Number", "type": "string" }, "dv": { "anyOf": [ { "pattern": "^[0-9]$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Dv" }, "regime_code": { "anyOf": [ { "pattern": "^(O-13|O-15|O-23|O-47|O-48|O-49|R-99-PN)(;(O-13|O-15|O-23|O-47|O-48|O-49|R-99-PN))*$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Regime Code" }, "tax_code": { "anyOf": [ { "enum": [ "01", "04", "ZA", "ZZ" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Tax Code" }, "email": { "anyOf": [ { "pattern": "^[^\\s@]{1,128}@[^\\s@]{1,253}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Email" }, "phone": { "anyOf": [ { "maxLength": 30, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Phone" }, "address": { "anyOf": [ { "maxLength": 300, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Address" }, "city_code": { "anyOf": [ { "pattern": "^[0-9]{5}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "City Code" }, "department_code": { "anyOf": [ { "pattern": "^[0-9]{2}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Department Code" }, "postal_code": { "anyOf": [ { "pattern": "^[0-9A-Za-z]{6}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Postal Code" }, "country_code": { "default": "CO", "pattern": "^[A-Z]{2}$", "title": "Country Code", "type": "string" } }, "required": [ "name", "identification_number" ], "title": "IntegrationsFacturacionCreditNotesCreateRequestPartyInput", "type": "object" }, "IntegrationsFacturacionCreditNotesCreateRequestPaymentInput": { "additionalProperties": false, "properties": { "payment_form": { "default": "1", "enum": [ "1", "2" ], "title": "Payment Form", "type": "string" }, "payment_method": { "default": "10", "maxLength": 3, "minLength": 1, "title": "Payment Method", "type": "string" }, "due_date": { "anyOf": [ { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Due Date" } }, "title": "IntegrationsFacturacionCreditNotesCreateRequestPaymentInput", "type": "object" }, "IntegrationsFacturacionCreditNotesCreateRequestResolutionInput": { "additionalProperties": false, "properties": { "resolution_number": { "maxLength": 14, "minLength": 1, "title": "Resolution Number", "type": "string" }, "prefix": { "anyOf": [ { "pattern": "^[A-Za-z0-9]{1,4}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "min_number": { "minimum": 0, "title": "Min Number", "type": "integer" }, "max_number": { "minimum": 0, "title": "Max Number", "type": "integer" }, "start_date": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "title": "Start Date", "type": "string" }, "end_date": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "title": "End Date", "type": "string" }, "technical_key": { "anyOf": [ { "maxLength": 128, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Technical Key" } }, "required": [ "resolution_number", "min_number", "max_number", "start_date", "end_date" ], "title": "IntegrationsFacturacionCreditNotesCreateRequestResolutionInput", "type": "object" }, "IntegrationsFacturacionCreditNotesCreateRequestTaxInput": { "additionalProperties": false, "properties": { "tax_code": { "maxLength": 2, "minLength": 2, "title": "Tax Code", "type": "string" }, "percentage": { "maximum": 100, "minimum": 0, "title": "Percentage", "type": "number" }, "taxable_amount": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "title": "Taxable Amount" }, "amount": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "title": "Amount" } }, "required": [ "tax_code", "percentage" ], "title": "IntegrationsFacturacionCreditNotesCreateRequestTaxInput", "type": "object" }, "IntegrationsFacturacionCreditNotesCreateRequestTotalsInput": { "additionalProperties": false, "properties": { "gross_total": { "minimum": 0, "title": "Gross Total", "type": "number" }, "taxable_total": { "minimum": 0, "title": "Taxable Total", "type": "number" }, "tax_total": { "minimum": 0, "title": "Tax Total", "type": "number" }, "discount_total": { "default": 0, "minimum": 0, "title": "Discount Total", "type": "number" }, "charge_total": { "default": 0, "minimum": 0, "title": "Charge Total", "type": "number" }, "advance_total": { "default": 0, "minimum": 0, "title": "Advance Total", "type": "number" }, "payable_total": { "minimum": 0, "title": "Payable Total", "type": "number" } }, "required": [ "gross_total", "taxable_total", "tax_total", "payable_total" ], "title": "IntegrationsFacturacionCreditNotesCreateRequestTotalsInput", "type": "object" }, "IntegrationsFacturacionCreditNotesCreateRequest": { "additionalProperties": false, "properties": { "number": { "minimum": 1, "title": "Number", "type": "integer" }, "prefix": { "anyOf": [ { "pattern": "^[A-Za-z0-9]{1,4}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "notes": { "items": { "type": "string" }, "maxItems": 10, "title": "Notes", "type": "array" }, "currency_code": { "default": "COP", "pattern": "^[A-Z]{3}$", "title": "Currency Code", "type": "string" }, "exchange_rate": { "anyOf": [ { "exclusiveMinimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "title": "Exchange Rate" }, "exchange_rate_date": { "anyOf": [ { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Exchange Rate Date" }, "order_reference": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsFacturacionCreditNotesCreateRequestOrderReferenceInput" }, { "type": "null" } ], "default": null }, "payments": { "items": { "$ref": "#/components/schemas/IntegrationsFacturacionCreditNotesCreateRequestPaymentInput" }, "maxItems": 5, "minItems": 1, "title": "Payments", "type": "array" }, "discounts_and_charges": { "items": { "$ref": "#/components/schemas/IntegrationsFacturacionCreditNotesCreateRequestAdjustmentInput" }, "maxItems": 20, "title": "Discounts And Charges", "type": "array" }, "total_amounts": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsFacturacionCreditNotesCreateRequestTotalsInput" }, { "type": "null" } ], "default": null }, "resolution": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsFacturacionCreditNotesCreateRequestResolutionInput" }, { "type": "null" } ], "default": null }, "document_type": { "default": "91", "enum": [ "91", "91-22", "02" ], "title": "Document Type", "type": "string" }, "concept_code": { "enum": [ "1", "2", "3", "4", "5", "6" ], "title": "Concept Code", "type": "string" }, "affected_document": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsFacturacionCreditNotesCreateRequestAffectedDocumentInput" }, { "type": "null" } ], "default": null }, "customer": { "$ref": "#/components/schemas/IntegrationsFacturacionCreditNotesCreateRequestPartyInput" }, "items": { "items": { "$ref": "#/components/schemas/IntegrationsFacturacionCreditNotesCreateRequestItemInput" }, "maxItems": 500, "minItems": 1, "title": "Items", "type": "array" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "number", "payments", "concept_code", "customer", "items" ], "title": "IntegrationsFacturacionCreditNotesCreateRequest", "type": "object" }, "IntegrationsFacturacionCreditNotesCreateResponse": { "type": "object", "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "job_id": { "type": "string" }, "safe_error_code": { "type": "string" } }, "required": [ "invocation_id", "status", "job_id" ], "additionalProperties": false, "title": "IntegrationsFacturacionCreditNotesCreateResponse" }, "IntegrationsFacturacionDebitNotesCreateRequestAdjustmentInput": { "additionalProperties": false, "properties": { "is_charge": { "default": false, "title": "Is Charge", "type": "boolean" }, "reason": { "maxLength": 5000, "minLength": 10, "title": "Reason", "type": "string" }, "reason_code": { "anyOf": [ { "enum": [ "00", "01", "02", "03" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Reason Code" }, "percentage": { "maximum": 100, "minimum": 0, "title": "Percentage", "type": "number" }, "amount": { "minimum": 0, "title": "Amount", "type": "number" }, "base_amount": { "minimum": 0, "title": "Base Amount", "type": "number" } }, "required": [ "reason", "percentage", "amount", "base_amount" ], "title": "IntegrationsFacturacionDebitNotesCreateRequestAdjustmentInput", "type": "object" }, "IntegrationsFacturacionDebitNotesCreateRequestAffectedDocumentInput": { "additionalProperties": false, "properties": { "dian_uuid": { "pattern": "^[0-9a-fA-F]{40,128}$", "title": "Dian Uuid", "type": "string" }, "number": { "minimum": 0, "title": "Number", "type": "integer" }, "prefix": { "anyOf": [ { "pattern": "^[A-Za-z0-9]{1,4}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "issue_date": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "title": "Issue Date", "type": "string" }, "document_type": { "default": "01", "maxLength": 5, "minLength": 1, "title": "Document Type", "type": "string" } }, "required": [ "dian_uuid", "number", "issue_date" ], "title": "IntegrationsFacturacionDebitNotesCreateRequestAffectedDocumentInput", "type": "object" }, "IntegrationsFacturacionDebitNotesCreateRequestItemInput": { "additionalProperties": false, "properties": { "code": { "anyOf": [ { "maxLength": 50, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Code" }, "description": { "maxLength": 300, "minLength": 1, "title": "Description", "type": "string" }, "quantity": { "exclusiveMinimum": 0, "title": "Quantity", "type": "number" }, "unit_code": { "default": "94", "maxLength": 5, "minLength": 1, "title": "Unit Code", "type": "string" }, "price": { "minimum": 0, "title": "Price", "type": "number" }, "discount_percentage": { "anyOf": [ { "maximum": 100, "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "title": "Discount Percentage" }, "discount_amount": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "title": "Discount Amount" }, "taxes": { "items": { "$ref": "#/components/schemas/IntegrationsFacturacionDebitNotesCreateRequestTaxInput" }, "maxItems": 10, "title": "Taxes", "type": "array" }, "withholdings": { "items": { "$ref": "#/components/schemas/IntegrationsFacturacionDebitNotesCreateRequestTaxInput" }, "maxItems": 10, "title": "Withholdings", "type": "array" }, "brand_name": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Brand Name" }, "model_name": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Model Name" }, "note": { "anyOf": [ { "maxLength": 5000, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Note" } }, "required": [ "description", "quantity", "price" ], "title": "IntegrationsFacturacionDebitNotesCreateRequestItemInput", "type": "object" }, "IntegrationsFacturacionDebitNotesCreateRequestOrderReferenceInput": { "additionalProperties": false, "properties": { "number": { "maxLength": 120, "minLength": 1, "title": "Number", "type": "string" }, "issue_date": { "anyOf": [ { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Issue Date" } }, "required": [ "number" ], "title": "IntegrationsFacturacionDebitNotesCreateRequestOrderReferenceInput", "type": "object" }, "IntegrationsFacturacionDebitNotesCreateRequestPartyInput": { "additionalProperties": false, "properties": { "name": { "maxLength": 450, "minLength": 1, "title": "Name", "type": "string" }, "trade_name": { "anyOf": [ { "maxLength": 450, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Trade Name" }, "organization_type": { "default": "2", "enum": [ "1", "2" ], "title": "Organization Type", "type": "string" }, "identification_type": { "default": "13", "enum": [ "11", "12", "13", "21", "22", "31", "41", "42", "47", "48", "50", "91" ], "title": "Identification Type", "type": "string" }, "identification_number": { "maxLength": 30, "minLength": 1, "title": "Identification Number", "type": "string" }, "dv": { "anyOf": [ { "pattern": "^[0-9]$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Dv" }, "regime_code": { "anyOf": [ { "pattern": "^(O-13|O-15|O-23|O-47|O-48|O-49|R-99-PN)(;(O-13|O-15|O-23|O-47|O-48|O-49|R-99-PN))*$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Regime Code" }, "tax_code": { "anyOf": [ { "enum": [ "01", "04", "ZA", "ZZ" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Tax Code" }, "email": { "anyOf": [ { "pattern": "^[^\\s@]{1,128}@[^\\s@]{1,253}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Email" }, "phone": { "anyOf": [ { "maxLength": 30, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Phone" }, "address": { "anyOf": [ { "maxLength": 300, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Address" }, "city_code": { "anyOf": [ { "pattern": "^[0-9]{5}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "City Code" }, "department_code": { "anyOf": [ { "pattern": "^[0-9]{2}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Department Code" }, "postal_code": { "anyOf": [ { "pattern": "^[0-9A-Za-z]{6}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Postal Code" }, "country_code": { "default": "CO", "pattern": "^[A-Z]{2}$", "title": "Country Code", "type": "string" } }, "required": [ "name", "identification_number" ], "title": "IntegrationsFacturacionDebitNotesCreateRequestPartyInput", "type": "object" }, "IntegrationsFacturacionDebitNotesCreateRequestPaymentInput": { "additionalProperties": false, "properties": { "payment_form": { "default": "1", "enum": [ "1", "2" ], "title": "Payment Form", "type": "string" }, "payment_method": { "default": "10", "maxLength": 3, "minLength": 1, "title": "Payment Method", "type": "string" }, "due_date": { "anyOf": [ { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Due Date" } }, "title": "IntegrationsFacturacionDebitNotesCreateRequestPaymentInput", "type": "object" }, "IntegrationsFacturacionDebitNotesCreateRequestResolutionInput": { "additionalProperties": false, "properties": { "resolution_number": { "maxLength": 14, "minLength": 1, "title": "Resolution Number", "type": "string" }, "prefix": { "anyOf": [ { "pattern": "^[A-Za-z0-9]{1,4}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "min_number": { "minimum": 0, "title": "Min Number", "type": "integer" }, "max_number": { "minimum": 0, "title": "Max Number", "type": "integer" }, "start_date": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "title": "Start Date", "type": "string" }, "end_date": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "title": "End Date", "type": "string" }, "technical_key": { "anyOf": [ { "maxLength": 128, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Technical Key" } }, "required": [ "resolution_number", "min_number", "max_number", "start_date", "end_date" ], "title": "IntegrationsFacturacionDebitNotesCreateRequestResolutionInput", "type": "object" }, "IntegrationsFacturacionDebitNotesCreateRequestTaxInput": { "additionalProperties": false, "properties": { "tax_code": { "maxLength": 2, "minLength": 2, "title": "Tax Code", "type": "string" }, "percentage": { "maximum": 100, "minimum": 0, "title": "Percentage", "type": "number" }, "taxable_amount": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "title": "Taxable Amount" }, "amount": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "title": "Amount" } }, "required": [ "tax_code", "percentage" ], "title": "IntegrationsFacturacionDebitNotesCreateRequestTaxInput", "type": "object" }, "IntegrationsFacturacionDebitNotesCreateRequestTotalsInput": { "additionalProperties": false, "properties": { "gross_total": { "minimum": 0, "title": "Gross Total", "type": "number" }, "taxable_total": { "minimum": 0, "title": "Taxable Total", "type": "number" }, "tax_total": { "minimum": 0, "title": "Tax Total", "type": "number" }, "discount_total": { "default": 0, "minimum": 0, "title": "Discount Total", "type": "number" }, "charge_total": { "default": 0, "minimum": 0, "title": "Charge Total", "type": "number" }, "advance_total": { "default": 0, "minimum": 0, "title": "Advance Total", "type": "number" }, "payable_total": { "minimum": 0, "title": "Payable Total", "type": "number" } }, "required": [ "gross_total", "taxable_total", "tax_total", "payable_total" ], "title": "IntegrationsFacturacionDebitNotesCreateRequestTotalsInput", "type": "object" }, "IntegrationsFacturacionDebitNotesCreateRequest": { "additionalProperties": false, "properties": { "number": { "minimum": 1, "title": "Number", "type": "integer" }, "prefix": { "anyOf": [ { "pattern": "^[A-Za-z0-9]{1,4}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "notes": { "items": { "type": "string" }, "maxItems": 10, "title": "Notes", "type": "array" }, "currency_code": { "default": "COP", "pattern": "^[A-Z]{3}$", "title": "Currency Code", "type": "string" }, "exchange_rate": { "anyOf": [ { "exclusiveMinimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "title": "Exchange Rate" }, "exchange_rate_date": { "anyOf": [ { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Exchange Rate Date" }, "order_reference": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsFacturacionDebitNotesCreateRequestOrderReferenceInput" }, { "type": "null" } ], "default": null }, "payments": { "items": { "$ref": "#/components/schemas/IntegrationsFacturacionDebitNotesCreateRequestPaymentInput" }, "maxItems": 5, "minItems": 1, "title": "Payments", "type": "array" }, "discounts_and_charges": { "items": { "$ref": "#/components/schemas/IntegrationsFacturacionDebitNotesCreateRequestAdjustmentInput" }, "maxItems": 20, "title": "Discounts And Charges", "type": "array" }, "total_amounts": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsFacturacionDebitNotesCreateRequestTotalsInput" }, { "type": "null" } ], "default": null }, "resolution": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsFacturacionDebitNotesCreateRequestResolutionInput" }, { "type": "null" } ], "default": null }, "concept_code": { "enum": [ "1", "2", "3", "4" ], "title": "Concept Code", "type": "string" }, "affected_document": { "$ref": "#/components/schemas/IntegrationsFacturacionDebitNotesCreateRequestAffectedDocumentInput" }, "customer": { "$ref": "#/components/schemas/IntegrationsFacturacionDebitNotesCreateRequestPartyInput" }, "items": { "items": { "$ref": "#/components/schemas/IntegrationsFacturacionDebitNotesCreateRequestItemInput" }, "maxItems": 500, "minItems": 1, "title": "Items", "type": "array" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "number", "payments", "concept_code", "affected_document", "customer", "items" ], "title": "IntegrationsFacturacionDebitNotesCreateRequest", "type": "object" }, "IntegrationsFacturacionDebitNotesCreateResponse": { "type": "object", "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "job_id": { "type": "string" }, "safe_error_code": { "type": "string" } }, "required": [ "invocation_id", "status", "job_id" ], "additionalProperties": false, "title": "IntegrationsFacturacionDebitNotesCreateResponse" }, "IntegrationsFacturacionDianQueryRequest": { "additionalProperties": false, "properties": { "track_id": { "pattern": "^[0-9a-fA-F]{40,128}$", "title": "Track Id", "type": "string" }, "archive_xml": { "default": false, "title": "Archive Xml", "type": "boolean" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "track_id" ], "title": "IntegrationsFacturacionDianQueryRequest", "type": "object" }, "IntegrationsFacturacionDianQueryResponseDianRelatedDocument": { "additionalProperties": false, "properties": { "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" }, "full_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Full Number" }, "dian_uuid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dian Uuid" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date" } }, "required": [ "type", "full_number", "dian_uuid", "description", "date" ], "title": "IntegrationsFacturacionDianQueryResponseDianRelatedDocument", "type": "object" }, "IntegrationsFacturacionDianQueryResponse": { "additionalProperties": false, "properties": { "track_id": { "title": "Track Id", "type": "string" }, "dian_status": { "title": "Dian Status", "type": "string" }, "document_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Document Date" }, "document_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Document Number" }, "status_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status Description" }, "status_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status Message" }, "currency_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency Code" }, "subtotal": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Subtotal" }, "tax_total": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Tax Total" }, "total": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total" }, "notifications": { "items": { "type": "string" }, "title": "Notifications", "type": "array" }, "notes": { "items": { "$ref": "#/components/schemas/IntegrationsFacturacionDianQueryResponseDianRelatedDocument" }, "title": "Notes", "type": "array" }, "events": { "items": { "$ref": "#/components/schemas/IntegrationsFacturacionDianQueryResponseDianRelatedDocument" }, "title": "Events", "type": "array" }, "xml_available": { "title": "Xml Available", "type": "boolean" }, "xml_document_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Xml Document Id" } }, "required": [ "track_id", "dian_status", "document_date", "document_number", "status_description", "status_message", "currency_code", "subtotal", "tax_total", "total", "notifications", "notes", "events", "xml_available", "xml_document_id" ], "title": "IntegrationsFacturacionDianQueryResponse", "type": "object" }, "IntegrationsFacturacionDocumentsGetRequest": { "additionalProperties": false, "properties": { "kind": { "enum": [ "invoice", "credit_note", "debit_note", "support_document" ], "title": "Kind", "type": "string" }, "provider_document_id": { "pattern": "^[A-Za-z0-9_-]{1,64}$", "title": "Provider Document Id", "type": "string" }, "archive_files": { "default": true, "title": "Archive Files", "type": "boolean" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "kind", "provider_document_id" ], "title": "IntegrationsFacturacionDocumentsGetRequest", "type": "object" }, "IntegrationsFacturacionDocumentsGetResponseDocumentError": { "additionalProperties": false, "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" } }, "required": [ "code", "message" ], "title": "IntegrationsFacturacionDocumentsGetResponseDocumentError", "type": "object" }, "IntegrationsFacturacionDocumentsGetResponseDocumentFiles": { "additionalProperties": false, "properties": { "xml_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Xml Url" }, "attached_document_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Attached Document Url" }, "zip_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zip Url" } }, "required": [ "xml_url", "attached_document_url", "zip_url" ], "title": "IntegrationsFacturacionDocumentsGetResponseDocumentFiles", "type": "object" }, "IntegrationsFacturacionDocumentsGetResponseDocumentTotals": { "additionalProperties": false, "properties": { "gross_total": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Gross Total" }, "taxable_total": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Taxable Total" }, "tax_total": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Tax Total" }, "payable_total": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Payable Total" }, "currency_code": { "title": "Currency Code", "type": "string" } }, "required": [ "gross_total", "taxable_total", "tax_total", "payable_total", "currency_code" ], "title": "IntegrationsFacturacionDocumentsGetResponseDocumentTotals", "type": "object" }, "IntegrationsFacturacionDocumentsGetResponseGovernmentResponse": { "additionalProperties": false, "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "error_messages": { "items": { "type": "string" }, "title": "Error Messages", "type": "array" } }, "required": [ "code", "message", "error_messages" ], "title": "IntegrationsFacturacionDocumentsGetResponseGovernmentResponse", "type": "object" }, "IntegrationsFacturacionDocumentsGetResponseImportedDocuments": { "additionalProperties": false, "properties": { "xml_document_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Xml Document Id" }, "attached_document_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Attached Document Id" }, "zip_document_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zip Document Id" } }, "required": [ "xml_document_id", "attached_document_id", "zip_document_id" ], "title": "IntegrationsFacturacionDocumentsGetResponseImportedDocuments", "type": "object" }, "IntegrationsFacturacionDocumentsGetResponse": { "additionalProperties": false, "properties": { "provider_document_id": { "title": "Provider Document Id", "type": "string" }, "kind": { "enum": [ "invoice", "credit_note", "debit_note", "support_document" ], "title": "Kind", "type": "string" }, "document_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Document Type" }, "prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prefix" }, "number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Number" }, "full_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Full Number" }, "dian_uuid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dian Uuid" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "legal_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legal Status" }, "issued_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Issued At" }, "government_response": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsFacturacionDocumentsGetResponseGovernmentResponse" }, { "type": "null" } ] }, "errors": { "items": { "$ref": "#/components/schemas/IntegrationsFacturacionDocumentsGetResponseDocumentError" }, "title": "Errors", "type": "array" }, "qr_code_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Qr Code Content" }, "files": { "$ref": "#/components/schemas/IntegrationsFacturacionDocumentsGetResponseDocumentFiles" }, "documents": { "$ref": "#/components/schemas/IntegrationsFacturacionDocumentsGetResponseImportedDocuments" }, "counterparty_identification": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Counterparty Identification" }, "counterparty_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Counterparty Name" }, "totals": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsFacturacionDocumentsGetResponseDocumentTotals" }, { "type": "null" } ] }, "concept_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Concept Code" }, "affected_document_uuid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Affected Document Uuid" } }, "required": [ "provider_document_id", "kind", "document_type", "prefix", "number", "full_number", "dian_uuid", "status", "legal_status", "issued_at", "government_response", "errors", "qr_code_content", "files", "documents", "counterparty_identification", "counterparty_name", "totals", "concept_code", "affected_document_uuid" ], "title": "IntegrationsFacturacionDocumentsGetResponse", "type": "object" }, "IntegrationsFacturacionDocumentsSendEmailRequest": { "additionalProperties": false, "properties": { "kind": { "enum": [ "invoice", "credit_note", "debit_note" ], "title": "Kind", "type": "string" }, "provider_document_id": { "pattern": "^[A-Za-z0-9_-]{1,64}$", "title": "Provider Document Id", "type": "string" }, "to": { "anyOf": [ { "pattern": "^[^\\s@]{1,128}@[^\\s@]{1,253}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "To" }, "reply_to": { "anyOf": [ { "pattern": "^[^\\s@]{1,128}@[^\\s@]{1,253}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Reply To" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "kind", "provider_document_id" ], "title": "IntegrationsFacturacionDocumentsSendEmailRequest", "type": "object" }, "IntegrationsFacturacionDocumentsSendEmailResponse": { "type": "object", "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "job_id": { "type": "string" }, "safe_error_code": { "type": "string" } }, "required": [ "invocation_id", "status", "job_id" ], "additionalProperties": false, "title": "IntegrationsFacturacionDocumentsSendEmailResponse" }, "IntegrationsFacturacionInvoicesCreateRequestAdjustmentInput": { "additionalProperties": false, "properties": { "is_charge": { "default": false, "title": "Is Charge", "type": "boolean" }, "reason": { "maxLength": 5000, "minLength": 10, "title": "Reason", "type": "string" }, "reason_code": { "anyOf": [ { "enum": [ "00", "01", "02", "03" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Reason Code" }, "percentage": { "maximum": 100, "minimum": 0, "title": "Percentage", "type": "number" }, "amount": { "minimum": 0, "title": "Amount", "type": "number" }, "base_amount": { "minimum": 0, "title": "Base Amount", "type": "number" } }, "required": [ "reason", "percentage", "amount", "base_amount" ], "title": "IntegrationsFacturacionInvoicesCreateRequestAdjustmentInput", "type": "object" }, "IntegrationsFacturacionInvoicesCreateRequestItemInput": { "additionalProperties": false, "properties": { "code": { "anyOf": [ { "maxLength": 50, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Code" }, "description": { "maxLength": 300, "minLength": 1, "title": "Description", "type": "string" }, "quantity": { "exclusiveMinimum": 0, "title": "Quantity", "type": "number" }, "unit_code": { "default": "94", "maxLength": 5, "minLength": 1, "title": "Unit Code", "type": "string" }, "price": { "minimum": 0, "title": "Price", "type": "number" }, "discount_percentage": { "anyOf": [ { "maximum": 100, "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "title": "Discount Percentage" }, "discount_amount": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "title": "Discount Amount" }, "taxes": { "items": { "$ref": "#/components/schemas/IntegrationsFacturacionInvoicesCreateRequestTaxInput" }, "maxItems": 10, "title": "Taxes", "type": "array" }, "withholdings": { "items": { "$ref": "#/components/schemas/IntegrationsFacturacionInvoicesCreateRequestTaxInput" }, "maxItems": 10, "title": "Withholdings", "type": "array" }, "brand_name": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Brand Name" }, "model_name": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Model Name" }, "note": { "anyOf": [ { "maxLength": 5000, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Note" } }, "required": [ "description", "quantity", "price" ], "title": "IntegrationsFacturacionInvoicesCreateRequestItemInput", "type": "object" }, "IntegrationsFacturacionInvoicesCreateRequestOrderReferenceInput": { "additionalProperties": false, "properties": { "number": { "maxLength": 120, "minLength": 1, "title": "Number", "type": "string" }, "issue_date": { "anyOf": [ { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Issue Date" } }, "required": [ "number" ], "title": "IntegrationsFacturacionInvoicesCreateRequestOrderReferenceInput", "type": "object" }, "IntegrationsFacturacionInvoicesCreateRequestPartyInput": { "additionalProperties": false, "properties": { "name": { "maxLength": 450, "minLength": 1, "title": "Name", "type": "string" }, "trade_name": { "anyOf": [ { "maxLength": 450, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Trade Name" }, "organization_type": { "default": "2", "enum": [ "1", "2" ], "title": "Organization Type", "type": "string" }, "identification_type": { "default": "13", "enum": [ "11", "12", "13", "21", "22", "31", "41", "42", "47", "48", "50", "91" ], "title": "Identification Type", "type": "string" }, "identification_number": { "maxLength": 30, "minLength": 1, "title": "Identification Number", "type": "string" }, "dv": { "anyOf": [ { "pattern": "^[0-9]$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Dv" }, "regime_code": { "anyOf": [ { "pattern": "^(O-13|O-15|O-23|O-47|O-48|O-49|R-99-PN)(;(O-13|O-15|O-23|O-47|O-48|O-49|R-99-PN))*$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Regime Code" }, "tax_code": { "anyOf": [ { "enum": [ "01", "04", "ZA", "ZZ" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Tax Code" }, "email": { "anyOf": [ { "pattern": "^[^\\s@]{1,128}@[^\\s@]{1,253}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Email" }, "phone": { "anyOf": [ { "maxLength": 30, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Phone" }, "address": { "anyOf": [ { "maxLength": 300, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Address" }, "city_code": { "anyOf": [ { "pattern": "^[0-9]{5}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "City Code" }, "department_code": { "anyOf": [ { "pattern": "^[0-9]{2}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Department Code" }, "postal_code": { "anyOf": [ { "pattern": "^[0-9A-Za-z]{6}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Postal Code" }, "country_code": { "default": "CO", "pattern": "^[A-Z]{2}$", "title": "Country Code", "type": "string" } }, "required": [ "name", "identification_number" ], "title": "IntegrationsFacturacionInvoicesCreateRequestPartyInput", "type": "object" }, "IntegrationsFacturacionInvoicesCreateRequestPaymentInput": { "additionalProperties": false, "properties": { "payment_form": { "default": "1", "enum": [ "1", "2" ], "title": "Payment Form", "type": "string" }, "payment_method": { "default": "10", "maxLength": 3, "minLength": 1, "title": "Payment Method", "type": "string" }, "due_date": { "anyOf": [ { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Due Date" } }, "title": "IntegrationsFacturacionInvoicesCreateRequestPaymentInput", "type": "object" }, "IntegrationsFacturacionInvoicesCreateRequestResolutionInput": { "additionalProperties": false, "properties": { "resolution_number": { "maxLength": 14, "minLength": 1, "title": "Resolution Number", "type": "string" }, "prefix": { "anyOf": [ { "pattern": "^[A-Za-z0-9]{1,4}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "min_number": { "minimum": 0, "title": "Min Number", "type": "integer" }, "max_number": { "minimum": 0, "title": "Max Number", "type": "integer" }, "start_date": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "title": "Start Date", "type": "string" }, "end_date": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "title": "End Date", "type": "string" }, "technical_key": { "anyOf": [ { "maxLength": 128, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Technical Key" } }, "required": [ "resolution_number", "min_number", "max_number", "start_date", "end_date" ], "title": "IntegrationsFacturacionInvoicesCreateRequestResolutionInput", "type": "object" }, "IntegrationsFacturacionInvoicesCreateRequestTaxInput": { "additionalProperties": false, "properties": { "tax_code": { "maxLength": 2, "minLength": 2, "title": "Tax Code", "type": "string" }, "percentage": { "maximum": 100, "minimum": 0, "title": "Percentage", "type": "number" }, "taxable_amount": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "title": "Taxable Amount" }, "amount": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "title": "Amount" } }, "required": [ "tax_code", "percentage" ], "title": "IntegrationsFacturacionInvoicesCreateRequestTaxInput", "type": "object" }, "IntegrationsFacturacionInvoicesCreateRequestTotalsInput": { "additionalProperties": false, "properties": { "gross_total": { "minimum": 0, "title": "Gross Total", "type": "number" }, "taxable_total": { "minimum": 0, "title": "Taxable Total", "type": "number" }, "tax_total": { "minimum": 0, "title": "Tax Total", "type": "number" }, "discount_total": { "default": 0, "minimum": 0, "title": "Discount Total", "type": "number" }, "charge_total": { "default": 0, "minimum": 0, "title": "Charge Total", "type": "number" }, "advance_total": { "default": 0, "minimum": 0, "title": "Advance Total", "type": "number" }, "payable_total": { "minimum": 0, "title": "Payable Total", "type": "number" } }, "required": [ "gross_total", "taxable_total", "tax_total", "payable_total" ], "title": "IntegrationsFacturacionInvoicesCreateRequestTotalsInput", "type": "object" }, "IntegrationsFacturacionInvoicesCreateRequest": { "additionalProperties": false, "properties": { "number": { "minimum": 1, "title": "Number", "type": "integer" }, "prefix": { "anyOf": [ { "pattern": "^[A-Za-z0-9]{1,4}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "notes": { "items": { "type": "string" }, "maxItems": 10, "title": "Notes", "type": "array" }, "currency_code": { "default": "COP", "pattern": "^[A-Z]{3}$", "title": "Currency Code", "type": "string" }, "exchange_rate": { "anyOf": [ { "exclusiveMinimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "title": "Exchange Rate" }, "exchange_rate_date": { "anyOf": [ { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Exchange Rate Date" }, "order_reference": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsFacturacionInvoicesCreateRequestOrderReferenceInput" }, { "type": "null" } ], "default": null }, "payments": { "items": { "$ref": "#/components/schemas/IntegrationsFacturacionInvoicesCreateRequestPaymentInput" }, "maxItems": 5, "minItems": 1, "title": "Payments", "type": "array" }, "discounts_and_charges": { "items": { "$ref": "#/components/schemas/IntegrationsFacturacionInvoicesCreateRequestAdjustmentInput" }, "maxItems": 20, "title": "Discounts And Charges", "type": "array" }, "total_amounts": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsFacturacionInvoicesCreateRequestTotalsInput" }, { "type": "null" } ], "default": null }, "resolution": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsFacturacionInvoicesCreateRequestResolutionInput" }, { "type": "null" } ], "default": null }, "document_type": { "default": "01", "enum": [ "01", "02", "03", "04", "05", "06", "07", "08" ], "title": "Document Type", "type": "string" }, "customer": { "$ref": "#/components/schemas/IntegrationsFacturacionInvoicesCreateRequestPartyInput" }, "items": { "items": { "$ref": "#/components/schemas/IntegrationsFacturacionInvoicesCreateRequestItemInput" }, "maxItems": 500, "minItems": 1, "title": "Items", "type": "array" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "number", "payments", "customer", "items" ], "title": "IntegrationsFacturacionInvoicesCreateRequest", "type": "object" }, "IntegrationsFacturacionInvoicesCreateResponse": { "type": "object", "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "job_id": { "type": "string" }, "safe_error_code": { "type": "string" } }, "required": [ "invocation_id", "status", "job_id" ], "additionalProperties": false, "title": "IntegrationsFacturacionInvoicesCreateResponse" }, "IntegrationsFacturacionResolutionsListRequest": { "additionalProperties": false, "properties": { "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsFacturacionResolutionsListRequest", "type": "object" }, "IntegrationsFacturacionResolutionsListResponseResolutionItem": { "additionalProperties": false, "properties": { "resolution_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resolution Number" }, "prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prefix" }, "min_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Min Number" }, "max_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Number" }, "start_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Date" }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Date" }, "technical_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Technical Key" } }, "required": [ "resolution_number", "prefix", "min_number", "max_number", "start_date", "end_date", "technical_key" ], "title": "IntegrationsFacturacionResolutionsListResponseResolutionItem", "type": "object" }, "IntegrationsFacturacionResolutionsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsFacturacionResolutionsListResponseResolutionItem" }, "title": "Items", "type": "array" }, "available": { "title": "Available", "type": "boolean" } }, "required": [ "items", "available" ], "title": "IntegrationsFacturacionResolutionsListResponse", "type": "object" }, "IntegrationsFacturacionSupportDocumentsCreateRequestAdjustmentInput": { "additionalProperties": false, "properties": { "is_charge": { "default": false, "title": "Is Charge", "type": "boolean" }, "reason": { "maxLength": 5000, "minLength": 10, "title": "Reason", "type": "string" }, "reason_code": { "anyOf": [ { "enum": [ "00", "01", "02", "03" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Reason Code" }, "percentage": { "maximum": 100, "minimum": 0, "title": "Percentage", "type": "number" }, "amount": { "minimum": 0, "title": "Amount", "type": "number" }, "base_amount": { "minimum": 0, "title": "Base Amount", "type": "number" } }, "required": [ "reason", "percentage", "amount", "base_amount" ], "title": "IntegrationsFacturacionSupportDocumentsCreateRequestAdjustmentInput", "type": "object" }, "IntegrationsFacturacionSupportDocumentsCreateRequestOrderReferenceInput": { "additionalProperties": false, "properties": { "number": { "maxLength": 120, "minLength": 1, "title": "Number", "type": "string" }, "issue_date": { "anyOf": [ { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Issue Date" } }, "required": [ "number" ], "title": "IntegrationsFacturacionSupportDocumentsCreateRequestOrderReferenceInput", "type": "object" }, "IntegrationsFacturacionSupportDocumentsCreateRequestPaymentInput": { "additionalProperties": false, "properties": { "payment_form": { "default": "1", "enum": [ "1", "2" ], "title": "Payment Form", "type": "string" }, "payment_method": { "default": "10", "maxLength": 3, "minLength": 1, "title": "Payment Method", "type": "string" }, "due_date": { "anyOf": [ { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Due Date" } }, "title": "IntegrationsFacturacionSupportDocumentsCreateRequestPaymentInput", "type": "object" }, "IntegrationsFacturacionSupportDocumentsCreateRequestResolutionInput": { "additionalProperties": false, "properties": { "resolution_number": { "maxLength": 14, "minLength": 1, "title": "Resolution Number", "type": "string" }, "prefix": { "anyOf": [ { "pattern": "^[A-Za-z0-9]{1,4}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "min_number": { "minimum": 0, "title": "Min Number", "type": "integer" }, "max_number": { "minimum": 0, "title": "Max Number", "type": "integer" }, "start_date": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "title": "Start Date", "type": "string" }, "end_date": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "title": "End Date", "type": "string" }, "technical_key": { "anyOf": [ { "maxLength": 128, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Technical Key" } }, "required": [ "resolution_number", "min_number", "max_number", "start_date", "end_date" ], "title": "IntegrationsFacturacionSupportDocumentsCreateRequestResolutionInput", "type": "object" }, "IntegrationsFacturacionSupportDocumentsCreateRequestSupplierInput": { "additionalProperties": false, "properties": { "name": { "maxLength": 450, "minLength": 1, "title": "Name", "type": "string" }, "trade_name": { "anyOf": [ { "maxLength": 450, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Trade Name" }, "organization_type": { "default": "2", "enum": [ "1", "2" ], "title": "Organization Type", "type": "string" }, "identification_type": { "default": "13", "enum": [ "11", "12", "13", "21", "22", "31", "41", "42", "47", "48", "50", "91" ], "title": "Identification Type", "type": "string" }, "identification_number": { "maxLength": 30, "minLength": 1, "title": "Identification Number", "type": "string" }, "dv": { "anyOf": [ { "pattern": "^[0-9]$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Dv" }, "regime_code": { "anyOf": [ { "pattern": "^(O-13|O-15|O-23|O-47|O-48|O-49|R-99-PN)(;(O-13|O-15|O-23|O-47|O-48|O-49|R-99-PN))*$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Regime Code" }, "tax_code": { "anyOf": [ { "enum": [ "01", "04", "ZA", "ZZ" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Tax Code" }, "email": { "anyOf": [ { "pattern": "^[^\\s@]{1,128}@[^\\s@]{1,253}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Email" }, "phone": { "anyOf": [ { "maxLength": 30, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Phone" }, "address": { "anyOf": [ { "maxLength": 300, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Address" }, "city_code": { "anyOf": [ { "pattern": "^[0-9]{5}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "City Code" }, "department_code": { "anyOf": [ { "pattern": "^[0-9]{2}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Department Code" }, "postal_code": { "anyOf": [ { "pattern": "^[0-9A-Za-z]{6}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Postal Code" }, "country_code": { "default": "CO", "pattern": "^[A-Z]{2}$", "title": "Country Code", "type": "string" }, "origin": { "default": "10", "enum": [ "10", "11" ], "title": "Origin", "type": "string" } }, "required": [ "name", "identification_number" ], "title": "IntegrationsFacturacionSupportDocumentsCreateRequestSupplierInput", "type": "object" }, "IntegrationsFacturacionSupportDocumentsCreateRequestSupportItemInput": { "additionalProperties": false, "properties": { "code": { "anyOf": [ { "maxLength": 50, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Code" }, "description": { "maxLength": 300, "minLength": 1, "title": "Description", "type": "string" }, "quantity": { "exclusiveMinimum": 0, "title": "Quantity", "type": "number" }, "unit_code": { "default": "94", "maxLength": 5, "minLength": 1, "title": "Unit Code", "type": "string" }, "price": { "minimum": 0, "title": "Price", "type": "number" }, "discount_percentage": { "anyOf": [ { "maximum": 100, "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "title": "Discount Percentage" }, "discount_amount": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "title": "Discount Amount" }, "taxes": { "items": { "$ref": "#/components/schemas/IntegrationsFacturacionSupportDocumentsCreateRequestTaxInput" }, "maxItems": 10, "title": "Taxes", "type": "array" }, "withholdings": { "items": { "$ref": "#/components/schemas/IntegrationsFacturacionSupportDocumentsCreateRequestTaxInput" }, "maxItems": 10, "title": "Withholdings", "type": "array" }, "brand_name": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Brand Name" }, "model_name": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Model Name" }, "note": { "anyOf": [ { "maxLength": 5000, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Note" }, "period_description_code": { "default": "1", "enum": [ "1", "2" ], "title": "Period Description Code", "type": "string" }, "period_start_date": { "anyOf": [ { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Period Start Date" }, "period_end_date": { "anyOf": [ { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Period End Date" } }, "required": [ "description", "quantity", "price" ], "title": "IntegrationsFacturacionSupportDocumentsCreateRequestSupportItemInput", "type": "object" }, "IntegrationsFacturacionSupportDocumentsCreateRequestTaxInput": { "additionalProperties": false, "properties": { "tax_code": { "maxLength": 2, "minLength": 2, "title": "Tax Code", "type": "string" }, "percentage": { "maximum": 100, "minimum": 0, "title": "Percentage", "type": "number" }, "taxable_amount": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "title": "Taxable Amount" }, "amount": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "title": "Amount" } }, "required": [ "tax_code", "percentage" ], "title": "IntegrationsFacturacionSupportDocumentsCreateRequestTaxInput", "type": "object" }, "IntegrationsFacturacionSupportDocumentsCreateRequestTotalsInput": { "additionalProperties": false, "properties": { "gross_total": { "minimum": 0, "title": "Gross Total", "type": "number" }, "taxable_total": { "minimum": 0, "title": "Taxable Total", "type": "number" }, "tax_total": { "minimum": 0, "title": "Tax Total", "type": "number" }, "discount_total": { "default": 0, "minimum": 0, "title": "Discount Total", "type": "number" }, "charge_total": { "default": 0, "minimum": 0, "title": "Charge Total", "type": "number" }, "advance_total": { "default": 0, "minimum": 0, "title": "Advance Total", "type": "number" }, "payable_total": { "minimum": 0, "title": "Payable Total", "type": "number" } }, "required": [ "gross_total", "taxable_total", "tax_total", "payable_total" ], "title": "IntegrationsFacturacionSupportDocumentsCreateRequestTotalsInput", "type": "object" }, "IntegrationsFacturacionSupportDocumentsCreateRequest": { "additionalProperties": false, "properties": { "number": { "minimum": 1, "title": "Number", "type": "integer" }, "prefix": { "anyOf": [ { "pattern": "^[A-Za-z0-9]{1,4}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "notes": { "items": { "type": "string" }, "maxItems": 10, "title": "Notes", "type": "array" }, "currency_code": { "default": "COP", "pattern": "^[A-Z]{3}$", "title": "Currency Code", "type": "string" }, "exchange_rate": { "anyOf": [ { "exclusiveMinimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "title": "Exchange Rate" }, "exchange_rate_date": { "anyOf": [ { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Exchange Rate Date" }, "order_reference": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsFacturacionSupportDocumentsCreateRequestOrderReferenceInput" }, { "type": "null" } ], "default": null }, "payments": { "items": { "$ref": "#/components/schemas/IntegrationsFacturacionSupportDocumentsCreateRequestPaymentInput" }, "maxItems": 5, "minItems": 1, "title": "Payments", "type": "array" }, "discounts_and_charges": { "items": { "$ref": "#/components/schemas/IntegrationsFacturacionSupportDocumentsCreateRequestAdjustmentInput" }, "maxItems": 20, "title": "Discounts And Charges", "type": "array" }, "total_amounts": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsFacturacionSupportDocumentsCreateRequestTotalsInput" }, { "type": "null" } ], "default": null }, "resolution": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsFacturacionSupportDocumentsCreateRequestResolutionInput" }, { "type": "null" } ], "default": null }, "issue_date": { "anyOf": [ { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Issue Date" }, "supplier": { "$ref": "#/components/schemas/IntegrationsFacturacionSupportDocumentsCreateRequestSupplierInput" }, "items": { "items": { "$ref": "#/components/schemas/IntegrationsFacturacionSupportDocumentsCreateRequestSupportItemInput" }, "maxItems": 500, "minItems": 1, "title": "Items", "type": "array" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "number", "payments", "supplier", "items" ], "title": "IntegrationsFacturacionSupportDocumentsCreateRequest", "type": "object" }, "IntegrationsFacturacionSupportDocumentsCreateResponse": { "type": "object", "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "job_id": { "type": "string" }, "safe_error_code": { "type": "string" } }, "required": [ "invocation_id", "status", "job_id" ], "additionalProperties": false, "title": "IntegrationsFacturacionSupportDocumentsCreateResponse" }, "IntegrationsGdriveDrivesListRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9_\\-=+/]{1,2048}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsGdriveDrivesListRequest", "type": "object" }, "IntegrationsGdriveDrivesListResponseDriveItem": { "additionalProperties": false, "properties": { "drive_id": { "title": "Drive Id", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "required": [ "drive_id", "name" ], "title": "IntegrationsGdriveDrivesListResponseDriveItem", "type": "object" }, "IntegrationsGdriveDrivesListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsGdriveDrivesListResponseDriveItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsGdriveDrivesListResponse", "type": "object" }, "IntegrationsGdriveFilesGetRequest": { "additionalProperties": false, "properties": { "file_id": { "pattern": "^[A-Za-z0-9_\\-]{1,256}$", "title": "File Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "file_id" ], "title": "IntegrationsGdriveFilesGetRequest", "type": "object" }, "IntegrationsGdriveFilesGetResponse": { "additionalProperties": false, "properties": { "file_id": { "title": "File Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "mime_type": { "title": "Mime Type", "type": "string" }, "is_folder": { "title": "Is Folder", "type": "boolean" }, "size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Size" }, "modified_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Modified At" }, "content_hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content Hash" }, "web_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Web Url" }, "drive_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Drive Id" }, "importable": { "title": "Importable", "type": "boolean" }, "export_mime_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Export Mime Type" }, "shortcut_target_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Shortcut Target Id" } }, "required": [ "file_id", "name", "mime_type", "is_folder", "size", "modified_at", "content_hash", "web_url", "drive_id", "importable", "export_mime_type", "shortcut_target_id" ], "title": "IntegrationsGdriveFilesGetResponse", "type": "object" }, "IntegrationsGdriveFilesImportRequest": { "additionalProperties": false, "properties": { "file_id": { "pattern": "^[A-Za-z0-9_\\-]{1,256}$", "title": "File Id", "type": "string" }, "folder_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Folder Id" }, "file_name": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "File Name" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "file_id" ], "title": "IntegrationsGdriveFilesImportRequest", "type": "object" }, "IntegrationsGdriveFilesImportResponse": { "type": "object", "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "job_id": { "type": "string" }, "safe_error_code": { "type": "string" } }, "required": [ "invocation_id", "status", "job_id" ], "additionalProperties": false, "title": "IntegrationsGdriveFilesImportResponse" }, "IntegrationsGdriveFilesListRequest": { "additionalProperties": false, "properties": { "folder_id": { "default": "root", "pattern": "^[A-Za-z0-9_\\-]{1,256}$", "title": "Folder Id", "type": "string" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9_\\-=+/]{1,2048}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsGdriveFilesListRequest", "type": "object" }, "IntegrationsGdriveFilesListResponseFileItem": { "additionalProperties": false, "properties": { "file_id": { "title": "File Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "mime_type": { "title": "Mime Type", "type": "string" }, "is_folder": { "title": "Is Folder", "type": "boolean" }, "size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Size" }, "modified_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Modified At" }, "content_hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content Hash" }, "web_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Web Url" }, "drive_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Drive Id" }, "importable": { "title": "Importable", "type": "boolean" }, "export_mime_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Export Mime Type" }, "shortcut_target_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Shortcut Target Id" } }, "required": [ "file_id", "name", "mime_type", "is_folder", "size", "modified_at", "content_hash", "web_url", "drive_id", "importable", "export_mime_type", "shortcut_target_id" ], "title": "IntegrationsGdriveFilesListResponseFileItem", "type": "object" }, "IntegrationsGdriveFilesListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsGdriveFilesListResponseFileItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsGdriveFilesListResponse", "type": "object" }, "IntegrationsGdriveFilesUploadRequest": { "additionalProperties": false, "properties": { "document_id": { "title": "Document Id", "type": "string" }, "folder_id": { "pattern": "^[A-Za-z0-9_\\-]{1,256}$", "title": "Folder Id", "type": "string" }, "file_name": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "File Name" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "document_id", "folder_id" ], "title": "IntegrationsGdriveFilesUploadRequest", "type": "object" }, "IntegrationsGdriveFilesUploadResponse": { "type": "object", "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "job_id": { "type": "string" }, "safe_error_code": { "type": "string" } }, "required": [ "invocation_id", "status", "job_id" ], "additionalProperties": false, "title": "IntegrationsGdriveFilesUploadResponse" }, "IntegrationsGmailAttachmentsImportRequest": { "additionalProperties": false, "properties": { "message_id": { "pattern": "^[A-Za-z0-9_\\-]{1,128}$", "title": "Message Id", "type": "string" }, "attachment_id": { "pattern": "^[A-Za-z0-9_\\-=]{1,2048}$", "title": "Attachment Id", "type": "string" }, "folder_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Folder Id" }, "file_name": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "File Name" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "message_id", "attachment_id" ], "title": "IntegrationsGmailAttachmentsImportRequest", "type": "object" }, "IntegrationsGmailAttachmentsImportResponse": { "type": "object", "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "job_id": { "type": "string" }, "safe_error_code": { "type": "string" } }, "required": [ "invocation_id", "status", "job_id" ], "additionalProperties": false, "title": "IntegrationsGmailAttachmentsImportResponse" }, "IntegrationsGmailAttachmentsListRequest": { "additionalProperties": false, "properties": { "message_id": { "pattern": "^[A-Za-z0-9_\\-]{1,128}$", "title": "Message Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "message_id" ], "title": "IntegrationsGmailAttachmentsListRequest", "type": "object" }, "IntegrationsGmailAttachmentsListResponseAttachmentItem": { "additionalProperties": false, "properties": { "attachment_id": { "title": "Attachment Id", "type": "string" }, "part_id": { "title": "Part Id", "type": "string" }, "file_name": { "title": "File Name", "type": "string" }, "content_type": { "title": "Content Type", "type": "string" }, "size": { "title": "Size", "type": "integer" }, "inline": { "title": "Inline", "type": "boolean" }, "importable": { "title": "Importable", "type": "boolean" } }, "required": [ "attachment_id", "part_id", "file_name", "content_type", "size", "inline", "importable" ], "title": "IntegrationsGmailAttachmentsListResponseAttachmentItem", "type": "object" }, "IntegrationsGmailAttachmentsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsGmailAttachmentsListResponseAttachmentItem" }, "title": "Items", "type": "array" }, "truncated": { "title": "Truncated", "type": "boolean" } }, "required": [ "items", "truncated" ], "title": "IntegrationsGmailAttachmentsListResponse", "type": "object" }, "IntegrationsGmailLabelsListRequest": { "additionalProperties": false, "properties": { "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsGmailLabelsListRequest", "type": "object" }, "IntegrationsGmailLabelsListResponseLabelItem": { "additionalProperties": false, "properties": { "label_id": { "title": "Label Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "label_type": { "title": "Label Type", "type": "string" }, "message_list_visibility": { "title": "Message List Visibility", "type": "string" }, "label_list_visibility": { "title": "Label List Visibility", "type": "string" } }, "required": [ "label_id", "name", "label_type", "message_list_visibility", "label_list_visibility" ], "title": "IntegrationsGmailLabelsListResponseLabelItem", "type": "object" }, "IntegrationsGmailLabelsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsGmailLabelsListResponseLabelItem" }, "title": "Items", "type": "array" }, "truncated": { "title": "Truncated", "type": "boolean" } }, "required": [ "items", "truncated" ], "title": "IntegrationsGmailLabelsListResponse", "type": "object" }, "IntegrationsGmailMessagesGetRequest": { "additionalProperties": false, "properties": { "message_id": { "pattern": "^[A-Za-z0-9_\\-]{1,128}$", "title": "Message Id", "type": "string" }, "include_html": { "default": false, "title": "Include Html", "type": "boolean" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "message_id" ], "title": "IntegrationsGmailMessagesGetRequest", "type": "object" }, "IntegrationsGmailMessagesGetResponse": { "additionalProperties": false, "properties": { "message_id": { "title": "Message Id", "type": "string" }, "thread_id": { "title": "Thread Id", "type": "string" }, "internet_message_id": { "title": "Internet Message Id", "type": "string" }, "subject": { "title": "Subject", "type": "string" }, "sender": { "title": "Sender", "type": "string" }, "recipients": { "items": { "type": "string" }, "title": "Recipients", "type": "array" }, "cc": { "items": { "type": "string" }, "title": "Cc", "type": "array" }, "received_at": { "title": "Received At", "type": "string" }, "is_read": { "title": "Is Read", "type": "boolean" }, "label_ids": { "items": { "type": "string" }, "title": "Label Ids", "type": "array" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Text" }, "text_truncated": { "title": "Text Truncated", "type": "boolean" }, "html": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Html" }, "html_truncated": { "title": "Html Truncated", "type": "boolean" }, "has_attachments": { "title": "Has Attachments", "type": "boolean" } }, "required": [ "message_id", "thread_id", "internet_message_id", "subject", "sender", "recipients", "cc", "received_at", "is_read", "label_ids", "text", "text_truncated", "html", "html_truncated", "has_attachments" ], "title": "IntegrationsGmailMessagesGetResponse", "type": "object" }, "IntegrationsGmailMessagesReplyRequest": { "additionalProperties": false, "properties": { "message_id": { "pattern": "^[A-Za-z0-9_\\-]{1,128}$", "title": "Message Id", "type": "string" }, "text": { "maxLength": 20000, "minLength": 1, "title": "Text", "type": "string" }, "reply_all": { "default": false, "title": "Reply All", "type": "boolean" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "message_id", "text" ], "title": "IntegrationsGmailMessagesReplyRequest", "type": "object" }, "IntegrationsGmailMessagesReplyResponse": { "type": "object", "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "job_id": { "type": "string" }, "safe_error_code": { "type": "string" } }, "required": [ "invocation_id", "status", "job_id" ], "additionalProperties": false, "title": "IntegrationsGmailMessagesReplyResponse" }, "IntegrationsGmailMessagesSearchRequest": { "additionalProperties": false, "properties": { "label_id": { "default": "INBOX", "pattern": "^[A-Za-z0-9_\\-]{1,128}$", "title": "Label Id", "type": "string" }, "since": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO date (YYYY-MM-DD)", "title": "Since" }, "before": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO date (YYYY-MM-DD)", "title": "Before" }, "from_address": { "anyOf": [ { "pattern": "^[^\\x00-\\x1f\\x7f\\\"\\\\'\\s]{3,320}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "From Address" }, "subject_contains": { "anyOf": [ { "pattern": "^[^\\x00-\\x1f\\x7f\\\"\\\\]{1,200}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Subject Contains" }, "unread_only": { "default": false, "title": "Unread Only", "type": "boolean" }, "has_attachment": { "default": false, "title": "Has Attachment", "type": "boolean" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9_\\-=.%]{1,512}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 20, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsGmailMessagesSearchRequest", "type": "object" }, "IntegrationsGmailMessagesSearchResponseMessageSummary": { "additionalProperties": false, "properties": { "message_id": { "title": "Message Id", "type": "string" }, "thread_id": { "title": "Thread Id", "type": "string" }, "internet_message_id": { "title": "Internet Message Id", "type": "string" }, "subject": { "title": "Subject", "type": "string" }, "sender": { "title": "Sender", "type": "string" }, "received_at": { "title": "Received At", "type": "string" }, "is_read": { "title": "Is Read", "type": "boolean" }, "label_ids": { "items": { "type": "string" }, "title": "Label Ids", "type": "array" }, "preview": { "title": "Preview", "type": "string" } }, "required": [ "message_id", "thread_id", "internet_message_id", "subject", "sender", "received_at", "is_read", "label_ids", "preview" ], "title": "IntegrationsGmailMessagesSearchResponseMessageSummary", "type": "object" }, "IntegrationsGmailMessagesSearchResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsGmailMessagesSearchResponseMessageSummary" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsGmailMessagesSearchResponse", "type": "object" }, "IntegrationsGsheetsSpreadsheetsExportRequest": { "additionalProperties": false, "properties": { "spreadsheet_id": { "pattern": "^[A-Za-z0-9_\\-]{10,128}$", "title": "Spreadsheet Id", "type": "string" }, "format": { "default": "xlsx", "enum": [ "xlsx", "ods", "pdf", "csv", "tsv" ], "title": "Format", "type": "string" }, "folder_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Folder Id" }, "file_name": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "File Name" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "spreadsheet_id" ], "title": "IntegrationsGsheetsSpreadsheetsExportRequest", "type": "object" }, "IntegrationsGsheetsSpreadsheetsExportResponse": { "type": "object", "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "job_id": { "type": "string" }, "safe_error_code": { "type": "string" } }, "required": [ "invocation_id", "status", "job_id" ], "additionalProperties": false, "title": "IntegrationsGsheetsSpreadsheetsExportResponse" }, "IntegrationsGsheetsSpreadsheetsListRequest": { "additionalProperties": false, "properties": { "name_contains": { "anyOf": [ { "pattern": "^[^\\x00-\\x1f\\x7f\"\\\\]{1,200}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Name Contains" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9_\\-=~.%!*'()+/:,]{1,2000}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 20, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsGsheetsSpreadsheetsListRequest", "type": "object" }, "IntegrationsGsheetsSpreadsheetsListResponseSpreadsheetSummary": { "additionalProperties": false, "properties": { "spreadsheet_id": { "title": "Spreadsheet Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "modified_at": { "title": "Modified At", "type": "string" }, "web_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Web Url" } }, "required": [ "spreadsheet_id", "name", "modified_at", "web_url" ], "title": "IntegrationsGsheetsSpreadsheetsListResponseSpreadsheetSummary", "type": "object" }, "IntegrationsGsheetsSpreadsheetsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsGsheetsSpreadsheetsListResponseSpreadsheetSummary" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsGsheetsSpreadsheetsListResponse", "type": "object" }, "IntegrationsGsheetsValuesAppendRequest": { "additionalProperties": false, "properties": { "spreadsheet_id": { "pattern": "^[A-Za-z0-9_\\-]{10,128}$", "title": "Spreadsheet Id", "type": "string" }, "range": { "maxLength": 200, "minLength": 1, "pattern": "^(?:(?:'(?:[^\\x00-\\x1f\\x7f\\[\\]*?/\\\\:']|''){1,200}'|[^\\s\\x00-\\x1f\\x7f\\[\\]*?/\\\\:!']{1,100})(?:!(?:[A-Za-z]{1,3}[0-9]{0,7}|[0-9]{1,7})(?::(?:[A-Za-z]{1,3}[0-9]{0,7}|[0-9]{1,7}))?)?|(?:[A-Za-z]{1,3}[0-9]{0,7}|[0-9]{1,7})(?::(?:[A-Za-z]{1,3}[0-9]{0,7}|[0-9]{1,7}))?)$", "title": "Range", "type": "string" }, "rows": { "items": { "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "maxItems": 100, "type": "array" }, "maxItems": 500, "minItems": 1, "title": "Rows", "type": "array" }, "value_input_option": { "default": "USER_ENTERED", "enum": [ "USER_ENTERED", "RAW" ], "title": "Value Input Option", "type": "string" }, "insert_data_option": { "default": "OVERWRITE", "enum": [ "OVERWRITE", "INSERT_ROWS" ], "title": "Insert Data Option", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "spreadsheet_id", "range", "rows" ], "title": "IntegrationsGsheetsValuesAppendRequest", "type": "object" }, "IntegrationsGsheetsValuesAppendResponse": { "type": "object", "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "job_id": { "type": "string" }, "safe_error_code": { "type": "string" } }, "required": [ "invocation_id", "status", "job_id" ], "additionalProperties": false, "title": "IntegrationsGsheetsValuesAppendResponse" }, "IntegrationsGsheetsValuesReadRequest": { "additionalProperties": false, "properties": { "spreadsheet_id": { "pattern": "^[A-Za-z0-9_\\-]{10,128}$", "title": "Spreadsheet Id", "type": "string" }, "range": { "maxLength": 200, "minLength": 1, "pattern": "^(?:(?:'(?:[^\\x00-\\x1f\\x7f\\[\\]*?/\\\\:']|''){1,200}'|[^\\s\\x00-\\x1f\\x7f\\[\\]*?/\\\\:!']{1,100})(?:!(?:[A-Za-z]{1,3}[0-9]{0,7}|[0-9]{1,7})(?::(?:[A-Za-z]{1,3}[0-9]{0,7}|[0-9]{1,7}))?)?|(?:[A-Za-z]{1,3}[0-9]{0,7}|[0-9]{1,7})(?::(?:[A-Za-z]{1,3}[0-9]{0,7}|[0-9]{1,7}))?)$", "title": "Range", "type": "string" }, "value_render_option": { "default": "FORMATTED_VALUE", "enum": [ "FORMATTED_VALUE", "UNFORMATTED_VALUE", "FORMULA" ], "title": "Value Render Option", "type": "string" }, "date_time_render_option": { "default": "FORMATTED_STRING", "enum": [ "FORMATTED_STRING", "SERIAL_NUMBER" ], "title": "Date Time Render Option", "type": "string" }, "max_rows": { "default": 200, "maximum": 1000, "minimum": 1, "title": "Max Rows", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "spreadsheet_id", "range" ], "title": "IntegrationsGsheetsValuesReadRequest", "type": "object" }, "IntegrationsGsheetsValuesReadResponse": { "additionalProperties": false, "properties": { "range": { "title": "Range", "type": "string" }, "rows": { "items": { "items": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "type": "array" }, "title": "Rows", "type": "array" }, "row_count": { "title": "Row Count", "type": "integer" }, "truncated": { "title": "Truncated", "type": "boolean" } }, "required": [ "range", "rows", "row_count", "truncated" ], "title": "IntegrationsGsheetsValuesReadResponse", "type": "object" }, "IntegrationsImapAttachmentsImportRequest": { "additionalProperties": false, "properties": { "mailbox": { "default": "INBOX", "pattern": "^[^\\x00-\\x1f\\x7f\\\"\\\\]{1,255}$", "title": "Mailbox", "type": "string" }, "uid": { "maximum": 4294967295, "minimum": 1, "title": "Uid", "type": "integer" }, "part_id": { "pattern": "^[1-9][0-9]{0,3}(\\.[1-9][0-9]{0,3}){0,7}$", "title": "Part Id", "type": "string" }, "folder_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Folder Id" }, "file_name": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "File Name" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "uid", "part_id" ], "title": "IntegrationsImapAttachmentsImportRequest", "type": "object" }, "IntegrationsImapAttachmentsImportResponse": { "type": "object", "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "job_id": { "type": "string" }, "safe_error_code": { "type": "string" } }, "required": [ "invocation_id", "status", "job_id" ], "additionalProperties": false, "title": "IntegrationsImapAttachmentsImportResponse" }, "IntegrationsImapAttachmentsListRequest": { "additionalProperties": false, "properties": { "mailbox": { "default": "INBOX", "pattern": "^[^\\x00-\\x1f\\x7f\\\"\\\\]{1,255}$", "title": "Mailbox", "type": "string" }, "uid": { "maximum": 4294967295, "minimum": 1, "title": "Uid", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "uid" ], "title": "IntegrationsImapAttachmentsListRequest", "type": "object" }, "IntegrationsImapAttachmentsListResponseAttachmentItem": { "additionalProperties": false, "properties": { "part_id": { "title": "Part Id", "type": "string" }, "file_name": { "title": "File Name", "type": "string" }, "content_type": { "title": "Content Type", "type": "string" }, "size": { "title": "Size", "type": "integer" }, "inline": { "title": "Inline", "type": "boolean" } }, "required": [ "part_id", "file_name", "content_type", "size", "inline" ], "title": "IntegrationsImapAttachmentsListResponseAttachmentItem", "type": "object" }, "IntegrationsImapAttachmentsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsImapAttachmentsListResponseAttachmentItem" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "IntegrationsImapAttachmentsListResponse", "type": "object" }, "IntegrationsImapMailboxesListRequest": { "additionalProperties": false, "properties": { "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsImapMailboxesListRequest", "type": "object" }, "IntegrationsImapMailboxesListResponseMailboxItem": { "additionalProperties": false, "properties": { "name": { "title": "Name", "type": "string" }, "delimiter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Delimiter" }, "attributes": { "items": { "type": "string" }, "title": "Attributes", "type": "array" }, "selectable": { "title": "Selectable", "type": "boolean" } }, "required": [ "name", "delimiter", "attributes", "selectable" ], "title": "IntegrationsImapMailboxesListResponseMailboxItem", "type": "object" }, "IntegrationsImapMailboxesListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsImapMailboxesListResponseMailboxItem" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "IntegrationsImapMailboxesListResponse", "type": "object" }, "IntegrationsImapMessagesGetRequest": { "additionalProperties": false, "properties": { "mailbox": { "default": "INBOX", "pattern": "^[^\\x00-\\x1f\\x7f\\\"\\\\]{1,255}$", "title": "Mailbox", "type": "string" }, "uid": { "maximum": 4294967295, "minimum": 1, "title": "Uid", "type": "integer" }, "include_html": { "default": false, "title": "Include Html", "type": "boolean" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "uid" ], "title": "IntegrationsImapMessagesGetRequest", "type": "object" }, "IntegrationsImapMessagesGetResponse": { "additionalProperties": false, "properties": { "uid": { "title": "Uid", "type": "integer" }, "message_id": { "title": "Message Id", "type": "string" }, "subject": { "title": "Subject", "type": "string" }, "sender": { "title": "Sender", "type": "string" }, "recipients": { "items": { "type": "string" }, "title": "Recipients", "type": "array" }, "cc": { "items": { "type": "string" }, "title": "Cc", "type": "array" }, "date": { "title": "Date", "type": "string" }, "size": { "title": "Size", "type": "integer" }, "seen": { "title": "Seen", "type": "boolean" }, "flags": { "items": { "type": "string" }, "title": "Flags", "type": "array" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Text" }, "text_truncated": { "title": "Text Truncated", "type": "boolean" }, "html": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Html" }, "html_truncated": { "title": "Html Truncated", "type": "boolean" }, "has_attachments": { "title": "Has Attachments", "type": "boolean" }, "attachment_count": { "title": "Attachment Count", "type": "integer" }, "truncated": { "title": "Truncated", "type": "boolean" } }, "required": [ "uid", "message_id", "subject", "sender", "recipients", "cc", "date", "size", "seen", "flags", "text", "text_truncated", "html", "html_truncated", "has_attachments", "attachment_count", "truncated" ], "title": "IntegrationsImapMessagesGetResponse", "type": "object" }, "IntegrationsImapMessagesSearchRequest": { "additionalProperties": false, "properties": { "mailbox": { "default": "INBOX", "pattern": "^[^\\x00-\\x1f\\x7f\\\"\\\\]{1,255}$", "title": "Mailbox", "type": "string" }, "since": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO date (YYYY-MM-DD)", "title": "Since" }, "before": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO date (YYYY-MM-DD)", "title": "Before" }, "from_contains": { "anyOf": [ { "pattern": "^[^\\x00-\\x1f\\x7f\\\"\\\\]{1,200}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "From Contains" }, "subject_contains": { "anyOf": [ { "pattern": "^[^\\x00-\\x1f\\x7f\\\"\\\\]{1,200}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Subject Contains" }, "unseen_only": { "default": false, "title": "Unseen Only", "type": "boolean" }, "cursor": { "anyOf": [ { "pattern": "^[0-9]{1,20}:[0-9]{1,20}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 20, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsImapMessagesSearchRequest", "type": "object" }, "IntegrationsImapMessagesSearchResponseMessageSummary": { "additionalProperties": false, "properties": { "uid": { "title": "Uid", "type": "integer" }, "message_id": { "title": "Message Id", "type": "string" }, "subject": { "title": "Subject", "type": "string" }, "sender": { "title": "Sender", "type": "string" }, "date": { "title": "Date", "type": "string" }, "size": { "title": "Size", "type": "integer" }, "seen": { "title": "Seen", "type": "boolean" }, "flags": { "items": { "type": "string" }, "title": "Flags", "type": "array" } }, "required": [ "uid", "message_id", "subject", "sender", "date", "size", "seen", "flags" ], "title": "IntegrationsImapMessagesSearchResponseMessageSummary", "type": "object" }, "IntegrationsImapMessagesSearchResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsImapMessagesSearchResponseMessageSummary" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "uid_validity": { "title": "Uid Validity", "type": "integer" }, "truncated": { "title": "Truncated", "type": "boolean" } }, "required": [ "items", "next_cursor", "uid_validity", "truncated" ], "title": "IntegrationsImapMessagesSearchResponse", "type": "object" }, "IntegrationsKlaviyoAccountGetRequest": { "additionalProperties": false, "properties": { "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsKlaviyoAccountGetRequest", "type": "object" }, "IntegrationsKlaviyoAccountGetResponse": { "additionalProperties": false, "properties": { "account_id": { "title": "Account Id", "type": "string" }, "organization_name": { "title": "Organization Name", "type": "string" }, "default_sender_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default Sender Name" }, "default_sender_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default Sender Email" }, "website_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website Url" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Timezone" }, "preferred_currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Preferred Currency" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale" }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Industry" }, "test_account": { "title": "Test Account", "type": "boolean" } }, "required": [ "account_id", "organization_name", "default_sender_name", "default_sender_email", "website_url", "timezone", "preferred_currency", "locale", "industry", "test_account" ], "title": "IntegrationsKlaviyoAccountGetResponse", "type": "object" }, "IntegrationsKlaviyoCampaignMessagesAssignTemplateRequest": { "additionalProperties": false, "properties": { "campaign_message_id": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,63}$", "title": "Campaign Message Id", "type": "string" }, "template_id": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,63}$", "title": "Template Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "campaign_message_id", "template_id" ], "title": "IntegrationsKlaviyoCampaignMessagesAssignTemplateRequest", "type": "object" }, "IntegrationsKlaviyoCampaignMessagesAssignTemplateResponse": { "type": "object", "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "job_id": { "type": "string" }, "safe_error_code": { "type": "string" } }, "required": [ "invocation_id", "status", "job_id" ], "additionalProperties": false, "title": "IntegrationsKlaviyoCampaignMessagesAssignTemplateResponse" }, "IntegrationsKlaviyoCampaignMessagesGetRequest": { "additionalProperties": false, "properties": { "campaign_message_id": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,63}$", "title": "Campaign Message Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "campaign_message_id" ], "title": "IntegrationsKlaviyoCampaignMessagesGetRequest", "type": "object" }, "IntegrationsKlaviyoCampaignMessagesGetResponseMessageContent": { "additionalProperties": false, "properties": { "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subject" }, "preview_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Preview Text" }, "from_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From Email" }, "from_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From Label" }, "reply_to_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reply To Email" }, "cc_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cc Email" }, "bcc_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bcc Email" }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Body" }, "media_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Media Url" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" } }, "required": [ "subject", "preview_text", "from_email", "from_label", "reply_to_email", "cc_email", "bcc_email", "body", "media_url", "title" ], "title": "IntegrationsKlaviyoCampaignMessagesGetResponseMessageContent", "type": "object" }, "IntegrationsKlaviyoCampaignMessagesGetResponseRenderOptions": { "additionalProperties": false, "properties": { "shorten_links": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Shorten Links" }, "add_org_prefix": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Add Org Prefix" }, "add_info_link": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Add Info Link" }, "add_opt_out_language": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Add Opt Out Language" } }, "required": [ "shorten_links", "add_org_prefix", "add_info_link", "add_opt_out_language" ], "title": "IntegrationsKlaviyoCampaignMessagesGetResponseRenderOptions", "type": "object" }, "IntegrationsKlaviyoCampaignMessagesGetResponseSendTime": { "additionalProperties": false, "properties": { "datetime": { "title": "Datetime", "type": "string" }, "is_local": { "title": "Is Local", "type": "boolean" } }, "required": [ "datetime", "is_local" ], "title": "IntegrationsKlaviyoCampaignMessagesGetResponseSendTime", "type": "object" }, "IntegrationsKlaviyoCampaignMessagesGetResponse": { "additionalProperties": false, "properties": { "campaign_message_id": { "title": "Campaign Message Id", "type": "string" }, "campaign_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Campaign Id" }, "channel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignMessagesGetResponseMessageContent" }, { "type": "null" } ] }, "render_options": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignMessagesGetResponseRenderOptions" }, { "type": "null" } ] }, "template_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Id" }, "send_times": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignMessagesGetResponseSendTime" }, "title": "Send Times", "type": "array" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "campaign_message_id", "campaign_id", "channel", "label", "content", "render_options", "template_id", "send_times", "created_at", "updated_at" ], "title": "IntegrationsKlaviyoCampaignMessagesGetResponse", "type": "object" }, "IntegrationsKlaviyoCampaignMessagesListRequest": { "additionalProperties": false, "properties": { "campaign_id": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,63}$", "title": "Campaign Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "campaign_id" ], "title": "IntegrationsKlaviyoCampaignMessagesListRequest", "type": "object" }, "IntegrationsKlaviyoCampaignMessagesListResponseCampaignMessageItem": { "additionalProperties": false, "properties": { "campaign_message_id": { "title": "Campaign Message Id", "type": "string" }, "campaign_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Campaign Id" }, "channel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignMessagesListResponseMessageContent" }, { "type": "null" } ] }, "render_options": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignMessagesListResponseRenderOptions" }, { "type": "null" } ] }, "template_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Id" }, "send_times": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignMessagesListResponseSendTime" }, "title": "Send Times", "type": "array" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "campaign_message_id", "campaign_id", "channel", "label", "content", "render_options", "template_id", "send_times", "created_at", "updated_at" ], "title": "IntegrationsKlaviyoCampaignMessagesListResponseCampaignMessageItem", "type": "object" }, "IntegrationsKlaviyoCampaignMessagesListResponseMessageContent": { "additionalProperties": false, "properties": { "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subject" }, "preview_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Preview Text" }, "from_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From Email" }, "from_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From Label" }, "reply_to_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reply To Email" }, "cc_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cc Email" }, "bcc_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bcc Email" }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Body" }, "media_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Media Url" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" } }, "required": [ "subject", "preview_text", "from_email", "from_label", "reply_to_email", "cc_email", "bcc_email", "body", "media_url", "title" ], "title": "IntegrationsKlaviyoCampaignMessagesListResponseMessageContent", "type": "object" }, "IntegrationsKlaviyoCampaignMessagesListResponseRenderOptions": { "additionalProperties": false, "properties": { "shorten_links": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Shorten Links" }, "add_org_prefix": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Add Org Prefix" }, "add_info_link": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Add Info Link" }, "add_opt_out_language": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Add Opt Out Language" } }, "required": [ "shorten_links", "add_org_prefix", "add_info_link", "add_opt_out_language" ], "title": "IntegrationsKlaviyoCampaignMessagesListResponseRenderOptions", "type": "object" }, "IntegrationsKlaviyoCampaignMessagesListResponseSendTime": { "additionalProperties": false, "properties": { "datetime": { "title": "Datetime", "type": "string" }, "is_local": { "title": "Is Local", "type": "boolean" } }, "required": [ "datetime", "is_local" ], "title": "IntegrationsKlaviyoCampaignMessagesListResponseSendTime", "type": "object" }, "IntegrationsKlaviyoCampaignMessagesListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignMessagesListResponseCampaignMessageItem" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "IntegrationsKlaviyoCampaignMessagesListResponse", "type": "object" }, "IntegrationsKlaviyoCampaignMessagesUpdateRequestRenderOptionsInput": { "additionalProperties": false, "properties": { "shorten_links": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Shorten Links" }, "add_org_prefix": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Add Org Prefix" }, "add_info_link": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Add Info Link" }, "add_opt_out_language": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Add Opt Out Language" } }, "title": "IntegrationsKlaviyoCampaignMessagesUpdateRequestRenderOptionsInput", "type": "object" }, "IntegrationsKlaviyoCampaignMessagesUpdateRequest": { "additionalProperties": false, "properties": { "campaign_message_id": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,63}$", "title": "Campaign Message Id", "type": "string" }, "channel": { "anyOf": [ { "enum": [ "email", "sms", "mobile_push" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Channel" }, "label": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "title": "Label" }, "subject": { "anyOf": [ { "maxLength": 998, "type": "string" }, { "type": "null" } ], "default": null, "title": "Subject" }, "preview_text": { "anyOf": [ { "maxLength": 998, "type": "string" }, { "type": "null" } ], "default": null, "title": "Preview Text" }, "from_email": { "anyOf": [ { "pattern": "^[^\\s@]{1,128}@[^\\s@]{1,253}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "From Email" }, "from_label": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "title": "From Label" }, "reply_to_email": { "anyOf": [ { "pattern": "^[^\\s@]{1,128}@[^\\s@]{1,253}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Reply To Email" }, "cc_email": { "anyOf": [ { "pattern": "^[^\\s@]{1,128}@[^\\s@]{1,253}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cc Email" }, "bcc_email": { "anyOf": [ { "pattern": "^[^\\s@]{1,128}@[^\\s@]{1,253}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Bcc Email" }, "body": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "type": "null" } ], "default": null, "title": "Body" }, "media_url": { "anyOf": [ { "maxLength": 2048, "type": "string" }, { "type": "null" } ], "default": null, "title": "Media Url" }, "title": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "render_options": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignMessagesUpdateRequestRenderOptionsInput" }, { "type": "null" } ], "default": null }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "campaign_message_id" ], "title": "IntegrationsKlaviyoCampaignMessagesUpdateRequest", "type": "object" }, "IntegrationsKlaviyoCampaignMessagesUpdateResponse": { "type": "object", "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "job_id": { "type": "string" }, "safe_error_code": { "type": "string" } }, "required": [ "invocation_id", "status", "job_id" ], "additionalProperties": false, "title": "IntegrationsKlaviyoCampaignMessagesUpdateResponse" }, "IntegrationsKlaviyoCampaignReportsValuesRequestTimeframe": { "additionalProperties": false, "properties": { "key": { "anyOf": [ { "enum": [ "last_12_months", "last_30_days", "last_365_days", "last_3_months", "last_7_days", "last_90_days", "last_month", "last_week", "last_year", "this_month", "this_week", "this_year", "today", "yesterday" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Key" }, "start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Start" }, "end": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "End" } }, "title": "IntegrationsKlaviyoCampaignReportsValuesRequestTimeframe", "type": "object" }, "IntegrationsKlaviyoCampaignReportsValuesRequest": { "additionalProperties": false, "properties": { "statistics": { "items": { "enum": [ "average_order_value", "bounce_rate", "bounced", "bounced_or_failed", "bounced_or_failed_rate", "click_rate", "click_to_open_rate", "clicks", "clicks_unique", "conversion_rate", "conversion_uniques", "conversion_value", "conversions", "delivered", "delivery_rate", "failed", "failed_rate", "message_segment_count_sum", "open_rate", "opens", "opens_unique", "recipients", "revenue_per_recipient", "spam_complaint_rate", "spam_complaints", "text_message_credit_usage_amount", "text_message_roi", "text_message_spend", "unsubscribe_rate", "unsubscribe_uniques", "unsubscribes" ], "type": "string" }, "maxItems": 40, "minItems": 1, "title": "Statistics", "type": "array" }, "timeframe": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignReportsValuesRequestTimeframe" }, "conversion_metric_id": { "anyOf": [ { "pattern": "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,63}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Conversion Metric Id" }, "send_channels": { "items": { "enum": [ "email", "sms", "mobile_push" ], "type": "string" }, "maxItems": 3, "title": "Send Channels", "type": "array" }, "tag_ids": { "items": { "type": "string" }, "maxItems": 100, "title": "Tag Ids", "type": "array" }, "group_by": { "items": { "enum": [ "campaign_id", "campaign_message_id", "campaign_message_name", "group", "group_name", "send_channel", "tag_id", "tag_name", "text_message_format", "variation", "variation_name" ], "type": "string" }, "maxItems": 11, "title": "Group By", "type": "array" }, "campaign_ids": { "items": { "type": "string" }, "maxItems": 100, "title": "Campaign Ids", "type": "array" }, "campaign_message_ids": { "items": { "type": "string" }, "maxItems": 100, "title": "Campaign Message Ids", "type": "array" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "statistics", "timeframe" ], "title": "IntegrationsKlaviyoCampaignReportsValuesRequest", "type": "object" }, "IntegrationsKlaviyoCampaignReportsValuesResponseReportRow": { "additionalProperties": false, "properties": { "groupings": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "title": "Groupings", "type": "object" }, "statistics": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "title": "Statistics", "type": "object" } }, "required": [ "groupings", "statistics" ], "title": "IntegrationsKlaviyoCampaignReportsValuesResponseReportRow", "type": "object" }, "IntegrationsKlaviyoCampaignReportsValuesResponse": { "additionalProperties": false, "properties": { "rows": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignReportsValuesResponseReportRow" }, "title": "Rows", "type": "array" } }, "required": [ "rows" ], "title": "IntegrationsKlaviyoCampaignReportsValuesResponse", "type": "object" }, "IntegrationsKlaviyoCampaignsCreateRequestAudiencesInput": { "additionalProperties": false, "properties": { "included": { "items": { "type": "string" }, "maxItems": 100, "minItems": 1, "title": "Included", "type": "array" }, "excluded": { "items": { "type": "string" }, "maxItems": 100, "title": "Excluded", "type": "array" } }, "required": [ "included" ], "title": "IntegrationsKlaviyoCampaignsCreateRequestAudiencesInput", "type": "object" }, "IntegrationsKlaviyoCampaignsCreateRequestCampaignMessageInput": { "additionalProperties": false, "properties": { "channel": { "default": "email", "enum": [ "email", "sms", "mobile_push" ], "title": "Channel", "type": "string" }, "label": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "title": "Label" }, "subject": { "anyOf": [ { "maxLength": 998, "type": "string" }, { "type": "null" } ], "default": null, "title": "Subject" }, "preview_text": { "anyOf": [ { "maxLength": 998, "type": "string" }, { "type": "null" } ], "default": null, "title": "Preview Text" }, "from_email": { "anyOf": [ { "pattern": "^[^\\s@]{1,128}@[^\\s@]{1,253}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "From Email" }, "from_label": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "title": "From Label" }, "reply_to_email": { "anyOf": [ { "pattern": "^[^\\s@]{1,128}@[^\\s@]{1,253}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Reply To Email" }, "cc_email": { "anyOf": [ { "pattern": "^[^\\s@]{1,128}@[^\\s@]{1,253}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cc Email" }, "bcc_email": { "anyOf": [ { "pattern": "^[^\\s@]{1,128}@[^\\s@]{1,253}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Bcc Email" }, "body": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "type": "null" } ], "default": null, "title": "Body" }, "media_url": { "anyOf": [ { "maxLength": 2048, "type": "string" }, { "type": "null" } ], "default": null, "title": "Media Url" }, "title": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "render_options": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsCreateRequestRenderOptionsInput" }, { "type": "null" } ], "default": null } }, "title": "IntegrationsKlaviyoCampaignsCreateRequestCampaignMessageInput", "type": "object" }, "IntegrationsKlaviyoCampaignsCreateRequestRenderOptionsInput": { "additionalProperties": false, "properties": { "shorten_links": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Shorten Links" }, "add_org_prefix": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Add Org Prefix" }, "add_info_link": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Add Info Link" }, "add_opt_out_language": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Add Opt Out Language" } }, "title": "IntegrationsKlaviyoCampaignsCreateRequestRenderOptionsInput", "type": "object" }, "IntegrationsKlaviyoCampaignsCreateRequestSendStrategyInput": { "additionalProperties": false, "properties": { "method": { "default": "static", "enum": [ "static", "immediate", "throttled", "smart_send_time" ], "title": "Method", "type": "string" }, "datetime": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Datetime" }, "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Date" }, "throttle_percentage": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Throttle Percentage" }, "is_local": { "default": false, "title": "Is Local", "type": "boolean" }, "send_past_recipients_immediately": { "default": false, "title": "Send Past Recipients Immediately", "type": "boolean" } }, "title": "IntegrationsKlaviyoCampaignsCreateRequestSendStrategyInput", "type": "object" }, "IntegrationsKlaviyoCampaignsCreateRequestTrackingOptionsInput": { "additionalProperties": false, "properties": { "add_tracking_params": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Add Tracking Params" }, "custom_tracking_params": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsCreateRequestTrackingParamInput" }, "maxItems": 20, "title": "Custom Tracking Params", "type": "array" }, "is_tracking_opens": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Is Tracking Opens" }, "is_tracking_clicks": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Is Tracking Clicks" } }, "title": "IntegrationsKlaviyoCampaignsCreateRequestTrackingOptionsInput", "type": "object" }, "IntegrationsKlaviyoCampaignsCreateRequestTrackingParamInput": { "additionalProperties": false, "properties": { "type": { "default": "static", "enum": [ "static", "dynamic" ], "title": "Type", "type": "string" }, "name": { "maxLength": 128, "minLength": 1, "title": "Name", "type": "string" }, "value": { "maxLength": 512, "minLength": 1, "title": "Value", "type": "string" } }, "required": [ "name", "value" ], "title": "IntegrationsKlaviyoCampaignsCreateRequestTrackingParamInput", "type": "object" }, "IntegrationsKlaviyoCampaignsCreateRequest": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "title": "Name", "type": "string" }, "audiences": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsCreateRequestAudiencesInput" }, "messages": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsCreateRequestCampaignMessageInput" }, "maxItems": 10, "minItems": 1, "title": "Messages", "type": "array" }, "send_strategy": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsCreateRequestSendStrategyInput" }, { "type": "null" } ], "default": null }, "use_smart_sending": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Use Smart Sending" }, "tracking_options": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsCreateRequestTrackingOptionsInput" }, { "type": "null" } ], "default": null }, "template_id": { "anyOf": [ { "pattern": "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,63}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Template Id" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "name", "audiences", "messages" ], "title": "IntegrationsKlaviyoCampaignsCreateRequest", "type": "object" }, "IntegrationsKlaviyoCampaignsCreateResponse": { "type": "object", "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "job_id": { "type": "string" }, "safe_error_code": { "type": "string" } }, "required": [ "invocation_id", "status", "job_id" ], "additionalProperties": false, "title": "IntegrationsKlaviyoCampaignsCreateResponse" }, "IntegrationsKlaviyoCampaignsGetRequest": { "additionalProperties": false, "properties": { "campaign_id": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,63}$", "title": "Campaign Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "campaign_id" ], "title": "IntegrationsKlaviyoCampaignsGetRequest", "type": "object" }, "IntegrationsKlaviyoCampaignsGetResponseAudiences": { "additionalProperties": false, "properties": { "included": { "items": { "type": "string" }, "title": "Included", "type": "array" }, "excluded": { "items": { "type": "string" }, "title": "Excluded", "type": "array" } }, "required": [ "included", "excluded" ], "title": "IntegrationsKlaviyoCampaignsGetResponseAudiences", "type": "object" }, "IntegrationsKlaviyoCampaignsGetResponseCampaignMessageItem": { "additionalProperties": false, "properties": { "campaign_message_id": { "title": "Campaign Message Id", "type": "string" }, "campaign_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Campaign Id" }, "channel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsGetResponseMessageContent" }, { "type": "null" } ] }, "render_options": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsGetResponseRenderOptions" }, { "type": "null" } ] }, "template_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Id" }, "send_times": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsGetResponseSendTime" }, "title": "Send Times", "type": "array" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "campaign_message_id", "campaign_id", "channel", "label", "content", "render_options", "template_id", "send_times", "created_at", "updated_at" ], "title": "IntegrationsKlaviyoCampaignsGetResponseCampaignMessageItem", "type": "object" }, "IntegrationsKlaviyoCampaignsGetResponseMessageContent": { "additionalProperties": false, "properties": { "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subject" }, "preview_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Preview Text" }, "from_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From Email" }, "from_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From Label" }, "reply_to_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reply To Email" }, "cc_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cc Email" }, "bcc_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bcc Email" }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Body" }, "media_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Media Url" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" } }, "required": [ "subject", "preview_text", "from_email", "from_label", "reply_to_email", "cc_email", "bcc_email", "body", "media_url", "title" ], "title": "IntegrationsKlaviyoCampaignsGetResponseMessageContent", "type": "object" }, "IntegrationsKlaviyoCampaignsGetResponseRenderOptions": { "additionalProperties": false, "properties": { "shorten_links": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Shorten Links" }, "add_org_prefix": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Add Org Prefix" }, "add_info_link": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Add Info Link" }, "add_opt_out_language": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Add Opt Out Language" } }, "required": [ "shorten_links", "add_org_prefix", "add_info_link", "add_opt_out_language" ], "title": "IntegrationsKlaviyoCampaignsGetResponseRenderOptions", "type": "object" }, "IntegrationsKlaviyoCampaignsGetResponseSendStrategy": { "additionalProperties": false, "properties": { "method": { "title": "Method", "type": "string" }, "datetime": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Datetime" }, "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date" }, "throttle_percentage": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Throttle Percentage" }, "is_local": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Local" }, "send_past_recipients_immediately": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Send Past Recipients Immediately" } }, "required": [ "method", "datetime", "date", "throttle_percentage", "is_local", "send_past_recipients_immediately" ], "title": "IntegrationsKlaviyoCampaignsGetResponseSendStrategy", "type": "object" }, "IntegrationsKlaviyoCampaignsGetResponseSendTime": { "additionalProperties": false, "properties": { "datetime": { "title": "Datetime", "type": "string" }, "is_local": { "title": "Is Local", "type": "boolean" } }, "required": [ "datetime", "is_local" ], "title": "IntegrationsKlaviyoCampaignsGetResponseSendTime", "type": "object" }, "IntegrationsKlaviyoCampaignsGetResponseTrackingOptions": { "additionalProperties": false, "properties": { "add_tracking_params": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Add Tracking Params" }, "custom_tracking_params": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsGetResponseTrackingParam" }, "title": "Custom Tracking Params", "type": "array" }, "is_tracking_opens": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Tracking Opens" }, "is_tracking_clicks": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Tracking Clicks" } }, "required": [ "add_tracking_params", "custom_tracking_params", "is_tracking_opens", "is_tracking_clicks" ], "title": "IntegrationsKlaviyoCampaignsGetResponseTrackingOptions", "type": "object" }, "IntegrationsKlaviyoCampaignsGetResponseTrackingParam": { "additionalProperties": false, "properties": { "type": { "title": "Type", "type": "string" }, "name": { "title": "Name", "type": "string" }, "value": { "title": "Value", "type": "string" } }, "required": [ "type", "name", "value" ], "title": "IntegrationsKlaviyoCampaignsGetResponseTrackingParam", "type": "object" }, "IntegrationsKlaviyoCampaignsGetResponse": { "additionalProperties": false, "properties": { "campaign_id": { "title": "Campaign Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "status": { "title": "Status", "type": "string" }, "archived": { "title": "Archived", "type": "boolean" }, "audiences": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsGetResponseAudiences" }, "send_strategy": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsGetResponseSendStrategy" }, { "type": "null" } ] }, "use_smart_sending": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Use Smart Sending" }, "tracking_options": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsGetResponseTrackingOptions" }, { "type": "null" } ] }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "scheduled_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled At" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "send_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Send Time" }, "campaign_message_ids": { "items": { "type": "string" }, "title": "Campaign Message Ids", "type": "array" }, "tag_ids": { "items": { "type": "string" }, "title": "Tag Ids", "type": "array" }, "messages": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsGetResponseCampaignMessageItem" }, "title": "Messages", "type": "array" } }, "required": [ "campaign_id", "name", "status", "archived", "audiences", "send_strategy", "use_smart_sending", "tracking_options", "created_at", "scheduled_at", "updated_at", "send_time", "campaign_message_ids", "tag_ids", "messages" ], "title": "IntegrationsKlaviyoCampaignsGetResponse", "type": "object" }, "IntegrationsKlaviyoCampaignsListRequest": { "additionalProperties": false, "properties": { "created_after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created After" }, "created_before": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created Before" }, "updated_after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated After" }, "updated_before": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated Before" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,512}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "channel": { "default": "email", "enum": [ "email", "sms", "mobile_push" ], "title": "Channel", "type": "string" }, "name_contains": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "title": "Name Contains" }, "statuses": { "items": { "enum": [ "Scheduled", "Sent", "Draft", "Cancelled", "Adding Recipients", "Sending", "Variations Sent", "Sending Segments", "Cancelled: Smart Sending", "Preparing to send", "Cancelled: Account Disabled", "Cancelled: No Recipients", "Preparing to schedule", "Cancelled: Internal Error", "Queued without Recipients", "Cancelled: Billing Limit", "Cancelled: Misconfigured", "Unknown" ], "type": "string" }, "maxItems": 20, "title": "Statuses", "type": "array" }, "archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Archived" }, "scheduled_after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Scheduled After" }, "scheduled_before": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Scheduled Before" }, "sort": { "default": "-created_at", "enum": [ "created_at", "-created_at", "id", "-id", "name", "-name", "scheduled_at", "-scheduled_at", "updated_at", "-updated_at" ], "title": "Sort", "type": "string" }, "limit": { "default": 25, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsKlaviyoCampaignsListRequest", "type": "object" }, "IntegrationsKlaviyoCampaignsListResponseAudiences": { "additionalProperties": false, "properties": { "included": { "items": { "type": "string" }, "title": "Included", "type": "array" }, "excluded": { "items": { "type": "string" }, "title": "Excluded", "type": "array" } }, "required": [ "included", "excluded" ], "title": "IntegrationsKlaviyoCampaignsListResponseAudiences", "type": "object" }, "IntegrationsKlaviyoCampaignsListResponseCampaignItem": { "additionalProperties": false, "properties": { "campaign_id": { "title": "Campaign Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "status": { "title": "Status", "type": "string" }, "archived": { "title": "Archived", "type": "boolean" }, "audiences": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsListResponseAudiences" }, "send_strategy": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsListResponseSendStrategy" }, { "type": "null" } ] }, "use_smart_sending": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Use Smart Sending" }, "tracking_options": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsListResponseTrackingOptions" }, { "type": "null" } ] }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "scheduled_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled At" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "send_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Send Time" }, "campaign_message_ids": { "items": { "type": "string" }, "title": "Campaign Message Ids", "type": "array" }, "tag_ids": { "items": { "type": "string" }, "title": "Tag Ids", "type": "array" } }, "required": [ "campaign_id", "name", "status", "archived", "audiences", "send_strategy", "use_smart_sending", "tracking_options", "created_at", "scheduled_at", "updated_at", "send_time", "campaign_message_ids", "tag_ids" ], "title": "IntegrationsKlaviyoCampaignsListResponseCampaignItem", "type": "object" }, "IntegrationsKlaviyoCampaignsListResponseSendStrategy": { "additionalProperties": false, "properties": { "method": { "title": "Method", "type": "string" }, "datetime": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Datetime" }, "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date" }, "throttle_percentage": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Throttle Percentage" }, "is_local": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Local" }, "send_past_recipients_immediately": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Send Past Recipients Immediately" } }, "required": [ "method", "datetime", "date", "throttle_percentage", "is_local", "send_past_recipients_immediately" ], "title": "IntegrationsKlaviyoCampaignsListResponseSendStrategy", "type": "object" }, "IntegrationsKlaviyoCampaignsListResponseTrackingOptions": { "additionalProperties": false, "properties": { "add_tracking_params": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Add Tracking Params" }, "custom_tracking_params": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsListResponseTrackingParam" }, "title": "Custom Tracking Params", "type": "array" }, "is_tracking_opens": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Tracking Opens" }, "is_tracking_clicks": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Tracking Clicks" } }, "required": [ "add_tracking_params", "custom_tracking_params", "is_tracking_opens", "is_tracking_clicks" ], "title": "IntegrationsKlaviyoCampaignsListResponseTrackingOptions", "type": "object" }, "IntegrationsKlaviyoCampaignsListResponseTrackingParam": { "additionalProperties": false, "properties": { "type": { "title": "Type", "type": "string" }, "name": { "title": "Name", "type": "string" }, "value": { "title": "Value", "type": "string" } }, "required": [ "type", "name", "value" ], "title": "IntegrationsKlaviyoCampaignsListResponseTrackingParam", "type": "object" }, "IntegrationsKlaviyoCampaignsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsListResponseCampaignItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsKlaviyoCampaignsListResponse", "type": "object" }, "IntegrationsKlaviyoCampaignsUpdateRequestAudiencesUpdateInput": { "additionalProperties": false, "properties": { "included": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 100, "minItems": 1, "type": "array" }, { "type": "null" } ], "default": null, "title": "Included" }, "excluded": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 100, "type": "array" }, { "type": "null" } ], "default": null, "title": "Excluded" } }, "title": "IntegrationsKlaviyoCampaignsUpdateRequestAudiencesUpdateInput", "type": "object" }, "IntegrationsKlaviyoCampaignsUpdateRequestSendStrategyInput": { "additionalProperties": false, "properties": { "method": { "default": "static", "enum": [ "static", "immediate", "throttled", "smart_send_time" ], "title": "Method", "type": "string" }, "datetime": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Datetime" }, "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Date" }, "throttle_percentage": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Throttle Percentage" }, "is_local": { "default": false, "title": "Is Local", "type": "boolean" }, "send_past_recipients_immediately": { "default": false, "title": "Send Past Recipients Immediately", "type": "boolean" } }, "title": "IntegrationsKlaviyoCampaignsUpdateRequestSendStrategyInput", "type": "object" }, "IntegrationsKlaviyoCampaignsUpdateRequestTrackingOptionsInput": { "additionalProperties": false, "properties": { "add_tracking_params": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Add Tracking Params" }, "custom_tracking_params": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsUpdateRequestTrackingParamInput" }, "maxItems": 20, "title": "Custom Tracking Params", "type": "array" }, "is_tracking_opens": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Is Tracking Opens" }, "is_tracking_clicks": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Is Tracking Clicks" } }, "title": "IntegrationsKlaviyoCampaignsUpdateRequestTrackingOptionsInput", "type": "object" }, "IntegrationsKlaviyoCampaignsUpdateRequestTrackingParamInput": { "additionalProperties": false, "properties": { "type": { "default": "static", "enum": [ "static", "dynamic" ], "title": "Type", "type": "string" }, "name": { "maxLength": 128, "minLength": 1, "title": "Name", "type": "string" }, "value": { "maxLength": 512, "minLength": 1, "title": "Value", "type": "string" } }, "required": [ "name", "value" ], "title": "IntegrationsKlaviyoCampaignsUpdateRequestTrackingParamInput", "type": "object" }, "IntegrationsKlaviyoCampaignsUpdateRequest": { "additionalProperties": false, "properties": { "campaign_id": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,63}$", "title": "Campaign Id", "type": "string" }, "name": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "audiences": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsUpdateRequestAudiencesUpdateInput" }, { "type": "null" } ], "default": null }, "send_strategy": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsUpdateRequestSendStrategyInput" }, { "type": "null" } ], "default": null }, "use_smart_sending": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Use Smart Sending" }, "tracking_options": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsKlaviyoCampaignsUpdateRequestTrackingOptionsInput" }, { "type": "null" } ], "default": null }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "campaign_id" ], "title": "IntegrationsKlaviyoCampaignsUpdateRequest", "type": "object" }, "IntegrationsKlaviyoCampaignsUpdateResponse": { "type": "object", "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "job_id": { "type": "string" }, "safe_error_code": { "type": "string" } }, "required": [ "invocation_id", "status", "job_id" ], "additionalProperties": false, "title": "IntegrationsKlaviyoCampaignsUpdateResponse" }, "IntegrationsKlaviyoFlowActionsListRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,512}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "flow_id": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,63}$", "title": "Flow Id", "type": "string" }, "limit": { "default": 50, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "flow_id" ], "title": "IntegrationsKlaviyoFlowActionsListRequest", "type": "object" }, "IntegrationsKlaviyoFlowActionsListResponseFlowActionItem": { "additionalProperties": false, "properties": { "flow_action_id": { "title": "Flow Action Id", "type": "string" }, "action_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Type" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created" }, "updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated" }, "flow_message_ids": { "items": { "type": "string" }, "title": "Flow Message Ids", "type": "array" } }, "required": [ "flow_action_id", "action_type", "status", "created", "updated", "flow_message_ids" ], "title": "IntegrationsKlaviyoFlowActionsListResponseFlowActionItem", "type": "object" }, "IntegrationsKlaviyoFlowActionsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoFlowActionsListResponseFlowActionItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsKlaviyoFlowActionsListResponse", "type": "object" }, "IntegrationsKlaviyoFlowMessagesGetRequest": { "additionalProperties": false, "properties": { "flow_message_id": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,63}$", "title": "Flow Message Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "flow_message_id" ], "title": "IntegrationsKlaviyoFlowMessagesGetRequest", "type": "object" }, "IntegrationsKlaviyoFlowMessagesGetResponse": { "additionalProperties": false, "properties": { "flow_message_id": { "title": "Flow Message Id", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "channel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel" }, "subject_line": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subject Line" }, "preview_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Preview Text" }, "from_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From Email" }, "from_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From Label" }, "template_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Id" }, "created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created" }, "updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated" } }, "required": [ "flow_message_id", "name", "channel", "subject_line", "preview_text", "from_email", "from_label", "template_id", "created", "updated" ], "title": "IntegrationsKlaviyoFlowMessagesGetResponse", "type": "object" }, "IntegrationsKlaviyoFlowMessagesListRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,512}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "flow_action_id": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,63}$", "title": "Flow Action Id", "type": "string" }, "limit": { "default": 50, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "flow_action_id" ], "title": "IntegrationsKlaviyoFlowMessagesListRequest", "type": "object" }, "IntegrationsKlaviyoFlowMessagesListResponseFlowMessageItem": { "additionalProperties": false, "properties": { "flow_message_id": { "title": "Flow Message Id", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "channel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel" }, "subject_line": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subject Line" }, "preview_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Preview Text" }, "from_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From Email" }, "from_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From Label" }, "template_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Id" }, "created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created" }, "updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated" } }, "required": [ "flow_message_id", "name", "channel", "subject_line", "preview_text", "from_email", "from_label", "template_id", "created", "updated" ], "title": "IntegrationsKlaviyoFlowMessagesListResponseFlowMessageItem", "type": "object" }, "IntegrationsKlaviyoFlowMessagesListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoFlowMessagesListResponseFlowMessageItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsKlaviyoFlowMessagesListResponse", "type": "object" }, "IntegrationsKlaviyoFlowReportsSeriesRequestTimeframe": { "additionalProperties": false, "properties": { "key": { "anyOf": [ { "enum": [ "last_12_months", "last_30_days", "last_365_days", "last_3_months", "last_7_days", "last_90_days", "last_month", "last_week", "last_year", "this_month", "this_week", "this_year", "today", "yesterday" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Key" }, "start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Start" }, "end": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "End" } }, "title": "IntegrationsKlaviyoFlowReportsSeriesRequestTimeframe", "type": "object" }, "IntegrationsKlaviyoFlowReportsSeriesRequest": { "additionalProperties": false, "properties": { "statistics": { "items": { "enum": [ "average_order_value", "bounce_rate", "bounced", "bounced_or_failed", "bounced_or_failed_rate", "click_rate", "click_to_open_rate", "clicks", "clicks_unique", "conversion_rate", "conversion_uniques", "conversion_value", "conversions", "delivered", "delivery_rate", "failed", "failed_rate", "message_segment_count_sum", "open_rate", "opens", "opens_unique", "recipients", "revenue_per_recipient", "spam_complaint_rate", "spam_complaints", "text_message_credit_usage_amount", "text_message_roi", "text_message_spend", "unsubscribe_rate", "unsubscribe_uniques", "unsubscribes" ], "type": "string" }, "maxItems": 40, "minItems": 1, "title": "Statistics", "type": "array" }, "timeframe": { "$ref": "#/components/schemas/IntegrationsKlaviyoFlowReportsSeriesRequestTimeframe" }, "conversion_metric_id": { "anyOf": [ { "pattern": "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,63}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Conversion Metric Id" }, "send_channels": { "items": { "enum": [ "email", "sms", "mobile_push" ], "type": "string" }, "maxItems": 3, "title": "Send Channels", "type": "array" }, "tag_ids": { "items": { "type": "string" }, "maxItems": 100, "title": "Tag Ids", "type": "array" }, "group_by": { "items": { "enum": [ "flow_id", "flow_message_id", "flow_message_name", "flow_name", "send_channel", "tag_id", "tag_name", "text_message_format", "variation", "variation_name" ], "type": "string" }, "maxItems": 10, "title": "Group By", "type": "array" }, "flow_ids": { "items": { "type": "string" }, "maxItems": 100, "title": "Flow Ids", "type": "array" }, "flow_message_ids": { "items": { "type": "string" }, "maxItems": 100, "title": "Flow Message Ids", "type": "array" }, "interval": { "default": "daily", "enum": [ "hourly", "daily", "weekly", "monthly" ], "title": "Interval", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "statistics", "timeframe" ], "title": "IntegrationsKlaviyoFlowReportsSeriesRequest", "type": "object" }, "IntegrationsKlaviyoFlowReportsSeriesResponseSeriesRow": { "additionalProperties": false, "properties": { "groupings": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "title": "Groupings", "type": "object" }, "statistics": { "additionalProperties": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "type": "array" }, "title": "Statistics", "type": "object" } }, "required": [ "groupings", "statistics" ], "title": "IntegrationsKlaviyoFlowReportsSeriesResponseSeriesRow", "type": "object" }, "IntegrationsKlaviyoFlowReportsSeriesResponse": { "additionalProperties": false, "properties": { "date_times": { "items": { "type": "string" }, "title": "Date Times", "type": "array" }, "rows": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoFlowReportsSeriesResponseSeriesRow" }, "title": "Rows", "type": "array" } }, "required": [ "date_times", "rows" ], "title": "IntegrationsKlaviyoFlowReportsSeriesResponse", "type": "object" }, "IntegrationsKlaviyoFlowReportsValuesRequestTimeframe": { "additionalProperties": false, "properties": { "key": { "anyOf": [ { "enum": [ "last_12_months", "last_30_days", "last_365_days", "last_3_months", "last_7_days", "last_90_days", "last_month", "last_week", "last_year", "this_month", "this_week", "this_year", "today", "yesterday" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Key" }, "start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Start" }, "end": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "End" } }, "title": "IntegrationsKlaviyoFlowReportsValuesRequestTimeframe", "type": "object" }, "IntegrationsKlaviyoFlowReportsValuesRequest": { "additionalProperties": false, "properties": { "statistics": { "items": { "enum": [ "average_order_value", "bounce_rate", "bounced", "bounced_or_failed", "bounced_or_failed_rate", "click_rate", "click_to_open_rate", "clicks", "clicks_unique", "conversion_rate", "conversion_uniques", "conversion_value", "conversions", "delivered", "delivery_rate", "failed", "failed_rate", "message_segment_count_sum", "open_rate", "opens", "opens_unique", "recipients", "revenue_per_recipient", "spam_complaint_rate", "spam_complaints", "text_message_credit_usage_amount", "text_message_roi", "text_message_spend", "unsubscribe_rate", "unsubscribe_uniques", "unsubscribes" ], "type": "string" }, "maxItems": 40, "minItems": 1, "title": "Statistics", "type": "array" }, "timeframe": { "$ref": "#/components/schemas/IntegrationsKlaviyoFlowReportsValuesRequestTimeframe" }, "conversion_metric_id": { "anyOf": [ { "pattern": "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,63}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Conversion Metric Id" }, "send_channels": { "items": { "enum": [ "email", "sms", "mobile_push" ], "type": "string" }, "maxItems": 3, "title": "Send Channels", "type": "array" }, "tag_ids": { "items": { "type": "string" }, "maxItems": 100, "title": "Tag Ids", "type": "array" }, "group_by": { "items": { "enum": [ "flow_id", "flow_message_id", "flow_message_name", "flow_name", "send_channel", "tag_id", "tag_name", "text_message_format", "variation", "variation_name" ], "type": "string" }, "maxItems": 10, "title": "Group By", "type": "array" }, "flow_ids": { "items": { "type": "string" }, "maxItems": 100, "title": "Flow Ids", "type": "array" }, "flow_message_ids": { "items": { "type": "string" }, "maxItems": 100, "title": "Flow Message Ids", "type": "array" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "statistics", "timeframe" ], "title": "IntegrationsKlaviyoFlowReportsValuesRequest", "type": "object" }, "IntegrationsKlaviyoFlowReportsValuesResponseReportRow": { "additionalProperties": false, "properties": { "groupings": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "title": "Groupings", "type": "object" }, "statistics": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "title": "Statistics", "type": "object" } }, "required": [ "groupings", "statistics" ], "title": "IntegrationsKlaviyoFlowReportsValuesResponseReportRow", "type": "object" }, "IntegrationsKlaviyoFlowReportsValuesResponse": { "additionalProperties": false, "properties": { "rows": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoFlowReportsValuesResponseReportRow" }, "title": "Rows", "type": "array" } }, "required": [ "rows" ], "title": "IntegrationsKlaviyoFlowReportsValuesResponse", "type": "object" }, "IntegrationsKlaviyoFlowsGetRequest": { "additionalProperties": false, "properties": { "flow_id": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,63}$", "title": "Flow Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "flow_id" ], "title": "IntegrationsKlaviyoFlowsGetRequest", "type": "object" }, "IntegrationsKlaviyoFlowsGetResponse": { "additionalProperties": false, "properties": { "flow_id": { "title": "Flow Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "archived": { "title": "Archived", "type": "boolean" }, "trigger_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Trigger Type" }, "created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created" }, "updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated" } }, "required": [ "flow_id", "name", "status", "archived", "trigger_type", "created", "updated" ], "title": "IntegrationsKlaviyoFlowsGetResponse", "type": "object" }, "IntegrationsKlaviyoFlowsListRequest": { "additionalProperties": false, "properties": { "created_after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created After" }, "created_before": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created Before" }, "updated_after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated After" }, "updated_before": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated Before" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,512}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "name_contains": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "title": "Name Contains" }, "status": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Archived" }, "trigger_type": { "anyOf": [ { "enum": [ "Metric", "Added to List", "Unconfigured", "Date Based", "Price Drop", "Low Inventory" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Trigger Type" }, "sort": { "default": "-updated", "enum": [ "created", "-created", "id", "-id", "name", "-name", "status", "-status", "trigger_type", "-trigger_type", "updated", "-updated" ], "title": "Sort", "type": "string" }, "limit": { "default": 50, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsKlaviyoFlowsListRequest", "type": "object" }, "IntegrationsKlaviyoFlowsListResponseFlowItem": { "additionalProperties": false, "properties": { "flow_id": { "title": "Flow Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "archived": { "title": "Archived", "type": "boolean" }, "trigger_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Trigger Type" }, "created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created" }, "updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated" } }, "required": [ "flow_id", "name", "status", "archived", "trigger_type", "created", "updated" ], "title": "IntegrationsKlaviyoFlowsListResponseFlowItem", "type": "object" }, "IntegrationsKlaviyoFlowsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoFlowsListResponseFlowItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsKlaviyoFlowsListResponse", "type": "object" }, "IntegrationsKlaviyoFormReportsSeriesRequestTimeframe": { "additionalProperties": false, "properties": { "key": { "anyOf": [ { "enum": [ "last_12_months", "last_30_days", "last_365_days", "last_3_months", "last_7_days", "last_90_days", "last_month", "last_week", "last_year", "this_month", "this_week", "this_year", "today", "yesterday" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Key" }, "start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Start" }, "end": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "End" } }, "title": "IntegrationsKlaviyoFormReportsSeriesRequestTimeframe", "type": "object" }, "IntegrationsKlaviyoFormReportsSeriesRequest": { "additionalProperties": false, "properties": { "statistics": { "items": { "enum": [ "closed_form", "closed_form_uniques", "qualified_form", "qualified_form_uniques", "submit_rate", "submits", "submitted_form_step", "submitted_form_step_uniques", "viewed_form", "viewed_form_step", "viewed_form_step_uniques", "viewed_form_uniques" ], "type": "string" }, "maxItems": 12, "minItems": 1, "title": "Statistics", "type": "array" }, "timeframe": { "$ref": "#/components/schemas/IntegrationsKlaviyoFormReportsSeriesRequestTimeframe" }, "group_by": { "items": { "enum": [ "form_id", "form_version_id" ], "type": "string" }, "maxItems": 2, "title": "Group By", "type": "array" }, "form_ids": { "items": { "type": "string" }, "maxItems": 100, "title": "Form Ids", "type": "array" }, "form_version_ids": { "items": { "type": "string" }, "maxItems": 100, "title": "Form Version Ids", "type": "array" }, "interval": { "default": "daily", "enum": [ "hourly", "daily", "weekly", "monthly" ], "title": "Interval", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "statistics", "timeframe" ], "title": "IntegrationsKlaviyoFormReportsSeriesRequest", "type": "object" }, "IntegrationsKlaviyoFormReportsSeriesResponseSeriesRow": { "additionalProperties": false, "properties": { "groupings": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "title": "Groupings", "type": "object" }, "statistics": { "additionalProperties": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "type": "array" }, "title": "Statistics", "type": "object" } }, "required": [ "groupings", "statistics" ], "title": "IntegrationsKlaviyoFormReportsSeriesResponseSeriesRow", "type": "object" }, "IntegrationsKlaviyoFormReportsSeriesResponse": { "additionalProperties": false, "properties": { "date_times": { "items": { "type": "string" }, "title": "Date Times", "type": "array" }, "rows": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoFormReportsSeriesResponseSeriesRow" }, "title": "Rows", "type": "array" } }, "required": [ "date_times", "rows" ], "title": "IntegrationsKlaviyoFormReportsSeriesResponse", "type": "object" }, "IntegrationsKlaviyoFormReportsValuesRequestTimeframe": { "additionalProperties": false, "properties": { "key": { "anyOf": [ { "enum": [ "last_12_months", "last_30_days", "last_365_days", "last_3_months", "last_7_days", "last_90_days", "last_month", "last_week", "last_year", "this_month", "this_week", "this_year", "today", "yesterday" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Key" }, "start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Start" }, "end": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "End" } }, "title": "IntegrationsKlaviyoFormReportsValuesRequestTimeframe", "type": "object" }, "IntegrationsKlaviyoFormReportsValuesRequest": { "additionalProperties": false, "properties": { "statistics": { "items": { "enum": [ "closed_form", "closed_form_uniques", "qualified_form", "qualified_form_uniques", "submit_rate", "submits", "submitted_form_step", "submitted_form_step_uniques", "viewed_form", "viewed_form_step", "viewed_form_step_uniques", "viewed_form_uniques" ], "type": "string" }, "maxItems": 12, "minItems": 1, "title": "Statistics", "type": "array" }, "timeframe": { "$ref": "#/components/schemas/IntegrationsKlaviyoFormReportsValuesRequestTimeframe" }, "group_by": { "items": { "enum": [ "form_id", "form_version_id" ], "type": "string" }, "maxItems": 2, "title": "Group By", "type": "array" }, "form_ids": { "items": { "type": "string" }, "maxItems": 100, "title": "Form Ids", "type": "array" }, "form_version_ids": { "items": { "type": "string" }, "maxItems": 100, "title": "Form Version Ids", "type": "array" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "statistics", "timeframe" ], "title": "IntegrationsKlaviyoFormReportsValuesRequest", "type": "object" }, "IntegrationsKlaviyoFormReportsValuesResponseReportRow": { "additionalProperties": false, "properties": { "groupings": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "title": "Groupings", "type": "object" }, "statistics": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "title": "Statistics", "type": "object" } }, "required": [ "groupings", "statistics" ], "title": "IntegrationsKlaviyoFormReportsValuesResponseReportRow", "type": "object" }, "IntegrationsKlaviyoFormReportsValuesResponse": { "additionalProperties": false, "properties": { "rows": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoFormReportsValuesResponseReportRow" }, "title": "Rows", "type": "array" } }, "required": [ "rows" ], "title": "IntegrationsKlaviyoFormReportsValuesResponse", "type": "object" }, "IntegrationsKlaviyoFormsGetRequest": { "additionalProperties": false, "properties": { "form_id": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,63}$", "title": "Form Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "form_id" ], "title": "IntegrationsKlaviyoFormsGetRequest", "type": "object" }, "IntegrationsKlaviyoFormsGetResponse": { "additionalProperties": false, "properties": { "form_id": { "title": "Form Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "status": { "title": "Status", "type": "string" }, "ab_test": { "title": "Ab Test", "type": "boolean" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "form_id", "name", "status", "ab_test", "created_at", "updated_at" ], "title": "IntegrationsKlaviyoFormsGetResponse", "type": "object" }, "IntegrationsKlaviyoFormsListRequest": { "additionalProperties": false, "properties": { "created_after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created After" }, "created_before": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created Before" }, "updated_after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated After" }, "updated_before": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated Before" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,512}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "name_contains": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "title": "Name Contains" }, "status": { "anyOf": [ { "enum": [ "draft", "live" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "ab_test": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Ab Test" }, "sort": { "default": "-updated_at", "enum": [ "created_at", "-created_at", "updated_at", "-updated_at" ], "title": "Sort", "type": "string" }, "limit": { "default": 20, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsKlaviyoFormsListRequest", "type": "object" }, "IntegrationsKlaviyoFormsListResponseFormItem": { "additionalProperties": false, "properties": { "form_id": { "title": "Form Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "status": { "title": "Status", "type": "string" }, "ab_test": { "title": "Ab Test", "type": "boolean" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "form_id", "name", "status", "ab_test", "created_at", "updated_at" ], "title": "IntegrationsKlaviyoFormsListResponseFormItem", "type": "object" }, "IntegrationsKlaviyoFormsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoFormsListResponseFormItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsKlaviyoFormsListResponse", "type": "object" }, "IntegrationsKlaviyoListsGetRequest": { "additionalProperties": false, "properties": { "list_id": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,63}$", "title": "List Id", "type": "string" }, "include_profile_count": { "default": true, "title": "Include Profile Count", "type": "boolean" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "list_id" ], "title": "IntegrationsKlaviyoListsGetRequest", "type": "object" }, "IntegrationsKlaviyoListsGetResponse": { "additionalProperties": false, "properties": { "list_id": { "title": "List Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created" }, "updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated" }, "opt_in_process": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Opt In Process" }, "profile_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Profile Count" } }, "required": [ "list_id", "name", "created", "updated", "opt_in_process", "profile_count" ], "title": "IntegrationsKlaviyoListsGetResponse", "type": "object" }, "IntegrationsKlaviyoListsListRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,512}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "name": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "sort": { "default": "-updated", "enum": [ "created", "-created", "id", "-id", "name", "-name", "updated", "-updated" ], "title": "Sort", "type": "string" }, "limit": { "default": 10, "maximum": 10, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsKlaviyoListsListRequest", "type": "object" }, "IntegrationsKlaviyoListsListResponseListItem": { "additionalProperties": false, "properties": { "list_id": { "title": "List Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created" }, "updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated" }, "opt_in_process": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Opt In Process" }, "profile_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Profile Count" } }, "required": [ "list_id", "name", "created", "updated", "opt_in_process", "profile_count" ], "title": "IntegrationsKlaviyoListsListResponseListItem", "type": "object" }, "IntegrationsKlaviyoListsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoListsListResponseListItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsKlaviyoListsListResponse", "type": "object" }, "IntegrationsKlaviyoMetricAggregatesQueryRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,512}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "metric_id": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,63}$", "title": "Metric Id", "type": "string" }, "measurements": { "items": { "enum": [ "count", "sum_value", "unique" ], "type": "string" }, "maxItems": 3, "minItems": 1, "title": "Measurements", "type": "array" }, "interval": { "default": "day", "enum": [ "hour", "day", "week", "month" ], "title": "Interval", "type": "string" }, "by": { "items": { "enum": [ "$attributed_channel", "$attributed_flow", "$attributed_message", "$attributed_variation", "$campaign_channel", "$flow", "$flow_channel", "$message", "$message_send_cohort", "$usage_amount", "$value_currency", "$variation", "$variation_send_cohort", "Bot Click", "Bounce Type", "Campaign Name", "Client Canonical", "Client Name", "Client Type", "Email Domain", "Failure Source", "Failure Type", "From Number", "From Phone Region", "Inbox Provider", "List", "Message Format", "Message Name", "Message Type", "Method", "Segment Count", "Subject", "To Number", "To Phone Region", "URL", "form_id" ], "type": "string" }, "maxItems": 5, "title": "By", "type": "array" }, "start": { "title": "Start", "type": "string" }, "end": { "title": "End", "type": "string" }, "extra_filters": { "items": { "maxLength": 300, "pattern": "^(equals|not-equals|contains|contains-any|any)\\((\\$attributed_channel|\\$attributed_flow|\\$attributed_message|\\$attributed_variation|\\$campaign_channel|\\$flow|\\$flow_channel|\\$message|\\$message_send_cohort|\\$usage_amount|\\$value_currency|\\$variation|\\$variation_send_cohort|Bot\\ Click|Bounce\\ Type|Campaign\\ Name|Client\\ Canonical|Client\\ Name|Client\\ Type|Email\\ Domain|Failure\\ Source|Failure\\ Type|From\\ Number|From\\ Phone\\ Region|Inbox\\ Provider|List|Message\\ Format|Message\\ Name|Message\\ Type|Method|Segment\\ Count|Subject|To\\ Number|To\\ Phone\\ Region|URL|form_id),.{1,200}\\)$", "type": "string" }, "maxItems": 5, "title": "Extra Filters", "type": "array" }, "timezone": { "default": "UTC", "maxLength": 64, "pattern": "^[A-Za-z_]+(/[A-Za-z0-9_+-]+){0,2}$", "title": "Timezone", "type": "string" }, "sort": { "anyOf": [ { "pattern": "^-?[A-Za-z_$ ]{1,40}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Sort" }, "page_size": { "default": 500, "maximum": 500, "minimum": 1, "title": "Page Size", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "metric_id", "measurements", "start", "end" ], "title": "IntegrationsKlaviyoMetricAggregatesQueryRequest", "type": "object" }, "IntegrationsKlaviyoMetricAggregatesQueryResponseAggregateRow": { "additionalProperties": false, "properties": { "dimensions": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "title": "Dimensions", "type": "array" }, "measurements": { "additionalProperties": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "type": "array" }, "title": "Measurements", "type": "object" } }, "required": [ "dimensions", "measurements" ], "title": "IntegrationsKlaviyoMetricAggregatesQueryResponseAggregateRow", "type": "object" }, "IntegrationsKlaviyoMetricAggregatesQueryResponse": { "additionalProperties": false, "properties": { "dates": { "items": { "type": "string" }, "title": "Dates", "type": "array" }, "rows": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoMetricAggregatesQueryResponseAggregateRow" }, "title": "Rows", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "dates", "rows", "next_cursor" ], "title": "IntegrationsKlaviyoMetricAggregatesQueryResponse", "type": "object" }, "IntegrationsKlaviyoMetricsGetRequest": { "additionalProperties": false, "properties": { "metric_id": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,63}$", "title": "Metric Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "metric_id" ], "title": "IntegrationsKlaviyoMetricsGetRequest", "type": "object" }, "IntegrationsKlaviyoMetricsGetResponse": { "additionalProperties": false, "properties": { "metric_id": { "title": "Metric Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "integration_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Integration Name" }, "integration_category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Integration Category" }, "created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created" }, "updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated" } }, "required": [ "metric_id", "name", "integration_name", "integration_category", "created", "updated" ], "title": "IntegrationsKlaviyoMetricsGetResponse", "type": "object" }, "IntegrationsKlaviyoMetricsListRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,512}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "integration_name": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "title": "Integration Name" }, "integration_category": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "title": "Integration Category" }, "name_contains": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "title": "Name Contains" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsKlaviyoMetricsListRequest", "type": "object" }, "IntegrationsKlaviyoMetricsListResponseMetricItem": { "additionalProperties": false, "properties": { "metric_id": { "title": "Metric Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "integration_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Integration Name" }, "integration_category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Integration Category" }, "created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created" }, "updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated" } }, "required": [ "metric_id", "name", "integration_name", "integration_category", "created", "updated" ], "title": "IntegrationsKlaviyoMetricsListResponseMetricItem", "type": "object" }, "IntegrationsKlaviyoMetricsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoMetricsListResponseMetricItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsKlaviyoMetricsListResponse", "type": "object" }, "IntegrationsKlaviyoSegmentReportsSeriesRequestTimeframe": { "additionalProperties": false, "properties": { "key": { "anyOf": [ { "enum": [ "last_12_months", "last_30_days", "last_365_days", "last_3_months", "last_7_days", "last_90_days", "last_month", "last_week", "last_year", "this_month", "this_week", "this_year", "today", "yesterday" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Key" }, "start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Start" }, "end": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "End" } }, "title": "IntegrationsKlaviyoSegmentReportsSeriesRequestTimeframe", "type": "object" }, "IntegrationsKlaviyoSegmentReportsSeriesRequest": { "additionalProperties": false, "properties": { "statistics": { "items": { "enum": [ "members_added", "members_removed", "net_members_changed", "total_members" ], "type": "string" }, "maxItems": 4, "minItems": 1, "title": "Statistics", "type": "array" }, "timeframe": { "$ref": "#/components/schemas/IntegrationsKlaviyoSegmentReportsSeriesRequestTimeframe" }, "segment_ids": { "items": { "type": "string" }, "maxItems": 100, "title": "Segment Ids", "type": "array" }, "interval": { "default": "daily", "enum": [ "hourly", "daily", "weekly", "monthly" ], "title": "Interval", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "statistics", "timeframe" ], "title": "IntegrationsKlaviyoSegmentReportsSeriesRequest", "type": "object" }, "IntegrationsKlaviyoSegmentReportsSeriesResponseSeriesRow": { "additionalProperties": false, "properties": { "groupings": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "title": "Groupings", "type": "object" }, "statistics": { "additionalProperties": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "type": "array" }, "title": "Statistics", "type": "object" } }, "required": [ "groupings", "statistics" ], "title": "IntegrationsKlaviyoSegmentReportsSeriesResponseSeriesRow", "type": "object" }, "IntegrationsKlaviyoSegmentReportsSeriesResponse": { "additionalProperties": false, "properties": { "date_times": { "items": { "type": "string" }, "title": "Date Times", "type": "array" }, "rows": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoSegmentReportsSeriesResponseSeriesRow" }, "title": "Rows", "type": "array" } }, "required": [ "date_times", "rows" ], "title": "IntegrationsKlaviyoSegmentReportsSeriesResponse", "type": "object" }, "IntegrationsKlaviyoSegmentReportsValuesRequestTimeframe": { "additionalProperties": false, "properties": { "key": { "anyOf": [ { "enum": [ "last_12_months", "last_30_days", "last_365_days", "last_3_months", "last_7_days", "last_90_days", "last_month", "last_week", "last_year", "this_month", "this_week", "this_year", "today", "yesterday" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Key" }, "start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Start" }, "end": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "End" } }, "title": "IntegrationsKlaviyoSegmentReportsValuesRequestTimeframe", "type": "object" }, "IntegrationsKlaviyoSegmentReportsValuesRequest": { "additionalProperties": false, "properties": { "statistics": { "items": { "enum": [ "members_added", "members_removed", "net_members_changed", "total_members" ], "type": "string" }, "maxItems": 4, "minItems": 1, "title": "Statistics", "type": "array" }, "timeframe": { "$ref": "#/components/schemas/IntegrationsKlaviyoSegmentReportsValuesRequestTimeframe" }, "segment_ids": { "items": { "type": "string" }, "maxItems": 100, "title": "Segment Ids", "type": "array" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "statistics", "timeframe" ], "title": "IntegrationsKlaviyoSegmentReportsValuesRequest", "type": "object" }, "IntegrationsKlaviyoSegmentReportsValuesResponseReportRow": { "additionalProperties": false, "properties": { "groupings": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "title": "Groupings", "type": "object" }, "statistics": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "title": "Statistics", "type": "object" } }, "required": [ "groupings", "statistics" ], "title": "IntegrationsKlaviyoSegmentReportsValuesResponseReportRow", "type": "object" }, "IntegrationsKlaviyoSegmentReportsValuesResponse": { "additionalProperties": false, "properties": { "rows": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoSegmentReportsValuesResponseReportRow" }, "title": "Rows", "type": "array" } }, "required": [ "rows" ], "title": "IntegrationsKlaviyoSegmentReportsValuesResponse", "type": "object" }, "IntegrationsKlaviyoSegmentsGetRequest": { "additionalProperties": false, "properties": { "segment_id": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,63}$", "title": "Segment Id", "type": "string" }, "include_profile_count": { "default": true, "title": "Include Profile Count", "type": "boolean" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "segment_id" ], "title": "IntegrationsKlaviyoSegmentsGetRequest", "type": "object" }, "IntegrationsKlaviyoSegmentsGetResponse": { "additionalProperties": false, "properties": { "segment_id": { "title": "Segment Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created" }, "updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated" }, "is_active": { "title": "Is Active", "type": "boolean" }, "is_processing": { "title": "Is Processing", "type": "boolean" }, "is_starred": { "title": "Is Starred", "type": "boolean" }, "profile_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Profile Count" } }, "required": [ "segment_id", "name", "created", "updated", "is_active", "is_processing", "is_starred", "profile_count" ], "title": "IntegrationsKlaviyoSegmentsGetResponse", "type": "object" }, "IntegrationsKlaviyoSegmentsListRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,512}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "name": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Is Active" }, "is_starred": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Is Starred" }, "sort": { "default": "-updated", "enum": [ "created", "-created", "id", "-id", "name", "-name", "updated", "-updated" ], "title": "Sort", "type": "string" }, "limit": { "default": 10, "maximum": 10, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsKlaviyoSegmentsListRequest", "type": "object" }, "IntegrationsKlaviyoSegmentsListResponseSegmentItem": { "additionalProperties": false, "properties": { "segment_id": { "title": "Segment Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created" }, "updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated" }, "is_active": { "title": "Is Active", "type": "boolean" }, "is_processing": { "title": "Is Processing", "type": "boolean" }, "is_starred": { "title": "Is Starred", "type": "boolean" }, "profile_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Profile Count" } }, "required": [ "segment_id", "name", "created", "updated", "is_active", "is_processing", "is_starred", "profile_count" ], "title": "IntegrationsKlaviyoSegmentsListResponseSegmentItem", "type": "object" }, "IntegrationsKlaviyoSegmentsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoSegmentsListResponseSegmentItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsKlaviyoSegmentsListResponse", "type": "object" }, "IntegrationsKlaviyoTagsListRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,512}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "name_contains": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "title": "Name Contains" }, "limit": { "default": 50, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsKlaviyoTagsListRequest", "type": "object" }, "IntegrationsKlaviyoTagsListResponseTagItem": { "additionalProperties": false, "properties": { "tag_id": { "title": "Tag Id", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "required": [ "tag_id", "name" ], "title": "IntegrationsKlaviyoTagsListResponseTagItem", "type": "object" }, "IntegrationsKlaviyoTagsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoTagsListResponseTagItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsKlaviyoTagsListResponse", "type": "object" }, "IntegrationsKlaviyoTemplatesCreateRequest": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "title": "Name", "type": "string" }, "html": { "maxLength": 800000, "minLength": 1, "title": "Html", "type": "string" }, "text": { "anyOf": [ { "maxLength": 200000, "type": "string" }, { "type": "null" } ], "default": null, "title": "Text" }, "amp": { "anyOf": [ { "maxLength": 200000, "type": "string" }, { "type": "null" } ], "default": null, "title": "Amp" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "name", "html" ], "title": "IntegrationsKlaviyoTemplatesCreateRequest", "type": "object" }, "IntegrationsKlaviyoTemplatesCreateResponse": { "type": "object", "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "job_id": { "type": "string" }, "safe_error_code": { "type": "string" } }, "required": [ "invocation_id", "status", "job_id" ], "additionalProperties": false, "title": "IntegrationsKlaviyoTemplatesCreateResponse" }, "IntegrationsKlaviyoTemplatesGetRequest": { "additionalProperties": false, "properties": { "template_id": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,63}$", "title": "Template Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "template_id" ], "title": "IntegrationsKlaviyoTemplatesGetRequest", "type": "object" }, "IntegrationsKlaviyoTemplatesGetResponse": { "additionalProperties": false, "properties": { "template_id": { "title": "Template Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "editor_type": { "title": "Editor Type", "type": "string" }, "created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created" }, "updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated" }, "html": { "title": "Html", "type": "string" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Text" }, "amp": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Amp" } }, "required": [ "template_id", "name", "editor_type", "created", "updated", "html", "text", "amp" ], "title": "IntegrationsKlaviyoTemplatesGetResponse", "type": "object" }, "IntegrationsKlaviyoTemplatesListRequest": { "additionalProperties": false, "properties": { "created_after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created After" }, "created_before": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created Before" }, "updated_after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated After" }, "updated_before": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated Before" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,512}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "name": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "name_contains": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "title": "Name Contains" }, "sort": { "default": "-updated", "enum": [ "created", "-created", "id", "-id", "name", "-name", "updated", "-updated" ], "title": "Sort", "type": "string" }, "limit": { "default": 10, "maximum": 10, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsKlaviyoTemplatesListRequest", "type": "object" }, "IntegrationsKlaviyoTemplatesListResponseTemplateItem": { "additionalProperties": false, "properties": { "template_id": { "title": "Template Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "editor_type": { "title": "Editor Type", "type": "string" }, "created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created" }, "updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated" } }, "required": [ "template_id", "name", "editor_type", "created", "updated" ], "title": "IntegrationsKlaviyoTemplatesListResponseTemplateItem", "type": "object" }, "IntegrationsKlaviyoTemplatesListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsKlaviyoTemplatesListResponseTemplateItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsKlaviyoTemplatesListResponse", "type": "object" }, "IntegrationsKlaviyoTemplatesRenderRequest": { "additionalProperties": false, "properties": { "template_id": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,63}$", "title": "Template Id", "type": "string" }, "context": { "additionalProperties": true, "title": "Context", "type": "object" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "template_id" ], "title": "IntegrationsKlaviyoTemplatesRenderRequest", "type": "object" }, "IntegrationsKlaviyoTemplatesRenderResponse": { "additionalProperties": false, "properties": { "template_id": { "title": "Template Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "html": { "title": "Html", "type": "string" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Text" }, "amp": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Amp" } }, "required": [ "template_id", "name", "html", "text", "amp" ], "title": "IntegrationsKlaviyoTemplatesRenderResponse", "type": "object" }, "IntegrationsKlaviyoTemplatesUpdateRequest": { "additionalProperties": false, "properties": { "template_id": { "pattern": "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,63}$", "title": "Template Id", "type": "string" }, "name": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "html": { "anyOf": [ { "maxLength": 800000, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Html" }, "text": { "anyOf": [ { "maxLength": 200000, "type": "string" }, { "type": "null" } ], "default": null, "title": "Text" }, "amp": { "anyOf": [ { "maxLength": 200000, "type": "string" }, { "type": "null" } ], "default": null, "title": "Amp" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "template_id" ], "title": "IntegrationsKlaviyoTemplatesUpdateRequest", "type": "object" }, "IntegrationsKlaviyoTemplatesUpdateResponse": { "type": "object", "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "job_id": { "type": "string" }, "safe_error_code": { "type": "string" } }, "required": [ "invocation_id", "status", "job_id" ], "additionalProperties": false, "title": "IntegrationsKlaviyoTemplatesUpdateResponse" }, "IntegrationsMetaadsAdAccountsGetRequest": { "additionalProperties": false, "properties": { "ad_account_id": { "pattern": "^(act_)?[0-9]{1,32}$", "title": "Ad Account Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "ad_account_id" ], "title": "IntegrationsMetaadsAdAccountsGetRequest", "type": "object" }, "IntegrationsMetaadsAdAccountsGetResponseReference": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" } }, "required": [ "id", "name" ], "title": "IntegrationsMetaadsAdAccountsGetResponseReference", "type": "object" }, "IntegrationsMetaadsAdAccountsGetResponse": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "account_id": { "title": "Account Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "account_status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Account Status" }, "account_status_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Status Label" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency" }, "timezone_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Timezone Name" }, "amount_spent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Amount Spent" }, "business": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsMetaadsAdAccountsGetResponseReference" }, { "type": "null" } ] }, "spend_cap": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Spend Cap" }, "balance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Balance" }, "disable_reason": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Disable Reason" }, "created_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created Time" }, "funding_source_details": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Funding Source Details" }, "capabilities": { "items": { "type": "string" }, "title": "Capabilities", "type": "array" } }, "required": [ "id", "account_id", "name", "account_status", "account_status_label", "currency", "timezone_name", "amount_spent", "business", "spend_cap", "balance", "disable_reason", "created_time", "funding_source_details", "capabilities" ], "title": "IntegrationsMetaadsAdAccountsGetResponse", "type": "object" }, "IntegrationsMetaadsAdAccountsListRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsMetaadsAdAccountsListRequest", "type": "object" }, "IntegrationsMetaadsAdAccountsListResponseAdAccountItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "account_id": { "title": "Account Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "account_status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Account Status" }, "account_status_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Status Label" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency" }, "timezone_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Timezone Name" }, "amount_spent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Amount Spent" }, "business": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsMetaadsAdAccountsListResponseReference" }, { "type": "null" } ] } }, "required": [ "id", "account_id", "name", "account_status", "account_status_label", "currency", "timezone_name", "amount_spent", "business" ], "title": "IntegrationsMetaadsAdAccountsListResponseAdAccountItem", "type": "object" }, "IntegrationsMetaadsAdAccountsListResponseReference": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" } }, "required": [ "id", "name" ], "title": "IntegrationsMetaadsAdAccountsListResponseReference", "type": "object" }, "IntegrationsMetaadsAdAccountsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsMetaadsAdAccountsListResponseAdAccountItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsMetaadsAdAccountsListResponse", "type": "object" }, "IntegrationsMetaadsAdCreativesGetRequest": { "additionalProperties": false, "properties": { "ad_account_id": { "pattern": "^(act_)?[0-9]{1,32}$", "title": "Ad Account Id", "type": "string" }, "creative_id": { "pattern": "^[0-9]{1,32}$", "title": "Creative Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "ad_account_id", "creative_id" ], "title": "IntegrationsMetaadsAdCreativesGetRequest", "type": "object" }, "IntegrationsMetaadsAdCreativesGetResponse": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Body" }, "object_story_spec": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Object Story Spec" }, "asset_feed_spec": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Asset Feed Spec" }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Url" }, "image_hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Hash" }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thumbnail Url" }, "video_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Id" }, "call_to_action_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Call To Action Type" }, "link_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Link Url" }, "object_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Type" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "effective_object_story_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Effective Object Story Id" }, "instagram_permalink_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instagram Permalink Url" }, "url_tags": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url Tags" } }, "required": [ "id", "name", "title", "body", "object_story_spec", "asset_feed_spec", "image_url", "image_hash", "thumbnail_url", "video_id", "call_to_action_type", "link_url", "object_type", "status", "effective_object_story_id", "instagram_permalink_url", "url_tags" ], "title": "IntegrationsMetaadsAdCreativesGetResponse", "type": "object" }, "IntegrationsMetaadsAdCreativesListRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "ad_account_id": { "pattern": "^(act_)?[0-9]{1,32}$", "title": "Ad Account Id", "type": "string" }, "ad_id": { "anyOf": [ { "pattern": "^[0-9]{1,32}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Ad Id" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "ad_account_id" ], "title": "IntegrationsMetaadsAdCreativesListRequest", "type": "object" }, "IntegrationsMetaadsAdCreativesListResponseAdCreativeItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Body" }, "object_story_spec": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Object Story Spec" }, "asset_feed_spec": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Asset Feed Spec" }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Url" }, "image_hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Hash" }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thumbnail Url" }, "video_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Id" }, "call_to_action_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Call To Action Type" }, "link_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Link Url" }, "object_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Type" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "effective_object_story_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Effective Object Story Id" }, "instagram_permalink_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instagram Permalink Url" }, "url_tags": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url Tags" } }, "required": [ "id", "name", "title", "body", "object_story_spec", "asset_feed_spec", "image_url", "image_hash", "thumbnail_url", "video_id", "call_to_action_type", "link_url", "object_type", "status", "effective_object_story_id", "instagram_permalink_url", "url_tags" ], "title": "IntegrationsMetaadsAdCreativesListResponseAdCreativeItem", "type": "object" }, "IntegrationsMetaadsAdCreativesListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsMetaadsAdCreativesListResponseAdCreativeItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsMetaadsAdCreativesListResponse", "type": "object" }, "IntegrationsMetaadsAdImagesListRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "ad_account_id": { "pattern": "^(act_)?[0-9]{1,32}$", "title": "Ad Account Id", "type": "string" }, "name": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "hashes": { "items": { "pattern": "^[0-9a-f]{32}$", "type": "string" }, "maxItems": 20, "title": "Hashes", "type": "array" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "ad_account_id" ], "title": "IntegrationsMetaadsAdImagesListRequest", "type": "object" }, "IntegrationsMetaadsAdImagesListResponseAdImageItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hash" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" }, "url_128": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url 128" }, "permalink_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Permalink Url" }, "width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Width" }, "height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Height" }, "original_width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Original Width" }, "original_height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Original Height" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "created_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created Time" }, "updated_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated Time" } }, "required": [ "id", "hash", "name", "url", "url_128", "permalink_url", "width", "height", "original_width", "original_height", "status", "created_time", "updated_time" ], "title": "IntegrationsMetaadsAdImagesListResponseAdImageItem", "type": "object" }, "IntegrationsMetaadsAdImagesListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsMetaadsAdImagesListResponseAdImageItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsMetaadsAdImagesListResponse", "type": "object" }, "IntegrationsMetaadsAdSetsGetRequest": { "additionalProperties": false, "properties": { "ad_account_id": { "pattern": "^(act_)?[0-9]{1,32}$", "title": "Ad Account Id", "type": "string" }, "ad_set_id": { "pattern": "^[0-9]{1,32}$", "title": "Ad Set Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "ad_account_id", "ad_set_id" ], "title": "IntegrationsMetaadsAdSetsGetRequest", "type": "object" }, "IntegrationsMetaadsAdSetsGetResponse": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "campaign_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Campaign Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "effective_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Effective Status" }, "daily_budget": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Daily Budget" }, "lifetime_budget": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Lifetime Budget" }, "optimization_goal": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Optimization Goal" }, "billing_event": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Billing Event" }, "bid_strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bid Strategy" }, "start_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Time" }, "end_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Time" }, "created_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created Time" }, "updated_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated Time" }, "targeting": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Targeting" }, "promoted_object": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Promoted Object" }, "attribution_spec": { "items": { "additionalProperties": true, "type": "object" }, "title": "Attribution Spec", "type": "array" }, "bid_amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Bid Amount" }, "destination_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Destination Type" }, "learning_stage_info": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Learning Stage Info" }, "issues_info": { "items": { "additionalProperties": true, "type": "object" }, "title": "Issues Info", "type": "array" } }, "required": [ "id", "name", "campaign_id", "status", "effective_status", "daily_budget", "lifetime_budget", "optimization_goal", "billing_event", "bid_strategy", "start_time", "end_time", "created_time", "updated_time", "targeting", "promoted_object", "attribution_spec", "bid_amount", "destination_type", "learning_stage_info", "issues_info" ], "title": "IntegrationsMetaadsAdSetsGetResponse", "type": "object" }, "IntegrationsMetaadsAdSetsListRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "created_after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created After" }, "created_before": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created Before" }, "effective_status": { "items": { "enum": [ "ACTIVE", "PAUSED", "DELETED", "ARCHIVED", "IN_PROCESS", "WITH_ISSUES", "PENDING_REVIEW", "DISAPPROVED", "PREAPPROVED", "PENDING_BILLING_INFO", "CAMPAIGN_PAUSED", "ADSET_PAUSED" ], "type": "string" }, "maxItems": 12, "title": "Effective Status", "type": "array" }, "objective": { "items": { "pattern": "^[A-Z_]{1,40}$", "type": "string" }, "maxItems": 10, "title": "Objective", "type": "array" }, "ad_account_id": { "pattern": "^(act_)?[0-9]{1,32}$", "title": "Ad Account Id", "type": "string" }, "campaign_id": { "anyOf": [ { "pattern": "^[0-9]{1,32}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Campaign Id" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "ad_account_id" ], "title": "IntegrationsMetaadsAdSetsListRequest", "type": "object" }, "IntegrationsMetaadsAdSetsListResponseAdSetItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "campaign_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Campaign Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "effective_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Effective Status" }, "daily_budget": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Daily Budget" }, "lifetime_budget": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Lifetime Budget" }, "optimization_goal": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Optimization Goal" }, "billing_event": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Billing Event" }, "bid_strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bid Strategy" }, "start_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Time" }, "end_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Time" }, "created_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created Time" }, "updated_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated Time" } }, "required": [ "id", "name", "campaign_id", "status", "effective_status", "daily_budget", "lifetime_budget", "optimization_goal", "billing_event", "bid_strategy", "start_time", "end_time", "created_time", "updated_time" ], "title": "IntegrationsMetaadsAdSetsListResponseAdSetItem", "type": "object" }, "IntegrationsMetaadsAdSetsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsMetaadsAdSetsListResponseAdSetItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsMetaadsAdSetsListResponse", "type": "object" }, "IntegrationsMetaadsAdVideosListRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "ad_account_id": { "pattern": "^(act_)?[0-9]{1,32}$", "title": "Ad Account Id", "type": "string" }, "title": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "ad_account_id" ], "title": "IntegrationsMetaadsAdVideosListRequest", "type": "object" }, "IntegrationsMetaadsAdVideosListResponseAdVideoItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "length": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Length" }, "status": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Status" }, "created_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created Time" }, "updated_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated Time" }, "permalink_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Permalink Url" }, "picture": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Picture" }, "published": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Published" } }, "required": [ "id", "title", "description", "length", "status", "created_time", "updated_time", "permalink_url", "picture", "published" ], "title": "IntegrationsMetaadsAdVideosListResponseAdVideoItem", "type": "object" }, "IntegrationsMetaadsAdVideosListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsMetaadsAdVideosListResponseAdVideoItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsMetaadsAdVideosListResponse", "type": "object" }, "IntegrationsMetaadsAdsGetRequest": { "additionalProperties": false, "properties": { "ad_account_id": { "pattern": "^(act_)?[0-9]{1,32}$", "title": "Ad Account Id", "type": "string" }, "ad_id": { "pattern": "^[0-9]{1,32}$", "title": "Ad Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "ad_account_id", "ad_id" ], "title": "IntegrationsMetaadsAdsGetRequest", "type": "object" }, "IntegrationsMetaadsAdsGetResponse": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "campaign_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Campaign Id" }, "adset_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Adset Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "effective_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Effective Status" }, "creative_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Creative Id" }, "created_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created Time" }, "updated_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated Time" }, "tracking_specs": { "items": { "additionalProperties": true, "type": "object" }, "title": "Tracking Specs", "type": "array" }, "conversion_domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Conversion Domain" }, "issues_info": { "items": { "additionalProperties": true, "type": "object" }, "title": "Issues Info", "type": "array" }, "preview_shareable_link": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Preview Shareable Link" }, "ad_review_feedback": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Ad Review Feedback" } }, "required": [ "id", "name", "campaign_id", "adset_id", "status", "effective_status", "creative_id", "created_time", "updated_time", "tracking_specs", "conversion_domain", "issues_info", "preview_shareable_link", "ad_review_feedback" ], "title": "IntegrationsMetaadsAdsGetResponse", "type": "object" }, "IntegrationsMetaadsAdsListRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "created_after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created After" }, "created_before": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created Before" }, "effective_status": { "items": { "enum": [ "ACTIVE", "PAUSED", "DELETED", "ARCHIVED", "IN_PROCESS", "WITH_ISSUES", "PENDING_REVIEW", "DISAPPROVED", "PREAPPROVED", "PENDING_BILLING_INFO", "CAMPAIGN_PAUSED", "ADSET_PAUSED" ], "type": "string" }, "maxItems": 12, "title": "Effective Status", "type": "array" }, "objective": { "items": { "pattern": "^[A-Z_]{1,40}$", "type": "string" }, "maxItems": 10, "title": "Objective", "type": "array" }, "ad_account_id": { "pattern": "^(act_)?[0-9]{1,32}$", "title": "Ad Account Id", "type": "string" }, "campaign_id": { "anyOf": [ { "pattern": "^[0-9]{1,32}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Campaign Id" }, "ad_set_id": { "anyOf": [ { "pattern": "^[0-9]{1,32}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Ad Set Id" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "ad_account_id" ], "title": "IntegrationsMetaadsAdsListRequest", "type": "object" }, "IntegrationsMetaadsAdsListResponseAdItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "campaign_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Campaign Id" }, "adset_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Adset Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "effective_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Effective Status" }, "creative_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Creative Id" }, "created_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created Time" }, "updated_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated Time" } }, "required": [ "id", "name", "campaign_id", "adset_id", "status", "effective_status", "creative_id", "created_time", "updated_time" ], "title": "IntegrationsMetaadsAdsListResponseAdItem", "type": "object" }, "IntegrationsMetaadsAdsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsMetaadsAdsListResponseAdItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsMetaadsAdsListResponse", "type": "object" }, "IntegrationsMetaadsCampaignsGetRequest": { "additionalProperties": false, "properties": { "ad_account_id": { "pattern": "^(act_)?[0-9]{1,32}$", "title": "Ad Account Id", "type": "string" }, "campaign_id": { "pattern": "^[0-9]{1,32}$", "title": "Campaign Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "ad_account_id", "campaign_id" ], "title": "IntegrationsMetaadsCampaignsGetRequest", "type": "object" }, "IntegrationsMetaadsCampaignsGetResponse": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "objective": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Objective" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "effective_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Effective Status" }, "daily_budget": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Daily Budget" }, "lifetime_budget": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Lifetime Budget" }, "budget_remaining": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Budget Remaining" }, "bid_strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bid Strategy" }, "buying_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Buying Type" }, "start_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Time" }, "stop_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stop Time" }, "created_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created Time" }, "updated_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated Time" }, "spend_cap": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Spend Cap" }, "special_ad_categories": { "items": { "type": "string" }, "title": "Special Ad Categories", "type": "array" }, "issues_info": { "items": { "additionalProperties": true, "type": "object" }, "title": "Issues Info", "type": "array" } }, "required": [ "id", "name", "objective", "status", "effective_status", "daily_budget", "lifetime_budget", "budget_remaining", "bid_strategy", "buying_type", "start_time", "stop_time", "created_time", "updated_time", "spend_cap", "special_ad_categories", "issues_info" ], "title": "IntegrationsMetaadsCampaignsGetResponse", "type": "object" }, "IntegrationsMetaadsCampaignsListRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "created_after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created After" }, "created_before": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created Before" }, "effective_status": { "items": { "enum": [ "ACTIVE", "PAUSED", "DELETED", "ARCHIVED", "IN_PROCESS", "WITH_ISSUES", "PENDING_REVIEW", "DISAPPROVED", "PREAPPROVED", "PENDING_BILLING_INFO", "CAMPAIGN_PAUSED", "ADSET_PAUSED" ], "type": "string" }, "maxItems": 12, "title": "Effective Status", "type": "array" }, "objective": { "items": { "pattern": "^[A-Z_]{1,40}$", "type": "string" }, "maxItems": 10, "title": "Objective", "type": "array" }, "ad_account_id": { "pattern": "^(act_)?[0-9]{1,32}$", "title": "Ad Account Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "ad_account_id" ], "title": "IntegrationsMetaadsCampaignsListRequest", "type": "object" }, "IntegrationsMetaadsCampaignsListResponseCampaignItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "objective": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Objective" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "effective_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Effective Status" }, "daily_budget": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Daily Budget" }, "lifetime_budget": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Lifetime Budget" }, "budget_remaining": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Budget Remaining" }, "bid_strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bid Strategy" }, "buying_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Buying Type" }, "start_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Time" }, "stop_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stop Time" }, "created_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created Time" }, "updated_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated Time" } }, "required": [ "id", "name", "objective", "status", "effective_status", "daily_budget", "lifetime_budget", "budget_remaining", "bid_strategy", "buying_type", "start_time", "stop_time", "created_time", "updated_time" ], "title": "IntegrationsMetaadsCampaignsListResponseCampaignItem", "type": "object" }, "IntegrationsMetaadsCampaignsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsMetaadsCampaignsListResponseCampaignItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsMetaadsCampaignsListResponse", "type": "object" }, "IntegrationsMetaadsCustomAudiencesGetRequest": { "additionalProperties": false, "properties": { "ad_account_id": { "pattern": "^(act_)?[0-9]{1,32}$", "title": "Ad Account Id", "type": "string" }, "audience_id": { "pattern": "^[0-9]{1,32}$", "title": "Audience Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "ad_account_id", "audience_id" ], "title": "IntegrationsMetaadsCustomAudiencesGetRequest", "type": "object" }, "IntegrationsMetaadsCustomAudiencesGetResponse": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "subtype": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subtype" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "approximate_count_lower_bound": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Approximate Count Lower Bound" }, "approximate_count_upper_bound": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Approximate Count Upper Bound" }, "delivery_status": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Delivery Status" }, "operation_status": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Operation Status" }, "retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Retention Days" }, "data_source": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Data Source" }, "time_created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Time Created" }, "time_updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Time Updated" }, "rule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rule" }, "lookalike_spec": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Lookalike Spec" }, "sharing_status": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Sharing Status" } }, "required": [ "id", "name", "subtype", "description", "approximate_count_lower_bound", "approximate_count_upper_bound", "delivery_status", "operation_status", "retention_days", "data_source", "time_created", "time_updated", "rule", "lookalike_spec", "sharing_status" ], "title": "IntegrationsMetaadsCustomAudiencesGetResponse", "type": "object" }, "IntegrationsMetaadsCustomAudiencesListRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "ad_account_id": { "pattern": "^(act_)?[0-9]{1,32}$", "title": "Ad Account Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "ad_account_id" ], "title": "IntegrationsMetaadsCustomAudiencesListRequest", "type": "object" }, "IntegrationsMetaadsCustomAudiencesListResponseCustomAudienceItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "subtype": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subtype" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "approximate_count_lower_bound": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Approximate Count Lower Bound" }, "approximate_count_upper_bound": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Approximate Count Upper Bound" }, "delivery_status": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Delivery Status" }, "operation_status": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Operation Status" }, "retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Retention Days" }, "data_source": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Data Source" }, "time_created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Time Created" }, "time_updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Time Updated" } }, "required": [ "id", "name", "subtype", "description", "approximate_count_lower_bound", "approximate_count_upper_bound", "delivery_status", "operation_status", "retention_days", "data_source", "time_created", "time_updated" ], "title": "IntegrationsMetaadsCustomAudiencesListResponseCustomAudienceItem", "type": "object" }, "IntegrationsMetaadsCustomAudiencesListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsMetaadsCustomAudiencesListResponseCustomAudienceItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsMetaadsCustomAudiencesListResponse", "type": "object" }, "IntegrationsMetaadsInsightsGetReportRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "ad_account_id": { "pattern": "^(act_)?[0-9]{1,32}$", "title": "Ad Account Id", "type": "string" }, "report_run_id": { "pattern": "^[0-9]{1,32}$", "title": "Report Run Id", "type": "string" }, "simplify": { "default": true, "title": "Simplify", "type": "boolean" }, "limit": { "default": 50, "maximum": 250, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "ad_account_id", "report_run_id" ], "title": "IntegrationsMetaadsInsightsGetReportRequest", "type": "object" }, "IntegrationsMetaadsInsightsGetReportResponseActionStat": { "additionalProperties": false, "properties": { "action_type": { "title": "Action Type", "type": "string" }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Value" }, "cost": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cost" }, "value_total": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Value Total" }, "action_device": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Device" }, "action_destination": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Destination" }, "action_target_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Target Id" }, "action_reaction": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Reaction" }, "window_1d_click": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Window 1D Click" }, "window_7d_click": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Window 7D Click" }, "window_28d_click": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Window 28D Click" }, "window_1d_view": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Window 1D View" }, "window_7d_view": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Window 7D View" }, "window_28d_view": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Window 28D View" } }, "required": [ "action_type", "value", "cost", "value_total", "action_device", "action_destination", "action_target_id", "action_reaction", "window_1d_click", "window_7d_click", "window_28d_click", "window_1d_view", "window_7d_view", "window_28d_view" ], "title": "IntegrationsMetaadsInsightsGetReportResponseActionStat", "type": "object" }, "IntegrationsMetaadsInsightsGetReportResponseInsightRow": { "additionalProperties": false, "properties": { "level": { "enum": [ "account", "campaign", "adset", "ad" ], "title": "Level", "type": "string" }, "campaign_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Campaign Id" }, "campaign_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Campaign Name" }, "adset_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Adset Id" }, "adset_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Adset Name" }, "ad_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ad Id" }, "ad_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ad Name" }, "date_start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date Start" }, "date_stop": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date Stop" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency" }, "objective": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Objective" }, "optimization_goal": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Optimization Goal" }, "breakdowns": { "additionalProperties": { "type": "string" }, "title": "Breakdowns", "type": "object" }, "spend": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Spend" }, "impressions": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Impressions" }, "reach": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Reach" }, "frequency": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Frequency" }, "clicks": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Clicks" }, "unique_clicks": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Unique Clicks" }, "link_clicks": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Link Clicks" }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ctr" }, "link_ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Link Ctr" }, "cpc": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cpc" }, "cpm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cpm" }, "cpp": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cpp" }, "landing_page_views": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Landing Page Views" }, "leads": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Leads" }, "cost_per_lead": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cost Per Lead" }, "purchases": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Purchases" }, "purchase_value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Purchase Value" }, "roas": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Roas" }, "cost_per_purchase": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cost Per Purchase" }, "video_thruplays": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Video Thruplays" }, "video_p25": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Video P25" }, "video_p50": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Video P50" }, "video_p75": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Video P75" }, "video_p100": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Video P100" }, "actions": { "items": { "$ref": "#/components/schemas/IntegrationsMetaadsInsightsGetReportResponseActionStat" }, "title": "Actions", "type": "array" }, "raw": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Raw" } }, "required": [ "level", "campaign_id", "campaign_name", "adset_id", "adset_name", "ad_id", "ad_name", "date_start", "date_stop", "currency", "objective", "optimization_goal", "breakdowns", "spend", "impressions", "reach", "frequency", "clicks", "unique_clicks", "link_clicks", "ctr", "link_ctr", "cpc", "cpm", "cpp", "landing_page_views", "leads", "cost_per_lead", "purchases", "purchase_value", "roas", "cost_per_purchase", "video_thruplays", "video_p25", "video_p50", "video_p75", "video_p100", "actions", "raw" ], "title": "IntegrationsMetaadsInsightsGetReportResponseInsightRow", "type": "object" }, "IntegrationsMetaadsInsightsGetReportResponse": { "additionalProperties": false, "properties": { "report_run_id": { "title": "Report Run Id", "type": "string" }, "status": { "title": "Status", "type": "string" }, "percent_complete": { "title": "Percent Complete", "type": "integer" }, "completed": { "title": "Completed", "type": "boolean" }, "rows": { "items": { "$ref": "#/components/schemas/IntegrationsMetaadsInsightsGetReportResponseInsightRow" }, "title": "Rows", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency" } }, "required": [ "report_run_id", "status", "percent_complete", "completed", "rows", "next_cursor", "currency" ], "title": "IntegrationsMetaadsInsightsGetReportResponse", "type": "object" }, "IntegrationsMetaadsInsightsQueryRequestInsightFilter": { "additionalProperties": false, "properties": { "field": { "pattern": "^[a-z0-9_.]{1,64}$", "title": "Field", "type": "string" }, "operator": { "enum": [ "EQUAL", "NOT_EQUAL", "GREATER_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN", "LESS_THAN_OR_EQUAL", "CONTAIN", "NOT_CONTAIN", "CONTAINS_ANY", "CONTAINS_ALL", "NOT_CONTAINS_ANY", "IN", "NOT_IN", "STARTS_WITH", "ENDS_WITH", "ANY", "ALL", "NONE" ], "title": "Operator", "type": "string" }, "value": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "items": { "maxLength": 40, "minLength": 1, "type": "string" }, "type": "array" } ], "title": "Value" } }, "required": [ "field", "operator", "value" ], "title": "IntegrationsMetaadsInsightsQueryRequestInsightFilter", "type": "object" }, "IntegrationsMetaadsInsightsQueryRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "ad_account_id": { "pattern": "^(act_)?[0-9]{1,32}$", "title": "Ad Account Id", "type": "string" }, "level": { "default": "campaign", "enum": [ "account", "campaign", "adset", "ad" ], "title": "Level", "type": "string" }, "object_id": { "anyOf": [ { "pattern": "^[0-9]{1,32}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Object Id" }, "date_preset": { "anyOf": [ { "enum": [ "today", "yesterday", "this_month", "last_month", "this_quarter", "last_quarter", "this_year", "last_year", "maximum", "data_maximum", "last_3d", "last_7d", "last_14d", "last_28d", "last_30d", "last_90d", "last_week_mon_sun", "last_week_sun_sat", "this_week_mon_today", "this_week_sun_today" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Date Preset" }, "since": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Since" }, "until": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Until" }, "time_increment": { "anyOf": [ { "enum": [ "all_days", "monthly" ], "type": "string" }, { "maximum": 90, "minimum": 1, "type": "integer" } ], "default": "all_days", "title": "Time Increment" }, "breakdowns": { "items": { "enum": [ "age", "gender", "country", "region", "dma", "publisher_platform", "platform_position", "device_platform", "impression_device", "product_id", "frequency_value", "hourly_stats_aggregated_by_advertiser_time_zone" ], "type": "string" }, "maxItems": 3, "title": "Breakdowns", "type": "array" }, "action_breakdowns": { "items": { "enum": [ "action_type", "action_device", "action_destination", "action_target_id", "action_reaction" ], "type": "string" }, "maxItems": 5, "minItems": 1, "title": "Action Breakdowns", "type": "array" }, "attribution_windows": { "items": { "enum": [ "1d_view", "7d_view", "28d_view", "1d_click", "7d_click", "28d_click" ], "type": "string" }, "maxItems": 6, "minItems": 1, "title": "Attribution Windows", "type": "array" }, "filtering": { "items": { "$ref": "#/components/schemas/IntegrationsMetaadsInsightsQueryRequestInsightFilter" }, "maxItems": 3, "title": "Filtering", "type": "array" }, "sort": { "anyOf": [ { "pattern": "^[a-z0-9_]{1,64}_(ascending|descending)$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Sort" }, "simplify": { "default": true, "title": "Simplify", "type": "boolean" }, "fields": { "items": { "pattern": "^[a-z0-9_]{1,48}$", "type": "string" }, "maxItems": 30, "title": "Fields", "type": "array" }, "limit": { "default": 50, "maximum": 250, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "ad_account_id" ], "title": "IntegrationsMetaadsInsightsQueryRequest", "type": "object" }, "IntegrationsMetaadsInsightsQueryResponseActionStat": { "additionalProperties": false, "properties": { "action_type": { "title": "Action Type", "type": "string" }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Value" }, "cost": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cost" }, "value_total": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Value Total" }, "action_device": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Device" }, "action_destination": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Destination" }, "action_target_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Target Id" }, "action_reaction": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Reaction" }, "window_1d_click": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Window 1D Click" }, "window_7d_click": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Window 7D Click" }, "window_28d_click": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Window 28D Click" }, "window_1d_view": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Window 1D View" }, "window_7d_view": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Window 7D View" }, "window_28d_view": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Window 28D View" } }, "required": [ "action_type", "value", "cost", "value_total", "action_device", "action_destination", "action_target_id", "action_reaction", "window_1d_click", "window_7d_click", "window_28d_click", "window_1d_view", "window_7d_view", "window_28d_view" ], "title": "IntegrationsMetaadsInsightsQueryResponseActionStat", "type": "object" }, "IntegrationsMetaadsInsightsQueryResponseInsightRow": { "additionalProperties": false, "properties": { "level": { "enum": [ "account", "campaign", "adset", "ad" ], "title": "Level", "type": "string" }, "campaign_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Campaign Id" }, "campaign_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Campaign Name" }, "adset_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Adset Id" }, "adset_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Adset Name" }, "ad_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ad Id" }, "ad_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ad Name" }, "date_start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date Start" }, "date_stop": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date Stop" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency" }, "objective": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Objective" }, "optimization_goal": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Optimization Goal" }, "breakdowns": { "additionalProperties": { "type": "string" }, "title": "Breakdowns", "type": "object" }, "spend": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Spend" }, "impressions": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Impressions" }, "reach": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Reach" }, "frequency": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Frequency" }, "clicks": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Clicks" }, "unique_clicks": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Unique Clicks" }, "link_clicks": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Link Clicks" }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ctr" }, "link_ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Link Ctr" }, "cpc": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cpc" }, "cpm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cpm" }, "cpp": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cpp" }, "landing_page_views": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Landing Page Views" }, "leads": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Leads" }, "cost_per_lead": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cost Per Lead" }, "purchases": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Purchases" }, "purchase_value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Purchase Value" }, "roas": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Roas" }, "cost_per_purchase": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cost Per Purchase" }, "video_thruplays": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Video Thruplays" }, "video_p25": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Video P25" }, "video_p50": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Video P50" }, "video_p75": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Video P75" }, "video_p100": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Video P100" }, "actions": { "items": { "$ref": "#/components/schemas/IntegrationsMetaadsInsightsQueryResponseActionStat" }, "title": "Actions", "type": "array" }, "raw": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Raw" } }, "required": [ "level", "campaign_id", "campaign_name", "adset_id", "adset_name", "ad_id", "ad_name", "date_start", "date_stop", "currency", "objective", "optimization_goal", "breakdowns", "spend", "impressions", "reach", "frequency", "clicks", "unique_clicks", "link_clicks", "ctr", "link_ctr", "cpc", "cpm", "cpp", "landing_page_views", "leads", "cost_per_lead", "purchases", "purchase_value", "roas", "cost_per_purchase", "video_thruplays", "video_p25", "video_p50", "video_p75", "video_p100", "actions", "raw" ], "title": "IntegrationsMetaadsInsightsQueryResponseInsightRow", "type": "object" }, "IntegrationsMetaadsInsightsQueryResponse": { "additionalProperties": false, "properties": { "rows": { "items": { "$ref": "#/components/schemas/IntegrationsMetaadsInsightsQueryResponseInsightRow" }, "title": "Rows", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency" } }, "required": [ "rows", "next_cursor", "currency" ], "title": "IntegrationsMetaadsInsightsQueryResponse", "type": "object" }, "IntegrationsMetaadsInsightsStartReportRequestInsightFilter": { "additionalProperties": false, "properties": { "field": { "pattern": "^[a-z0-9_.]{1,64}$", "title": "Field", "type": "string" }, "operator": { "enum": [ "EQUAL", "NOT_EQUAL", "GREATER_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN", "LESS_THAN_OR_EQUAL", "CONTAIN", "NOT_CONTAIN", "CONTAINS_ANY", "CONTAINS_ALL", "NOT_CONTAINS_ANY", "IN", "NOT_IN", "STARTS_WITH", "ENDS_WITH", "ANY", "ALL", "NONE" ], "title": "Operator", "type": "string" }, "value": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "items": { "maxLength": 40, "minLength": 1, "type": "string" }, "type": "array" } ], "title": "Value" } }, "required": [ "field", "operator", "value" ], "title": "IntegrationsMetaadsInsightsStartReportRequestInsightFilter", "type": "object" }, "IntegrationsMetaadsInsightsStartReportRequest": { "additionalProperties": false, "properties": { "ad_account_id": { "pattern": "^(act_)?[0-9]{1,32}$", "title": "Ad Account Id", "type": "string" }, "level": { "default": "campaign", "enum": [ "account", "campaign", "adset", "ad" ], "title": "Level", "type": "string" }, "object_id": { "anyOf": [ { "pattern": "^[0-9]{1,32}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Object Id" }, "date_preset": { "anyOf": [ { "enum": [ "today", "yesterday", "this_month", "last_month", "this_quarter", "last_quarter", "this_year", "last_year", "maximum", "data_maximum", "last_3d", "last_7d", "last_14d", "last_28d", "last_30d", "last_90d", "last_week_mon_sun", "last_week_sun_sat", "this_week_mon_today", "this_week_sun_today" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Date Preset" }, "since": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Since" }, "until": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Until" }, "time_increment": { "anyOf": [ { "enum": [ "all_days", "monthly" ], "type": "string" }, { "maximum": 90, "minimum": 1, "type": "integer" } ], "default": "all_days", "title": "Time Increment" }, "breakdowns": { "items": { "enum": [ "age", "gender", "country", "region", "dma", "publisher_platform", "platform_position", "device_platform", "impression_device", "product_id", "frequency_value", "hourly_stats_aggregated_by_advertiser_time_zone" ], "type": "string" }, "maxItems": 3, "title": "Breakdowns", "type": "array" }, "action_breakdowns": { "items": { "enum": [ "action_type", "action_device", "action_destination", "action_target_id", "action_reaction" ], "type": "string" }, "maxItems": 5, "minItems": 1, "title": "Action Breakdowns", "type": "array" }, "attribution_windows": { "items": { "enum": [ "1d_view", "7d_view", "28d_view", "1d_click", "7d_click", "28d_click" ], "type": "string" }, "maxItems": 6, "minItems": 1, "title": "Attribution Windows", "type": "array" }, "filtering": { "items": { "$ref": "#/components/schemas/IntegrationsMetaadsInsightsStartReportRequestInsightFilter" }, "maxItems": 3, "title": "Filtering", "type": "array" }, "sort": { "anyOf": [ { "pattern": "^[a-z0-9_]{1,64}_(ascending|descending)$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Sort" }, "simplify": { "default": true, "title": "Simplify", "type": "boolean" }, "fields": { "items": { "pattern": "^[a-z0-9_]{1,48}$", "type": "string" }, "maxItems": 30, "title": "Fields", "type": "array" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "ad_account_id" ], "title": "IntegrationsMetaadsInsightsStartReportRequest", "type": "object" }, "IntegrationsMetaadsInsightsStartReportResponse": { "additionalProperties": false, "properties": { "report_run_id": { "title": "Report Run Id", "type": "string" } }, "required": [ "report_run_id" ], "title": "IntegrationsMetaadsInsightsStartReportResponse", "type": "object" }, "IntegrationsMetaadsLeadFormsGetRequest": { "additionalProperties": false, "properties": { "page_id": { "pattern": "^[0-9]{1,32}$", "title": "Page Id", "type": "string" }, "form_id": { "pattern": "^[0-9]{1,32}$", "title": "Form Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "page_id", "form_id" ], "title": "IntegrationsMetaadsLeadFormsGetRequest", "type": "object" }, "IntegrationsMetaadsLeadFormsGetResponseLeadFormQuestion": { "additionalProperties": false, "properties": { "key": { "title": "Key", "type": "string" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" }, "options": { "items": { "additionalProperties": true, "type": "object" }, "title": "Options", "type": "array" } }, "required": [ "key", "label", "type", "options" ], "title": "IntegrationsMetaadsLeadFormsGetResponseLeadFormQuestion", "type": "object" }, "IntegrationsMetaadsLeadFormsGetResponse": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale" }, "leads_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Leads Count" }, "expired_leads_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expired Leads Count" }, "organic_leads_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Organic Leads Count" }, "created_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created Time" }, "privacy_policy_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Privacy Policy Url" }, "follow_up_action_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Follow Up Action Url" }, "questions": { "items": { "$ref": "#/components/schemas/IntegrationsMetaadsLeadFormsGetResponseLeadFormQuestion" }, "title": "Questions", "type": "array" } }, "required": [ "id", "name", "status", "locale", "leads_count", "expired_leads_count", "organic_leads_count", "created_time", "privacy_policy_url", "follow_up_action_url", "questions" ], "title": "IntegrationsMetaadsLeadFormsGetResponse", "type": "object" }, "IntegrationsMetaadsLeadFormsListRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "page_id": { "pattern": "^[0-9]{1,32}$", "title": "Page Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "page_id" ], "title": "IntegrationsMetaadsLeadFormsListRequest", "type": "object" }, "IntegrationsMetaadsLeadFormsListResponseLeadFormItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale" }, "leads_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Leads Count" }, "expired_leads_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expired Leads Count" }, "organic_leads_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Organic Leads Count" }, "created_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created Time" }, "privacy_policy_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Privacy Policy Url" }, "follow_up_action_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Follow Up Action Url" } }, "required": [ "id", "name", "status", "locale", "leads_count", "expired_leads_count", "organic_leads_count", "created_time", "privacy_policy_url", "follow_up_action_url" ], "title": "IntegrationsMetaadsLeadFormsListResponseLeadFormItem", "type": "object" }, "IntegrationsMetaadsLeadFormsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsMetaadsLeadFormsListResponseLeadFormItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsMetaadsLeadFormsListResponse", "type": "object" }, "IntegrationsMetaadsLeadsListRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "created_after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created After" }, "created_before": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created Before" }, "page_id": { "pattern": "^[0-9]{1,32}$", "title": "Page Id", "type": "string" }, "form_id": { "pattern": "^[0-9]{1,32}$", "title": "Form Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "page_id", "form_id" ], "title": "IntegrationsMetaadsLeadsListRequest", "type": "object" }, "IntegrationsMetaadsLeadsListResponseLeadFieldValue": { "additionalProperties": false, "properties": { "name": { "title": "Name", "type": "string" }, "values": { "items": { "type": "string" }, "title": "Values", "type": "array" } }, "required": [ "name", "values" ], "title": "IntegrationsMetaadsLeadsListResponseLeadFieldValue", "type": "object" }, "IntegrationsMetaadsLeadsListResponseLeadItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "created_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created Time" }, "ad_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ad Id" }, "ad_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ad Name" }, "adset_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Adset Id" }, "campaign_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Campaign Id" }, "form_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form Id" }, "is_organic": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Organic" }, "platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform" }, "field_data": { "items": { "$ref": "#/components/schemas/IntegrationsMetaadsLeadsListResponseLeadFieldValue" }, "title": "Field Data", "type": "array" } }, "required": [ "id", "created_time", "ad_id", "ad_name", "adset_id", "campaign_id", "form_id", "is_organic", "platform", "field_data" ], "title": "IntegrationsMetaadsLeadsListResponseLeadItem", "type": "object" }, "IntegrationsMetaadsLeadsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsMetaadsLeadsListResponseLeadItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsMetaadsLeadsListResponse", "type": "object" }, "IntegrationsMetaadsPagesListRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsMetaadsPagesListRequest", "type": "object" }, "IntegrationsMetaadsPagesListResponsePageItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "tasks": { "items": { "type": "string" }, "title": "Tasks", "type": "array" } }, "required": [ "id", "name", "category", "tasks" ], "title": "IntegrationsMetaadsPagesListResponsePageItem", "type": "object" }, "IntegrationsMetaadsPagesListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsMetaadsPagesListResponsePageItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsMetaadsPagesListResponse", "type": "object" }, "IntegrationsMetaadsPixelsGetRequest": { "additionalProperties": false, "properties": { "ad_account_id": { "pattern": "^(act_)?[0-9]{1,32}$", "title": "Ad Account Id", "type": "string" }, "pixel_id": { "pattern": "^[0-9]{1,32}$", "title": "Pixel Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "ad_account_id", "pixel_id" ], "title": "IntegrationsMetaadsPixelsGetRequest", "type": "object" }, "IntegrationsMetaadsPixelsGetResponseReference": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" } }, "required": [ "id", "name" ], "title": "IntegrationsMetaadsPixelsGetResponseReference", "type": "object" }, "IntegrationsMetaadsPixelsGetResponse": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "creation_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Creation Time" }, "last_fired_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Fired Time" }, "is_created_by_business": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Created By Business" }, "owner_business": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsMetaadsPixelsGetResponseReference" }, { "type": "null" } ] }, "data_use_setting": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Data Use Setting" }, "enable_automatic_matching": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enable Automatic Matching" } }, "required": [ "id", "name", "creation_time", "last_fired_time", "is_created_by_business", "owner_business", "data_use_setting", "enable_automatic_matching" ], "title": "IntegrationsMetaadsPixelsGetResponse", "type": "object" }, "IntegrationsMetaadsPixelsListRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "ad_account_id": { "pattern": "^(act_)?[0-9]{1,32}$", "title": "Ad Account Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "ad_account_id" ], "title": "IntegrationsMetaadsPixelsListRequest", "type": "object" }, "IntegrationsMetaadsPixelsListResponsePixelItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "creation_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Creation Time" }, "last_fired_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Fired Time" }, "is_created_by_business": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Created By Business" }, "owner_business": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsMetaadsPixelsListResponseReference" }, { "type": "null" } ] }, "data_use_setting": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Data Use Setting" }, "enable_automatic_matching": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enable Automatic Matching" } }, "required": [ "id", "name", "creation_time", "last_fired_time", "is_created_by_business", "owner_business", "data_use_setting", "enable_automatic_matching" ], "title": "IntegrationsMetaadsPixelsListResponsePixelItem", "type": "object" }, "IntegrationsMetaadsPixelsListResponseReference": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" } }, "required": [ "id", "name" ], "title": "IntegrationsMetaadsPixelsListResponseReference", "type": "object" }, "IntegrationsMetaadsPixelsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsMetaadsPixelsListResponsePixelItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsMetaadsPixelsListResponse", "type": "object" }, "IntegrationsMetaadsSavedAudiencesListRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:%-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "ad_account_id": { "pattern": "^(act_)?[0-9]{1,32}$", "title": "Ad Account Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "ad_account_id" ], "title": "IntegrationsMetaadsSavedAudiencesListRequest", "type": "object" }, "IntegrationsMetaadsSavedAudiencesListResponseSavedAudienceItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "targeting": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Targeting" }, "approximate_count_lower_bound": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Approximate Count Lower Bound" }, "approximate_count_upper_bound": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Approximate Count Upper Bound" }, "run_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Run Status" }, "sentence_lines": { "items": { "additionalProperties": true, "type": "object" }, "title": "Sentence Lines", "type": "array" }, "time_created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Time Created" }, "time_updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Time Updated" } }, "required": [ "id", "name", "description", "targeting", "approximate_count_lower_bound", "approximate_count_upper_bound", "run_status", "sentence_lines", "time_created", "time_updated" ], "title": "IntegrationsMetaadsSavedAudiencesListResponseSavedAudienceItem", "type": "object" }, "IntegrationsMetaadsSavedAudiencesListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsMetaadsSavedAudiencesListResponseSavedAudienceItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsMetaadsSavedAudiencesListResponse", "type": "object" }, "IntegrationsMicrosoft365AttachmentsImportRequest": { "additionalProperties": false, "properties": { "mail_folder_id": { "default": "inbox", "pattern": "^[A-Za-z0-9_\\-=!.]{1,512}$", "title": "Mail Folder Id", "type": "string" }, "message_id": { "pattern": "^[A-Za-z0-9_\\-=!.]{1,512}$", "title": "Message Id", "type": "string" }, "attachment_id": { "pattern": "^[A-Za-z0-9_\\-=!.]{1,512}$", "title": "Attachment Id", "type": "string" }, "folder_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Folder Id" }, "file_name": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "File Name" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "message_id", "attachment_id" ], "title": "IntegrationsMicrosoft365AttachmentsImportRequest", "type": "object" }, "IntegrationsMicrosoft365AttachmentsImportResponse": { "type": "object", "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "job_id": { "type": "string" }, "safe_error_code": { "type": "string" } }, "required": [ "invocation_id", "status", "job_id" ], "additionalProperties": false, "title": "IntegrationsMicrosoft365AttachmentsImportResponse" }, "IntegrationsMicrosoft365AttachmentsListRequest": { "additionalProperties": false, "properties": { "mail_folder_id": { "default": "inbox", "pattern": "^[A-Za-z0-9_\\-=!.]{1,512}$", "title": "Mail Folder Id", "type": "string" }, "message_id": { "pattern": "^[A-Za-z0-9_\\-=!.]{1,512}$", "title": "Message Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "message_id" ], "title": "IntegrationsMicrosoft365AttachmentsListRequest", "type": "object" }, "IntegrationsMicrosoft365AttachmentsListResponseAttachmentItem": { "additionalProperties": false, "properties": { "attachment_id": { "title": "Attachment Id", "type": "string" }, "file_name": { "title": "File Name", "type": "string" }, "content_type": { "title": "Content Type", "type": "string" }, "size": { "title": "Size", "type": "integer" }, "inline": { "title": "Inline", "type": "boolean" }, "importable": { "title": "Importable", "type": "boolean" } }, "required": [ "attachment_id", "file_name", "content_type", "size", "inline", "importable" ], "title": "IntegrationsMicrosoft365AttachmentsListResponseAttachmentItem", "type": "object" }, "IntegrationsMicrosoft365AttachmentsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsMicrosoft365AttachmentsListResponseAttachmentItem" }, "title": "Items", "type": "array" }, "truncated": { "title": "Truncated", "type": "boolean" } }, "required": [ "items", "truncated" ], "title": "IntegrationsMicrosoft365AttachmentsListResponse", "type": "object" }, "IntegrationsMicrosoft365DrivesListRequest": { "additionalProperties": false, "properties": { "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsMicrosoft365DrivesListRequest", "type": "object" }, "IntegrationsMicrosoft365DrivesListResponseDriveItemSummary": { "additionalProperties": false, "properties": { "drive_id": { "title": "Drive Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "drive_type": { "title": "Drive Type", "type": "string" }, "site_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Site Name" }, "web_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Web Url" } }, "required": [ "drive_id", "name", "drive_type", "site_name", "web_url" ], "title": "IntegrationsMicrosoft365DrivesListResponseDriveItemSummary", "type": "object" }, "IntegrationsMicrosoft365DrivesListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsMicrosoft365DrivesListResponseDriveItemSummary" }, "title": "Items", "type": "array" }, "truncated": { "title": "Truncated", "type": "boolean" } }, "required": [ "items", "truncated" ], "title": "IntegrationsMicrosoft365DrivesListResponse", "type": "object" }, "IntegrationsMicrosoft365FilesImportRequest": { "additionalProperties": false, "properties": { "drive_id": { "pattern": "^[A-Za-z0-9_\\-=!.]{1,512}$", "title": "Drive Id", "type": "string" }, "item_id": { "pattern": "^[A-Za-z0-9_\\-=!.]{1,512}$", "title": "Item Id", "type": "string" }, "folder_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Folder Id" }, "file_name": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "File Name" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "drive_id", "item_id" ], "title": "IntegrationsMicrosoft365FilesImportRequest", "type": "object" }, "IntegrationsMicrosoft365FilesImportResponse": { "type": "object", "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "job_id": { "type": "string" }, "safe_error_code": { "type": "string" } }, "required": [ "invocation_id", "status", "job_id" ], "additionalProperties": false, "title": "IntegrationsMicrosoft365FilesImportResponse" }, "IntegrationsMicrosoft365FilesListRequest": { "additionalProperties": false, "properties": { "drive_id": { "pattern": "^[A-Za-z0-9_\\-=!.]{1,512}$", "title": "Drive Id", "type": "string" }, "item_id": { "anyOf": [ { "pattern": "^[A-Za-z0-9_\\-=!.]{1,512}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Item Id" }, "cursor": { "anyOf": [ { "pattern": "^(skip:[0-9]{1,9}|skiptoken:[A-Za-z0-9_\\-=%.!*'()+/:,]{1,1500})$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "drive_id" ], "title": "IntegrationsMicrosoft365FilesListRequest", "type": "object" }, "IntegrationsMicrosoft365FilesListResponseFileItem": { "additionalProperties": false, "properties": { "item_id": { "title": "Item Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "is_folder": { "title": "Is Folder", "type": "boolean" }, "size": { "title": "Size", "type": "integer" }, "mime_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mime Type" }, "child_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Child Count" }, "last_modified": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Modified" }, "etag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Etag" }, "web_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Web Url" } }, "required": [ "item_id", "name", "is_folder", "size", "mime_type", "child_count", "last_modified", "etag", "web_url" ], "title": "IntegrationsMicrosoft365FilesListResponseFileItem", "type": "object" }, "IntegrationsMicrosoft365FilesListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsMicrosoft365FilesListResponseFileItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsMicrosoft365FilesListResponse", "type": "object" }, "IntegrationsMicrosoft365MailfoldersListRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^(skip:[0-9]{1,9}|skiptoken:[A-Za-z0-9_\\-=%.!*'()+/:,]{1,1500})$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsMicrosoft365MailfoldersListRequest", "type": "object" }, "IntegrationsMicrosoft365MailfoldersListResponseMailFolderItem": { "additionalProperties": false, "properties": { "folder_id": { "title": "Folder Id", "type": "string" }, "display_name": { "title": "Display Name", "type": "string" }, "total_count": { "title": "Total Count", "type": "integer" }, "unread_count": { "title": "Unread Count", "type": "integer" }, "child_folder_count": { "title": "Child Folder Count", "type": "integer" } }, "required": [ "folder_id", "display_name", "total_count", "unread_count", "child_folder_count" ], "title": "IntegrationsMicrosoft365MailfoldersListResponseMailFolderItem", "type": "object" }, "IntegrationsMicrosoft365MailfoldersListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsMicrosoft365MailfoldersListResponseMailFolderItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsMicrosoft365MailfoldersListResponse", "type": "object" }, "IntegrationsMicrosoft365MessagesGetRequest": { "additionalProperties": false, "properties": { "mail_folder_id": { "default": "inbox", "pattern": "^[A-Za-z0-9_\\-=!.]{1,512}$", "title": "Mail Folder Id", "type": "string" }, "message_id": { "pattern": "^[A-Za-z0-9_\\-=!.]{1,512}$", "title": "Message Id", "type": "string" }, "include_html": { "default": false, "title": "Include Html", "type": "boolean" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "message_id" ], "title": "IntegrationsMicrosoft365MessagesGetRequest", "type": "object" }, "IntegrationsMicrosoft365MessagesGetResponse": { "additionalProperties": false, "properties": { "message_id": { "title": "Message Id", "type": "string" }, "internet_message_id": { "title": "Internet Message Id", "type": "string" }, "subject": { "title": "Subject", "type": "string" }, "sender": { "title": "Sender", "type": "string" }, "recipients": { "items": { "type": "string" }, "title": "Recipients", "type": "array" }, "cc": { "items": { "type": "string" }, "title": "Cc", "type": "array" }, "received_at": { "title": "Received At", "type": "string" }, "is_read": { "title": "Is Read", "type": "boolean" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Text" }, "text_truncated": { "title": "Text Truncated", "type": "boolean" }, "html": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Html" }, "html_truncated": { "title": "Html Truncated", "type": "boolean" }, "has_attachments": { "title": "Has Attachments", "type": "boolean" } }, "required": [ "message_id", "internet_message_id", "subject", "sender", "recipients", "cc", "received_at", "is_read", "text", "text_truncated", "html", "html_truncated", "has_attachments" ], "title": "IntegrationsMicrosoft365MessagesGetResponse", "type": "object" }, "IntegrationsMicrosoft365MessagesSearchRequest": { "additionalProperties": false, "properties": { "mail_folder_id": { "default": "inbox", "pattern": "^[A-Za-z0-9_\\-=!.]{1,512}$", "title": "Mail Folder Id", "type": "string" }, "since": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO date (YYYY-MM-DD)", "title": "Since" }, "before": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO date (YYYY-MM-DD)", "title": "Before" }, "from_address": { "anyOf": [ { "pattern": "^[^\\x00-\\x1f\\x7f\\\"\\\\'\\s]{3,320}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "From Address" }, "subject_contains": { "anyOf": [ { "pattern": "^[^\\x00-\\x1f\\x7f\\\"\\\\]{1,200}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Subject Contains" }, "unread_only": { "default": false, "title": "Unread Only", "type": "boolean" }, "cursor": { "anyOf": [ { "pattern": "^(skip:[0-9]{1,9}|skiptoken:[A-Za-z0-9_\\-=%.!*'()+/:,]{1,1500})$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 20, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsMicrosoft365MessagesSearchRequest", "type": "object" }, "IntegrationsMicrosoft365MessagesSearchResponseMessageSummary": { "additionalProperties": false, "properties": { "message_id": { "title": "Message Id", "type": "string" }, "internet_message_id": { "title": "Internet Message Id", "type": "string" }, "subject": { "title": "Subject", "type": "string" }, "sender": { "title": "Sender", "type": "string" }, "received_at": { "title": "Received At", "type": "string" }, "is_read": { "title": "Is Read", "type": "boolean" }, "has_attachments": { "title": "Has Attachments", "type": "boolean" }, "preview": { "title": "Preview", "type": "string" } }, "required": [ "message_id", "internet_message_id", "subject", "sender", "received_at", "is_read", "has_attachments", "preview" ], "title": "IntegrationsMicrosoft365MessagesSearchResponseMessageSummary", "type": "object" }, "IntegrationsMicrosoft365MessagesSearchResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsMicrosoft365MessagesSearchResponseMessageSummary" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsMicrosoft365MessagesSearchResponse", "type": "object" }, "IntegrationsMongodbCollectionsDescribeRequest": { "additionalProperties": false, "properties": { "collection": { "maxLength": 120, "minLength": 1, "title": "Collection", "type": "string" }, "sample_size": { "default": 20, "maximum": 50, "minimum": 1, "title": "Sample Size", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "collection" ], "title": "IntegrationsMongodbCollectionsDescribeRequest", "type": "object" }, "IntegrationsMongodbCollectionsDescribeResponseFieldItem": { "additionalProperties": false, "properties": { "path": { "title": "Path", "type": "string" }, "types": { "items": { "type": "string" }, "title": "Types", "type": "array" }, "present_in": { "title": "Present In", "type": "integer" } }, "required": [ "path", "types", "present_in" ], "title": "IntegrationsMongodbCollectionsDescribeResponseFieldItem", "type": "object" }, "IntegrationsMongodbCollectionsDescribeResponseIndexItem": { "additionalProperties": false, "properties": { "name": { "title": "Name", "type": "string" }, "keys": { "additionalProperties": true, "title": "Keys", "type": "object" }, "unique": { "title": "Unique", "type": "boolean" } }, "required": [ "name", "keys", "unique" ], "title": "IntegrationsMongodbCollectionsDescribeResponseIndexItem", "type": "object" }, "IntegrationsMongodbCollectionsDescribeResponse": { "additionalProperties": false, "properties": { "collection": { "title": "Collection", "type": "string" }, "estimated_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Estimated Count" }, "sampled": { "title": "Sampled", "type": "integer" }, "fields": { "items": { "$ref": "#/components/schemas/IntegrationsMongodbCollectionsDescribeResponseFieldItem" }, "title": "Fields", "type": "array" }, "indexes": { "items": { "$ref": "#/components/schemas/IntegrationsMongodbCollectionsDescribeResponseIndexItem" }, "title": "Indexes", "type": "array" } }, "required": [ "collection", "estimated_count", "sampled", "fields", "indexes" ], "title": "IntegrationsMongodbCollectionsDescribeResponse", "type": "object" }, "IntegrationsMongodbCollectionsListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 200, "maximum": 1000, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsMongodbCollectionsListRequest", "type": "object" }, "IntegrationsMongodbCollectionsListResponseCollectionItem": { "additionalProperties": false, "properties": { "name": { "title": "Name", "type": "string" }, "type": { "title": "Type", "type": "string" }, "estimated_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Estimated Count" } }, "required": [ "name", "type", "estimated_count" ], "title": "IntegrationsMongodbCollectionsListResponseCollectionItem", "type": "object" }, "IntegrationsMongodbCollectionsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsMongodbCollectionsListResponseCollectionItem" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "IntegrationsMongodbCollectionsListResponse", "type": "object" }, "IntegrationsMongodbDocumentsAggregateRequest": { "additionalProperties": false, "properties": { "collection": { "maxLength": 120, "minLength": 1, "title": "Collection", "type": "string" }, "pipeline": { "items": { "additionalProperties": true, "type": "object" }, "maxItems": 20, "minItems": 1, "title": "Pipeline", "type": "array" }, "lookup_collections": { "default": [], "items": { "type": "string" }, "maxItems": 10, "title": "Lookup Collections", "type": "array" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "collection", "pipeline" ], "title": "IntegrationsMongodbDocumentsAggregateRequest", "type": "object" }, "IntegrationsMongodbDocumentsAggregateResponse": { "additionalProperties": false, "properties": { "documents": { "items": { "additionalProperties": true, "type": "object" }, "title": "Documents", "type": "array" }, "document_count": { "title": "Document Count", "type": "integer" }, "has_more": { "title": "Has More", "type": "boolean" }, "truncated": { "title": "Truncated", "type": "boolean" } }, "required": [ "documents", "document_count", "has_more", "truncated" ], "title": "IntegrationsMongodbDocumentsAggregateResponse", "type": "object" }, "IntegrationsMongodbDocumentsFindRequest": { "additionalProperties": false, "properties": { "collection": { "maxLength": 120, "minLength": 1, "title": "Collection", "type": "string" }, "filter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Filter" }, "projection": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Projection" }, "sort": { "anyOf": [ { "items": { "items": {}, "type": "array" }, "maxItems": 16, "type": "array" }, { "type": "null" } ], "default": null, "title": "Sort" }, "limit": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "collection" ], "title": "IntegrationsMongodbDocumentsFindRequest", "type": "object" }, "IntegrationsMongodbDocumentsFindResponse": { "additionalProperties": false, "properties": { "documents": { "items": { "additionalProperties": true, "type": "object" }, "title": "Documents", "type": "array" }, "document_count": { "title": "Document Count", "type": "integer" }, "has_more": { "title": "Has More", "type": "boolean" }, "truncated": { "title": "Truncated", "type": "boolean" } }, "required": [ "documents", "document_count", "has_more", "truncated" ], "title": "IntegrationsMongodbDocumentsFindResponse", "type": "object" }, "IntegrationsNotionBlocksAppendRequestBlockSpec": { "additionalProperties": false, "properties": { "type": { "enum": [ "paragraph", "heading_1", "heading_2", "heading_3", "bulleted_list_item", "numbered_list_item", "to_do", "quote", "callout", "code", "toggle", "divider" ], "title": "Type", "type": "string" }, "text": { "default": "", "maxLength": 2000, "title": "Text", "type": "string" }, "checked": { "default": false, "title": "Checked", "type": "boolean" }, "language": { "anyOf": [ { "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Language" }, "link": { "anyOf": [ { "maxLength": 2000, "type": "string" }, { "type": "null" } ], "default": null, "title": "Link" } }, "required": [ "type" ], "title": "IntegrationsNotionBlocksAppendRequestBlockSpec", "type": "object" }, "IntegrationsNotionBlocksAppendRequest": { "additionalProperties": false, "properties": { "block_id": { "maxLength": 36, "minLength": 32, "title": "Block Id", "type": "string" }, "blocks": { "items": { "$ref": "#/components/schemas/IntegrationsNotionBlocksAppendRequestBlockSpec" }, "maxItems": 50, "minItems": 1, "title": "Blocks", "type": "array" }, "position": { "default": "end", "enum": [ "end", "start" ], "title": "Position", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "block_id", "blocks" ], "title": "IntegrationsNotionBlocksAppendRequest", "type": "object" }, "IntegrationsNotionBlocksAppendResponse": { "type": "object", "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "job_id": { "type": "string" }, "safe_error_code": { "type": "string" } }, "required": [ "invocation_id", "status", "job_id" ], "additionalProperties": false, "title": "IntegrationsNotionBlocksAppendResponse" }, "IntegrationsNotionBlocksListRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9_-]{1,256}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 100, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "block_id": { "maxLength": 36, "minLength": 32, "title": "Block Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "block_id" ], "title": "IntegrationsNotionBlocksListRequest", "type": "object" }, "IntegrationsNotionBlocksListResponseBlockItem": { "additionalProperties": false, "properties": { "block_id": { "title": "Block Id", "type": "string" }, "type": { "title": "Type", "type": "string" }, "text": { "maxLength": 8000, "title": "Text", "type": "string" }, "text_truncated": { "title": "Text Truncated", "type": "boolean" }, "has_children": { "title": "Has Children", "type": "boolean" }, "checked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Checked" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" }, "child_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Child Id" }, "created_time": { "title": "Created Time", "type": "string" }, "last_edited_time": { "title": "Last Edited Time", "type": "string" } }, "required": [ "block_id", "type", "text", "text_truncated", "has_children", "checked", "language", "url", "child_id", "created_time", "last_edited_time" ], "title": "IntegrationsNotionBlocksListResponseBlockItem", "type": "object" }, "IntegrationsNotionBlocksListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsNotionBlocksListResponseBlockItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsNotionBlocksListResponse", "type": "object" }, "IntegrationsNotionDataSourcesGetRequest": { "additionalProperties": false, "properties": { "data_source_id": { "maxLength": 36, "minLength": 32, "title": "Data Source Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "data_source_id" ], "title": "IntegrationsNotionDataSourcesGetRequest", "type": "object" }, "IntegrationsNotionDataSourcesGetResponsePropertySchemaItem": { "additionalProperties": false, "properties": { "name": { "title": "Name", "type": "string" }, "property_id": { "title": "Property Id", "type": "string" }, "type": { "title": "Type", "type": "string" }, "options": { "items": { "type": "string" }, "maxItems": 100, "title": "Options", "type": "array" } }, "required": [ "name", "property_id", "type", "options" ], "title": "IntegrationsNotionDataSourcesGetResponsePropertySchemaItem", "type": "object" }, "IntegrationsNotionDataSourcesGetResponse": { "additionalProperties": false, "properties": { "data_source_id": { "title": "Data Source Id", "type": "string" }, "title": { "title": "Title", "type": "string" }, "description": { "title": "Description", "type": "string" }, "database_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Database Id" }, "url": { "title": "Url", "type": "string" }, "is_inline": { "title": "Is Inline", "type": "boolean" }, "in_trash": { "title": "In Trash", "type": "boolean" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationsNotionDataSourcesGetResponsePropertySchemaItem" }, "title": "Properties" } }, "required": [ "data_source_id", "title", "description", "database_id", "url", "is_inline", "in_trash", "properties" ], "title": "IntegrationsNotionDataSourcesGetResponse", "type": "object" }, "IntegrationsNotionDataSourcesQueryRequestSortSpec": { "additionalProperties": false, "properties": { "direction": { "enum": [ "ascending", "descending" ], "title": "Direction", "type": "string" }, "property": { "anyOf": [ { "maxLength": 200, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Property" }, "timestamp": { "anyOf": [ { "enum": [ "created_time", "last_edited_time" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Timestamp" } }, "required": [ "direction" ], "title": "IntegrationsNotionDataSourcesQueryRequestSortSpec", "type": "object" }, "IntegrationsNotionDataSourcesQueryRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9_-]{1,256}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 25, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "data_source_id": { "maxLength": 36, "minLength": 32, "title": "Data Source Id", "type": "string" }, "filter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Filter" }, "sorts": { "items": { "$ref": "#/components/schemas/IntegrationsNotionDataSourcesQueryRequestSortSpec" }, "maxItems": 5, "title": "Sorts", "type": "array" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "data_source_id" ], "title": "IntegrationsNotionDataSourcesQueryRequest", "type": "object" }, "IntegrationsNotionDataSourcesQueryResponsePageItem": { "additionalProperties": false, "properties": { "page_id": { "title": "Page Id", "type": "string" }, "title": { "title": "Title", "type": "string" }, "url": { "title": "Url", "type": "string" }, "public_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Public Url" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon" }, "parent": { "$ref": "#/components/schemas/IntegrationsNotionDataSourcesQueryResponseParentRef" }, "created_time": { "title": "Created Time", "type": "string" }, "last_edited_time": { "title": "Last Edited Time", "type": "string" }, "in_trash": { "title": "In Trash", "type": "boolean" }, "is_locked": { "title": "Is Locked", "type": "boolean" }, "properties": { "type": "object", "additionalProperties": true, "title": "Properties" } }, "required": [ "page_id", "title", "url", "public_url", "icon", "parent", "created_time", "last_edited_time", "in_trash", "is_locked", "properties" ], "title": "IntegrationsNotionDataSourcesQueryResponsePageItem", "type": "object" }, "IntegrationsNotionDataSourcesQueryResponseParentRef": { "additionalProperties": false, "properties": { "type": { "title": "Type", "type": "string" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "required": [ "type", "id" ], "title": "IntegrationsNotionDataSourcesQueryResponseParentRef", "type": "object" }, "IntegrationsNotionDataSourcesQueryResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsNotionDataSourcesQueryResponsePageItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "incomplete": { "title": "Incomplete", "type": "boolean" } }, "required": [ "items", "next_cursor", "incomplete" ], "title": "IntegrationsNotionDataSourcesQueryResponse", "type": "object" }, "IntegrationsNotionPagesGetRequest": { "additionalProperties": false, "properties": { "page_id": { "maxLength": 36, "minLength": 32, "title": "Page Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "page_id" ], "title": "IntegrationsNotionPagesGetRequest", "type": "object" }, "IntegrationsNotionPagesGetResponseParentRef": { "additionalProperties": false, "properties": { "type": { "title": "Type", "type": "string" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "required": [ "type", "id" ], "title": "IntegrationsNotionPagesGetResponseParentRef", "type": "object" }, "IntegrationsNotionPagesGetResponse": { "additionalProperties": false, "properties": { "page_id": { "title": "Page Id", "type": "string" }, "title": { "title": "Title", "type": "string" }, "url": { "title": "Url", "type": "string" }, "public_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Public Url" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon" }, "parent": { "$ref": "#/components/schemas/IntegrationsNotionPagesGetResponseParentRef" }, "created_time": { "title": "Created Time", "type": "string" }, "last_edited_time": { "title": "Last Edited Time", "type": "string" }, "in_trash": { "title": "In Trash", "type": "boolean" }, "is_locked": { "title": "Is Locked", "type": "boolean" }, "properties": { "type": "object", "additionalProperties": true, "title": "Properties" } }, "required": [ "page_id", "title", "url", "public_url", "icon", "parent", "created_time", "last_edited_time", "in_trash", "is_locked", "properties" ], "title": "IntegrationsNotionPagesGetResponse", "type": "object" }, "IntegrationsNotionSearchQueryRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9_-]{1,256}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 25, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "query": { "default": "", "maxLength": 500, "title": "Query", "type": "string" }, "object": { "anyOf": [ { "enum": [ "page", "data_source" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Object" }, "sort": { "anyOf": [ { "enum": [ "ascending", "descending" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Sort" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsNotionSearchQueryRequest", "type": "object" }, "IntegrationsNotionSearchQueryResponseParentRef": { "additionalProperties": false, "properties": { "type": { "title": "Type", "type": "string" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "required": [ "type", "id" ], "title": "IntegrationsNotionSearchQueryResponseParentRef", "type": "object" }, "IntegrationsNotionSearchQueryResponseSearchItem": { "additionalProperties": false, "properties": { "object": { "enum": [ "page", "data_source" ], "title": "Object", "type": "string" }, "id": { "title": "Id", "type": "string" }, "title": { "title": "Title", "type": "string" }, "url": { "title": "Url", "type": "string" }, "parent": { "$ref": "#/components/schemas/IntegrationsNotionSearchQueryResponseParentRef" }, "last_edited_time": { "title": "Last Edited Time", "type": "string" }, "in_trash": { "title": "In Trash", "type": "boolean" } }, "required": [ "object", "id", "title", "url", "parent", "last_edited_time", "in_trash" ], "title": "IntegrationsNotionSearchQueryResponseSearchItem", "type": "object" }, "IntegrationsNotionSearchQueryResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsNotionSearchQueryResponseSearchItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "incomplete": { "title": "Incomplete", "type": "boolean" } }, "required": [ "items", "next_cursor", "incomplete" ], "title": "IntegrationsNotionSearchQueryResponse", "type": "object" }, "IntegrationsPostgresRowsQueryRequestOrderItem": { "additionalProperties": false, "properties": { "column": { "maxLength": 63, "minLength": 1, "title": "Column", "type": "string" }, "direction": { "default": "asc", "enum": [ "asc", "desc" ], "title": "Direction", "type": "string" } }, "required": [ "column" ], "title": "IntegrationsPostgresRowsQueryRequestOrderItem", "type": "object" }, "IntegrationsPostgresRowsQueryRequestRowFilter": { "additionalProperties": false, "properties": { "column": { "maxLength": 63, "minLength": 1, "title": "Column", "type": "string" }, "op": { "enum": [ "eq", "ne", "lt", "lte", "gt", "gte", "in", "like", "ilike", "is_null", "not_null" ], "title": "Op", "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Value" } }, "required": [ "column", "op" ], "title": "IntegrationsPostgresRowsQueryRequestRowFilter", "type": "object" }, "IntegrationsPostgresRowsQueryRequest": { "additionalProperties": false, "properties": { "table": { "maxLength": 127, "minLength": 3, "title": "Table", "type": "string" }, "columns": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 100, "type": "array" }, { "type": "null" } ], "default": null, "title": "Columns" }, "filters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IntegrationsPostgresRowsQueryRequestRowFilter" }, "maxItems": 20, "type": "array" }, { "type": "null" } ], "default": null, "title": "Filters" }, "order_by": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IntegrationsPostgresRowsQueryRequestOrderItem" }, "maxItems": 5, "type": "array" }, { "type": "null" } ], "default": null, "title": "Order By" }, "limit": { "default": 100, "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "maximum": 100000, "minimum": 0, "title": "Offset", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "table" ], "title": "IntegrationsPostgresRowsQueryRequest", "type": "object" }, "IntegrationsPostgresRowsQueryResponseColumnRef": { "additionalProperties": false, "properties": { "name": { "title": "Name", "type": "string" }, "type": { "title": "Type", "type": "string" } }, "required": [ "name", "type" ], "title": "IntegrationsPostgresRowsQueryResponseColumnRef", "type": "object" }, "IntegrationsPostgresRowsQueryResponse": { "additionalProperties": false, "properties": { "columns": { "items": { "$ref": "#/components/schemas/IntegrationsPostgresRowsQueryResponseColumnRef" }, "title": "Columns", "type": "array" }, "rows": { "items": { "additionalProperties": true, "type": "object" }, "title": "Rows", "type": "array" }, "row_count": { "title": "Row Count", "type": "integer" }, "has_more": { "title": "Has More", "type": "boolean" }, "truncated": { "title": "Truncated", "type": "boolean" } }, "required": [ "columns", "rows", "row_count", "has_more", "truncated" ], "title": "IntegrationsPostgresRowsQueryResponse", "type": "object" }, "IntegrationsPostgresSchemasListRequest": { "additionalProperties": false, "properties": { "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsPostgresSchemasListRequest", "type": "object" }, "IntegrationsPostgresSchemasListResponseSchemaItem": { "additionalProperties": false, "properties": { "name": { "title": "Name", "type": "string" } }, "required": [ "name" ], "title": "IntegrationsPostgresSchemasListResponseSchemaItem", "type": "object" }, "IntegrationsPostgresSchemasListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsPostgresSchemasListResponseSchemaItem" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "IntegrationsPostgresSchemasListResponse", "type": "object" }, "IntegrationsPostgresSqlSelectRequest": { "additionalProperties": false, "properties": { "sql": { "maxLength": 8000, "minLength": 1, "title": "Sql", "type": "string" }, "tables": { "items": { "type": "string" }, "maxItems": 20, "minItems": 1, "title": "Tables", "type": "array" }, "limit": { "default": 100, "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "sql", "tables" ], "title": "IntegrationsPostgresSqlSelectRequest", "type": "object" }, "IntegrationsPostgresSqlSelectResponseColumnRef": { "additionalProperties": false, "properties": { "name": { "title": "Name", "type": "string" }, "type": { "title": "Type", "type": "string" } }, "required": [ "name", "type" ], "title": "IntegrationsPostgresSqlSelectResponseColumnRef", "type": "object" }, "IntegrationsPostgresSqlSelectResponse": { "additionalProperties": false, "properties": { "columns": { "items": { "$ref": "#/components/schemas/IntegrationsPostgresSqlSelectResponseColumnRef" }, "title": "Columns", "type": "array" }, "rows": { "items": { "additionalProperties": true, "type": "object" }, "title": "Rows", "type": "array" }, "row_count": { "title": "Row Count", "type": "integer" }, "has_more": { "title": "Has More", "type": "boolean" }, "truncated": { "title": "Truncated", "type": "boolean" } }, "required": [ "columns", "rows", "row_count", "has_more", "truncated" ], "title": "IntegrationsPostgresSqlSelectResponse", "type": "object" }, "IntegrationsPostgresTablesDescribeRequest": { "additionalProperties": false, "properties": { "table": { "maxLength": 127, "minLength": 3, "title": "Table", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "table" ], "title": "IntegrationsPostgresTablesDescribeRequest", "type": "object" }, "IntegrationsPostgresTablesDescribeResponseColumnItem": { "additionalProperties": false, "properties": { "name": { "title": "Name", "type": "string" }, "type": { "title": "Type", "type": "string" }, "nullable": { "title": "Nullable", "type": "boolean" }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default" }, "primary_key": { "title": "Primary Key", "type": "boolean" } }, "required": [ "name", "type", "nullable", "default", "primary_key" ], "title": "IntegrationsPostgresTablesDescribeResponseColumnItem", "type": "object" }, "IntegrationsPostgresTablesDescribeResponseForeignKeyItem": { "additionalProperties": false, "properties": { "name": { "title": "Name", "type": "string" }, "columns": { "items": { "type": "string" }, "title": "Columns", "type": "array" }, "references_table": { "title": "References Table", "type": "string" }, "references_columns": { "items": { "type": "string" }, "title": "References Columns", "type": "array" } }, "required": [ "name", "columns", "references_table", "references_columns" ], "title": "IntegrationsPostgresTablesDescribeResponseForeignKeyItem", "type": "object" }, "IntegrationsPostgresTablesDescribeResponse": { "additionalProperties": false, "properties": { "table": { "title": "Table", "type": "string" }, "kind": { "title": "Kind", "type": "string" }, "estimated_rows": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Estimated Rows" }, "columns": { "items": { "$ref": "#/components/schemas/IntegrationsPostgresTablesDescribeResponseColumnItem" }, "title": "Columns", "type": "array" }, "primary_key": { "items": { "type": "string" }, "title": "Primary Key", "type": "array" }, "foreign_keys": { "items": { "$ref": "#/components/schemas/IntegrationsPostgresTablesDescribeResponseForeignKeyItem" }, "title": "Foreign Keys", "type": "array" } }, "required": [ "table", "kind", "estimated_rows", "columns", "primary_key", "foreign_keys" ], "title": "IntegrationsPostgresTablesDescribeResponse", "type": "object" }, "IntegrationsPostgresTablesListRequest": { "additionalProperties": false, "properties": { "schema_name": { "anyOf": [ { "maxLength": 63, "type": "string" }, { "type": "null" } ], "default": null, "title": "Schema Name" }, "cursor": { "anyOf": [ { "maxLength": 9, "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 100, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsPostgresTablesListRequest", "type": "object" }, "IntegrationsPostgresTablesListResponseTableItem": { "additionalProperties": false, "properties": { "schema_name": { "title": "Schema Name", "type": "string" }, "name": { "title": "Name", "type": "string" }, "table": { "title": "Table", "type": "string" }, "kind": { "title": "Kind", "type": "string" }, "estimated_rows": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Estimated Rows" } }, "required": [ "schema_name", "name", "table", "kind", "estimated_rows" ], "title": "IntegrationsPostgresTablesListResponseTableItem", "type": "object" }, "IntegrationsPostgresTablesListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsPostgresTablesListResponseTableItem" }, "title": "Items", "type": "array" }, "has_more": { "title": "Has More", "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "has_more", "next_cursor" ], "title": "IntegrationsPostgresTablesListResponse", "type": "object" }, "IntegrationsShopifyAbandonedCheckoutsListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Query" }, "reverse": { "default": true, "title": "Reverse", "type": "boolean" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsShopifyAbandonedCheckoutsListRequest", "type": "object" }, "IntegrationsShopifyAbandonedCheckoutsListResponseAbandonedCheckoutItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "created_at": { "title": "Created At", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" }, "completed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "abandoned_checkout_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Abandoned Checkout Url" }, "currency_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency Code" }, "subtotal": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyAbandonedCheckoutsListResponseMoney" }, { "type": "null" } ] }, "total_price": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyAbandonedCheckoutsListResponseMoney" }, { "type": "null" } ] }, "customer": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyAbandonedCheckoutsListResponseCustomerReference" }, { "type": "null" } ] }, "line_items_quantity": { "title": "Line Items Quantity", "type": "integer" } }, "required": [ "id", "name", "created_at", "updated_at", "completed_at", "abandoned_checkout_url", "currency_code", "subtotal", "total_price", "customer", "line_items_quantity" ], "title": "IntegrationsShopifyAbandonedCheckoutsListResponseAbandonedCheckoutItem", "type": "object" }, "IntegrationsShopifyAbandonedCheckoutsListResponseCustomerReference": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" } }, "required": [ "id", "display_name", "email" ], "title": "IntegrationsShopifyAbandonedCheckoutsListResponseCustomerReference", "type": "object" }, "IntegrationsShopifyAbandonedCheckoutsListResponseMoney": { "additionalProperties": false, "properties": { "amount": { "title": "Amount", "type": "string" }, "currency_code": { "title": "Currency Code", "type": "string" } }, "required": [ "amount", "currency_code" ], "title": "IntegrationsShopifyAbandonedCheckoutsListResponseMoney", "type": "object" }, "IntegrationsShopifyAbandonedCheckoutsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyAbandonedCheckoutsListResponseAbandonedCheckoutItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsShopifyAbandonedCheckoutsListResponse", "type": "object" }, "IntegrationsShopifyCollectionProductsListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "collection_id": { "maxLength": 80, "minLength": 1, "title": "Collection Id", "type": "string" }, "sort_key": { "default": "collection_default", "enum": [ "collection_default", "title", "created", "best_selling", "price", "id" ], "title": "Sort Key", "type": "string" }, "reverse": { "default": false, "title": "Reverse", "type": "boolean" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "collection_id" ], "title": "IntegrationsShopifyCollectionProductsListRequest", "type": "object" }, "IntegrationsShopifyCollectionProductsListResponseMoney": { "additionalProperties": false, "properties": { "amount": { "title": "Amount", "type": "string" }, "currency_code": { "title": "Currency Code", "type": "string" } }, "required": [ "amount", "currency_code" ], "title": "IntegrationsShopifyCollectionProductsListResponseMoney", "type": "object" }, "IntegrationsShopifyCollectionProductsListResponseProductSummary": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "handle": { "title": "Handle", "type": "string" }, "title": { "title": "Title", "type": "string" }, "status": { "title": "Status", "type": "string" }, "vendor": { "title": "Vendor", "type": "string" }, "product_type": { "title": "Product Type", "type": "string" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "total_inventory": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Inventory" }, "tracks_inventory": { "title": "Tracks Inventory", "type": "boolean" }, "price_min": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyCollectionProductsListResponseMoney" }, { "type": "null" } ] }, "price_max": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyCollectionProductsListResponseMoney" }, { "type": "null" } ] }, "variants_count": { "title": "Variants Count", "type": "integer" }, "has_only_default_variant": { "title": "Has Only Default Variant", "type": "boolean" }, "online_store_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Online Store Url" }, "featured_image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Featured Image Url" }, "created_at": { "title": "Created At", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" }, "published_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Published At" } }, "required": [ "id", "handle", "title", "status", "vendor", "product_type", "tags", "total_inventory", "tracks_inventory", "price_min", "price_max", "variants_count", "has_only_default_variant", "online_store_url", "featured_image_url", "created_at", "updated_at", "published_at" ], "title": "IntegrationsShopifyCollectionProductsListResponseProductSummary", "type": "object" }, "IntegrationsShopifyCollectionProductsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyCollectionProductsListResponseProductSummary" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsShopifyCollectionProductsListResponse", "type": "object" }, "IntegrationsShopifyCollectionsGetRequest": { "additionalProperties": false, "properties": { "collection_id": { "anyOf": [ { "maxLength": 80, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Collection Id" }, "handle": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9._-]{0,254}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Handle" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsShopifyCollectionsGetRequest", "type": "object" }, "IntegrationsShopifyCollectionsGetResponseCollectionRule": { "additionalProperties": false, "properties": { "column": { "title": "Column", "type": "string" }, "relation": { "title": "Relation", "type": "string" }, "condition": { "title": "Condition", "type": "string" } }, "required": [ "column", "relation", "condition" ], "title": "IntegrationsShopifyCollectionsGetResponseCollectionRule", "type": "object" }, "IntegrationsShopifyCollectionsGetResponseCollectionRuleSet": { "additionalProperties": false, "properties": { "applied_disjunctively": { "title": "Applied Disjunctively", "type": "boolean" }, "rules": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyCollectionsGetResponseCollectionRule" }, "title": "Rules", "type": "array" } }, "required": [ "applied_disjunctively", "rules" ], "title": "IntegrationsShopifyCollectionsGetResponseCollectionRuleSet", "type": "object" }, "IntegrationsShopifyCollectionsGetResponse": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "handle": { "title": "Handle", "type": "string" }, "title": { "title": "Title", "type": "string" }, "description": { "title": "Description", "type": "string" }, "products_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Products Count" }, "sort_order": { "title": "Sort Order", "type": "string" }, "is_smart": { "title": "Is Smart", "type": "boolean" }, "rule_set": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyCollectionsGetResponseCollectionRuleSet" }, { "type": "null" } ] }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Url" }, "updated_at": { "title": "Updated At", "type": "string" } }, "required": [ "id", "handle", "title", "description", "products_count", "sort_order", "is_smart", "rule_set", "image_url", "updated_at" ], "title": "IntegrationsShopifyCollectionsGetResponse", "type": "object" }, "IntegrationsShopifyCollectionsListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Query" }, "reverse": { "default": false, "title": "Reverse", "type": "boolean" }, "sort_key": { "default": "title", "enum": [ "title", "updated_at", "id", "relevance" ], "title": "Sort Key", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsShopifyCollectionsListRequest", "type": "object" }, "IntegrationsShopifyCollectionsListResponseCollectionItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "handle": { "title": "Handle", "type": "string" }, "title": { "title": "Title", "type": "string" }, "description": { "title": "Description", "type": "string" }, "products_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Products Count" }, "sort_order": { "title": "Sort Order", "type": "string" }, "is_smart": { "title": "Is Smart", "type": "boolean" }, "rule_set": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyCollectionsListResponseCollectionRuleSet" }, { "type": "null" } ] }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Url" }, "updated_at": { "title": "Updated At", "type": "string" } }, "required": [ "id", "handle", "title", "description", "products_count", "sort_order", "is_smart", "rule_set", "image_url", "updated_at" ], "title": "IntegrationsShopifyCollectionsListResponseCollectionItem", "type": "object" }, "IntegrationsShopifyCollectionsListResponseCollectionRule": { "additionalProperties": false, "properties": { "column": { "title": "Column", "type": "string" }, "relation": { "title": "Relation", "type": "string" }, "condition": { "title": "Condition", "type": "string" } }, "required": [ "column", "relation", "condition" ], "title": "IntegrationsShopifyCollectionsListResponseCollectionRule", "type": "object" }, "IntegrationsShopifyCollectionsListResponseCollectionRuleSet": { "additionalProperties": false, "properties": { "applied_disjunctively": { "title": "Applied Disjunctively", "type": "boolean" }, "rules": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyCollectionsListResponseCollectionRule" }, "title": "Rules", "type": "array" } }, "required": [ "applied_disjunctively", "rules" ], "title": "IntegrationsShopifyCollectionsListResponseCollectionRuleSet", "type": "object" }, "IntegrationsShopifyCollectionsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyCollectionsListResponseCollectionItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsShopifyCollectionsListResponse", "type": "object" }, "IntegrationsShopifyCustomersGetRequest": { "additionalProperties": false, "properties": { "customer_id": { "maxLength": 80, "minLength": 1, "title": "Customer Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "customer_id" ], "title": "IntegrationsShopifyCustomersGetRequest", "type": "object" }, "IntegrationsShopifyCustomersGetResponseAddress": { "additionalProperties": false, "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "company": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company" }, "address1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address1" }, "address2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address2" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "province_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Province Code" }, "country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country Code" }, "zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zip" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone" } }, "required": [ "name", "company", "address1", "address2", "city", "province_code", "country_code", "zip", "phone" ], "title": "IntegrationsShopifyCustomersGetResponseAddress", "type": "object" }, "IntegrationsShopifyCustomersGetResponseMetafieldItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "namespace": { "title": "Namespace", "type": "string" }, "key": { "title": "Key", "type": "string" }, "type": { "title": "Type", "type": "string" }, "value": { "title": "Value", "type": "string" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "id", "namespace", "key", "type", "value", "updated_at" ], "title": "IntegrationsShopifyCustomersGetResponseMetafieldItem", "type": "object" }, "IntegrationsShopifyCustomersGetResponseMoney": { "additionalProperties": false, "properties": { "amount": { "title": "Amount", "type": "string" }, "currency_code": { "title": "Currency Code", "type": "string" } }, "required": [ "amount", "currency_code" ], "title": "IntegrationsShopifyCustomersGetResponseMoney", "type": "object" }, "IntegrationsShopifyCustomersGetResponseReference": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "required": [ "id", "name" ], "title": "IntegrationsShopifyCustomersGetResponseReference", "type": "object" }, "IntegrationsShopifyCustomersGetResponse": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Name" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Name" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone" }, "state": { "title": "State", "type": "string" }, "verified_email": { "title": "Verified Email", "type": "boolean" }, "number_of_orders": { "title": "Number Of Orders", "type": "integer" }, "amount_spent": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyCustomersGetResponseMoney" }, { "type": "null" } ] }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale" }, "email_marketing_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Marketing State" }, "default_address": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyCustomersGetResponseAddress" }, { "type": "null" } ] }, "last_order": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyCustomersGetResponseReference" }, { "type": "null" } ] }, "created_at": { "title": "Created At", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" }, "addresses": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyCustomersGetResponseAddress" }, "title": "Addresses", "type": "array" }, "metafields": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyCustomersGetResponseMetafieldItem" }, "title": "Metafields", "type": "array" } }, "required": [ "id", "display_name", "first_name", "last_name", "email", "phone", "state", "verified_email", "number_of_orders", "amount_spent", "tags", "locale", "email_marketing_state", "default_address", "last_order", "created_at", "updated_at", "note", "addresses", "metafields" ], "title": "IntegrationsShopifyCustomersGetResponse", "type": "object" }, "IntegrationsShopifyCustomersListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Query" }, "reverse": { "default": true, "title": "Reverse", "type": "boolean" }, "sort_key": { "default": "updated_at", "enum": [ "name", "location", "orders_count", "last_order_date", "total_spent", "updated_at", "id", "relevance" ], "title": "Sort Key", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsShopifyCustomersListRequest", "type": "object" }, "IntegrationsShopifyCustomersListResponseAddress": { "additionalProperties": false, "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "company": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company" }, "address1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address1" }, "address2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address2" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "province_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Province Code" }, "country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country Code" }, "zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zip" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone" } }, "required": [ "name", "company", "address1", "address2", "city", "province_code", "country_code", "zip", "phone" ], "title": "IntegrationsShopifyCustomersListResponseAddress", "type": "object" }, "IntegrationsShopifyCustomersListResponseCustomerSummary": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Name" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Name" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone" }, "state": { "title": "State", "type": "string" }, "verified_email": { "title": "Verified Email", "type": "boolean" }, "number_of_orders": { "title": "Number Of Orders", "type": "integer" }, "amount_spent": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyCustomersListResponseMoney" }, { "type": "null" } ] }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale" }, "email_marketing_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Marketing State" }, "default_address": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyCustomersListResponseAddress" }, { "type": "null" } ] }, "last_order": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyCustomersListResponseReference" }, { "type": "null" } ] }, "created_at": { "title": "Created At", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" } }, "required": [ "id", "display_name", "first_name", "last_name", "email", "phone", "state", "verified_email", "number_of_orders", "amount_spent", "tags", "locale", "email_marketing_state", "default_address", "last_order", "created_at", "updated_at" ], "title": "IntegrationsShopifyCustomersListResponseCustomerSummary", "type": "object" }, "IntegrationsShopifyCustomersListResponseMoney": { "additionalProperties": false, "properties": { "amount": { "title": "Amount", "type": "string" }, "currency_code": { "title": "Currency Code", "type": "string" } }, "required": [ "amount", "currency_code" ], "title": "IntegrationsShopifyCustomersListResponseMoney", "type": "object" }, "IntegrationsShopifyCustomersListResponseReference": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "required": [ "id", "name" ], "title": "IntegrationsShopifyCustomersListResponseReference", "type": "object" }, "IntegrationsShopifyCustomersListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyCustomersListResponseCustomerSummary" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsShopifyCustomersListResponse", "type": "object" }, "IntegrationsShopifyDiscountsGetRequest": { "additionalProperties": false, "properties": { "discount_id": { "maxLength": 80, "minLength": 1, "title": "Discount Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "discount_id" ], "title": "IntegrationsShopifyDiscountsGetRequest", "type": "object" }, "IntegrationsShopifyDiscountsGetResponseCombinesWith": { "additionalProperties": false, "properties": { "order_discounts": { "title": "Order Discounts", "type": "boolean" }, "product_discounts": { "title": "Product Discounts", "type": "boolean" }, "shipping_discounts": { "title": "Shipping Discounts", "type": "boolean" } }, "required": [ "order_discounts", "product_discounts", "shipping_discounts" ], "title": "IntegrationsShopifyDiscountsGetResponseCombinesWith", "type": "object" }, "IntegrationsShopifyDiscountsGetResponse": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "method": { "enum": [ "code", "automatic" ], "title": "Method", "type": "string" }, "kind": { "title": "Kind", "type": "string" }, "title": { "title": "Title", "type": "string" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "status": { "title": "Status", "type": "string" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary" }, "discount_classes": { "items": { "type": "string" }, "title": "Discount Classes", "type": "array" }, "starts_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Starts At" }, "ends_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ends At" }, "usage_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Usage Count" }, "usage_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Usage Limit" }, "applies_once_per_customer": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Applies Once Per Customer" }, "combines_with": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyDiscountsGetResponseCombinesWith" }, { "type": "null" } ] }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "id", "method", "kind", "title", "code", "status", "summary", "discount_classes", "starts_at", "ends_at", "usage_count", "usage_limit", "applies_once_per_customer", "combines_with", "created_at", "updated_at" ], "title": "IntegrationsShopifyDiscountsGetResponse", "type": "object" }, "IntegrationsShopifyDiscountsListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Query" }, "reverse": { "default": true, "title": "Reverse", "type": "boolean" }, "sort_key": { "default": "created_at", "enum": [ "title", "starts_at", "ends_at", "created_at", "updated_at", "id", "relevance" ], "title": "Sort Key", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsShopifyDiscountsListRequest", "type": "object" }, "IntegrationsShopifyDiscountsListResponseCombinesWith": { "additionalProperties": false, "properties": { "order_discounts": { "title": "Order Discounts", "type": "boolean" }, "product_discounts": { "title": "Product Discounts", "type": "boolean" }, "shipping_discounts": { "title": "Shipping Discounts", "type": "boolean" } }, "required": [ "order_discounts", "product_discounts", "shipping_discounts" ], "title": "IntegrationsShopifyDiscountsListResponseCombinesWith", "type": "object" }, "IntegrationsShopifyDiscountsListResponseDiscountItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "method": { "enum": [ "code", "automatic" ], "title": "Method", "type": "string" }, "kind": { "title": "Kind", "type": "string" }, "title": { "title": "Title", "type": "string" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "status": { "title": "Status", "type": "string" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary" }, "discount_classes": { "items": { "type": "string" }, "title": "Discount Classes", "type": "array" }, "starts_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Starts At" }, "ends_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ends At" }, "usage_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Usage Count" }, "usage_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Usage Limit" }, "applies_once_per_customer": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Applies Once Per Customer" }, "combines_with": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyDiscountsListResponseCombinesWith" }, { "type": "null" } ] }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "id", "method", "kind", "title", "code", "status", "summary", "discount_classes", "starts_at", "ends_at", "usage_count", "usage_limit", "applies_once_per_customer", "combines_with", "created_at", "updated_at" ], "title": "IntegrationsShopifyDiscountsListResponseDiscountItem", "type": "object" }, "IntegrationsShopifyDiscountsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyDiscountsListResponseDiscountItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsShopifyDiscountsListResponse", "type": "object" }, "IntegrationsShopifyDraftOrdersGetRequest": { "additionalProperties": false, "properties": { "draft_order_id": { "maxLength": 80, "minLength": 1, "title": "Draft Order Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "draft_order_id" ], "title": "IntegrationsShopifyDraftOrdersGetRequest", "type": "object" }, "IntegrationsShopifyDraftOrdersGetResponseAddress": { "additionalProperties": false, "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "company": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company" }, "address1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address1" }, "address2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address2" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "province_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Province Code" }, "country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country Code" }, "zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zip" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone" } }, "required": [ "name", "company", "address1", "address2", "city", "province_code", "country_code", "zip", "phone" ], "title": "IntegrationsShopifyDraftOrdersGetResponseAddress", "type": "object" }, "IntegrationsShopifyDraftOrdersGetResponseCustomerReference": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" } }, "required": [ "id", "display_name", "email" ], "title": "IntegrationsShopifyDraftOrdersGetResponseCustomerReference", "type": "object" }, "IntegrationsShopifyDraftOrdersGetResponseDraftLineItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "title": { "title": "Title", "type": "string" }, "variant_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Variant Title" }, "sku": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sku" }, "product_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Product Id" }, "variant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Variant Id" }, "quantity": { "title": "Quantity", "type": "integer" }, "original_total": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyDraftOrdersGetResponseMoney" }, { "type": "null" } ] }, "discounted_total": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyDraftOrdersGetResponseMoney" }, { "type": "null" } ] }, "custom": { "title": "Custom", "type": "boolean" } }, "required": [ "id", "title", "variant_title", "sku", "product_id", "variant_id", "quantity", "original_total", "discounted_total", "custom" ], "title": "IntegrationsShopifyDraftOrdersGetResponseDraftLineItem", "type": "object" }, "IntegrationsShopifyDraftOrdersGetResponseMoney": { "additionalProperties": false, "properties": { "amount": { "title": "Amount", "type": "string" }, "currency_code": { "title": "Currency Code", "type": "string" } }, "required": [ "amount", "currency_code" ], "title": "IntegrationsShopifyDraftOrdersGetResponseMoney", "type": "object" }, "IntegrationsShopifyDraftOrdersGetResponseShippingLine": { "additionalProperties": false, "properties": { "title": { "title": "Title", "type": "string" }, "price": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyDraftOrdersGetResponseMoney" }, { "type": "null" } ] } }, "required": [ "title", "price" ], "title": "IntegrationsShopifyDraftOrdersGetResponseShippingLine", "type": "object" }, "IntegrationsShopifyDraftOrdersGetResponse": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "status": { "title": "Status", "type": "string" }, "created_at": { "title": "Created At", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" }, "completed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "invoice_sent_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Invoice Sent At" }, "currency_code": { "title": "Currency Code", "type": "string" }, "subtotal": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyDraftOrdersGetResponseMoney" }, { "type": "null" } ] }, "total_price": { "$ref": "#/components/schemas/IntegrationsShopifyDraftOrdersGetResponseMoney" }, "total_tax": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyDraftOrdersGetResponseMoney" }, { "type": "null" } ] }, "customer": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyDraftOrdersGetResponseCustomerReference" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "order_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Id" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" }, "line_items": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyDraftOrdersGetResponseDraftLineItem" }, "title": "Line Items", "type": "array" }, "line_items_truncated": { "title": "Line Items Truncated", "type": "boolean" }, "shipping_address": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyDraftOrdersGetResponseAddress" }, { "type": "null" } ] }, "billing_address": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyDraftOrdersGetResponseAddress" }, { "type": "null" } ] }, "shipping_line": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyDraftOrdersGetResponseShippingLine" }, { "type": "null" } ] }, "discount_codes": { "items": { "type": "string" }, "title": "Discount Codes", "type": "array" } }, "required": [ "id", "name", "status", "created_at", "updated_at", "completed_at", "invoice_sent_at", "currency_code", "subtotal", "total_price", "total_tax", "customer", "email", "tags", "order_id", "note", "line_items", "line_items_truncated", "shipping_address", "billing_address", "shipping_line", "discount_codes" ], "title": "IntegrationsShopifyDraftOrdersGetResponse", "type": "object" }, "IntegrationsShopifyDraftOrdersListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Query" }, "reverse": { "default": true, "title": "Reverse", "type": "boolean" }, "sort_key": { "default": "updated_at", "enum": [ "number", "status", "total_price", "customer_name", "updated_at", "id", "relevance" ], "title": "Sort Key", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsShopifyDraftOrdersListRequest", "type": "object" }, "IntegrationsShopifyDraftOrdersListResponseCustomerReference": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" } }, "required": [ "id", "display_name", "email" ], "title": "IntegrationsShopifyDraftOrdersListResponseCustomerReference", "type": "object" }, "IntegrationsShopifyDraftOrdersListResponseDraftOrderSummary": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "status": { "title": "Status", "type": "string" }, "created_at": { "title": "Created At", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" }, "completed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "invoice_sent_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Invoice Sent At" }, "currency_code": { "title": "Currency Code", "type": "string" }, "subtotal": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyDraftOrdersListResponseMoney" }, { "type": "null" } ] }, "total_price": { "$ref": "#/components/schemas/IntegrationsShopifyDraftOrdersListResponseMoney" }, "total_tax": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyDraftOrdersListResponseMoney" }, { "type": "null" } ] }, "customer": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyDraftOrdersListResponseCustomerReference" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "order_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Id" } }, "required": [ "id", "name", "status", "created_at", "updated_at", "completed_at", "invoice_sent_at", "currency_code", "subtotal", "total_price", "total_tax", "customer", "email", "tags", "order_id" ], "title": "IntegrationsShopifyDraftOrdersListResponseDraftOrderSummary", "type": "object" }, "IntegrationsShopifyDraftOrdersListResponseMoney": { "additionalProperties": false, "properties": { "amount": { "title": "Amount", "type": "string" }, "currency_code": { "title": "Currency Code", "type": "string" } }, "required": [ "amount", "currency_code" ], "title": "IntegrationsShopifyDraftOrdersListResponseMoney", "type": "object" }, "IntegrationsShopifyDraftOrdersListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyDraftOrdersListResponseDraftOrderSummary" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsShopifyDraftOrdersListResponse", "type": "object" }, "IntegrationsShopifyFulfillmentOrdersListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Query" }, "reverse": { "default": true, "title": "Reverse", "type": "boolean" }, "include_closed": { "default": false, "title": "Include Closed", "type": "boolean" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsShopifyFulfillmentOrdersListRequest", "type": "object" }, "IntegrationsShopifyFulfillmentOrdersListResponseFulfillmentOrderItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "order_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Id" }, "order_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Name" }, "status": { "title": "Status", "type": "string" }, "request_status": { "title": "Request Status", "type": "string" }, "assigned_location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assigned Location" }, "assigned_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assigned Location Id" }, "delivery_method_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Delivery Method Type" }, "fulfill_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fulfill At" }, "created_at": { "title": "Created At", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" }, "destination_city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Destination City" }, "destination_country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Destination Country Code" }, "line_items": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyFulfillmentOrdersListResponseFulfillmentOrderLineItem" }, "title": "Line Items", "type": "array" } }, "required": [ "id", "order_id", "order_name", "status", "request_status", "assigned_location", "assigned_location_id", "delivery_method_type", "fulfill_at", "created_at", "updated_at", "destination_city", "destination_country_code", "line_items" ], "title": "IntegrationsShopifyFulfillmentOrdersListResponseFulfillmentOrderItem", "type": "object" }, "IntegrationsShopifyFulfillmentOrdersListResponseFulfillmentOrderLineItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "sku": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sku" }, "product_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Product Title" }, "variant_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Variant Title" }, "total_quantity": { "title": "Total Quantity", "type": "integer" }, "remaining_quantity": { "title": "Remaining Quantity", "type": "integer" } }, "required": [ "id", "sku", "product_title", "variant_title", "total_quantity", "remaining_quantity" ], "title": "IntegrationsShopifyFulfillmentOrdersListResponseFulfillmentOrderLineItem", "type": "object" }, "IntegrationsShopifyFulfillmentOrdersListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyFulfillmentOrdersListResponseFulfillmentOrderItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsShopifyFulfillmentOrdersListResponse", "type": "object" }, "IntegrationsShopifyInventoryItemsGetRequest": { "additionalProperties": false, "properties": { "inventory_item_id": { "maxLength": 80, "minLength": 1, "title": "Inventory Item Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "inventory_item_id" ], "title": "IntegrationsShopifyInventoryItemsGetRequest", "type": "object" }, "IntegrationsShopifyInventoryItemsGetResponseInventoryLevelItem": { "additionalProperties": false, "properties": { "inventory_item_id": { "title": "Inventory Item Id", "type": "string" }, "sku": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sku" }, "location_id": { "title": "Location Id", "type": "string" }, "location_name": { "title": "Location Name", "type": "string" }, "quantities": { "additionalProperties": { "type": "integer" }, "title": "Quantities", "type": "object" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "inventory_item_id", "sku", "location_id", "location_name", "quantities", "updated_at" ], "title": "IntegrationsShopifyInventoryItemsGetResponseInventoryLevelItem", "type": "object" }, "IntegrationsShopifyInventoryItemsGetResponseMoney": { "additionalProperties": false, "properties": { "amount": { "title": "Amount", "type": "string" }, "currency_code": { "title": "Currency Code", "type": "string" } }, "required": [ "amount", "currency_code" ], "title": "IntegrationsShopifyInventoryItemsGetResponseMoney", "type": "object" }, "IntegrationsShopifyInventoryItemsGetResponse": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "sku": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sku" }, "tracked": { "title": "Tracked", "type": "boolean" }, "requires_shipping": { "title": "Requires Shipping", "type": "boolean" }, "unit_cost": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyInventoryItemsGetResponseMoney" }, { "type": "null" } ] }, "country_code_of_origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country Code Of Origin" }, "harmonized_system_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Harmonized System Code" }, "variant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Variant Id" }, "product_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Product Id" }, "variant_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Variant Title" }, "created_at": { "title": "Created At", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" }, "levels": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyInventoryItemsGetResponseInventoryLevelItem" }, "title": "Levels", "type": "array" } }, "required": [ "id", "sku", "tracked", "requires_shipping", "unit_cost", "country_code_of_origin", "harmonized_system_code", "variant_id", "product_id", "variant_title", "created_at", "updated_at", "levels" ], "title": "IntegrationsShopifyInventoryItemsGetResponse", "type": "object" }, "IntegrationsShopifyInventoryItemsListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Query" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsShopifyInventoryItemsListRequest", "type": "object" }, "IntegrationsShopifyInventoryItemsListResponseInventoryItemSummary": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "sku": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sku" }, "tracked": { "title": "Tracked", "type": "boolean" }, "requires_shipping": { "title": "Requires Shipping", "type": "boolean" }, "unit_cost": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyInventoryItemsListResponseMoney" }, { "type": "null" } ] }, "country_code_of_origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country Code Of Origin" }, "harmonized_system_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Harmonized System Code" }, "variant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Variant Id" }, "product_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Product Id" }, "variant_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Variant Title" }, "created_at": { "title": "Created At", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" } }, "required": [ "id", "sku", "tracked", "requires_shipping", "unit_cost", "country_code_of_origin", "harmonized_system_code", "variant_id", "product_id", "variant_title", "created_at", "updated_at" ], "title": "IntegrationsShopifyInventoryItemsListResponseInventoryItemSummary", "type": "object" }, "IntegrationsShopifyInventoryItemsListResponseMoney": { "additionalProperties": false, "properties": { "amount": { "title": "Amount", "type": "string" }, "currency_code": { "title": "Currency Code", "type": "string" } }, "required": [ "amount", "currency_code" ], "title": "IntegrationsShopifyInventoryItemsListResponseMoney", "type": "object" }, "IntegrationsShopifyInventoryItemsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyInventoryItemsListResponseInventoryItemSummary" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsShopifyInventoryItemsListResponse", "type": "object" }, "IntegrationsShopifyInventoryLevelsListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "location_id": { "maxLength": 80, "minLength": 1, "title": "Location Id", "type": "string" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Query" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "location_id" ], "title": "IntegrationsShopifyInventoryLevelsListRequest", "type": "object" }, "IntegrationsShopifyInventoryLevelsListResponseInventoryLevelItem": { "additionalProperties": false, "properties": { "inventory_item_id": { "title": "Inventory Item Id", "type": "string" }, "sku": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sku" }, "location_id": { "title": "Location Id", "type": "string" }, "location_name": { "title": "Location Name", "type": "string" }, "quantities": { "additionalProperties": { "type": "integer" }, "title": "Quantities", "type": "object" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "inventory_item_id", "sku", "location_id", "location_name", "quantities", "updated_at" ], "title": "IntegrationsShopifyInventoryLevelsListResponseInventoryLevelItem", "type": "object" }, "IntegrationsShopifyInventoryLevelsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyInventoryLevelsListResponseInventoryLevelItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsShopifyInventoryLevelsListResponse", "type": "object" }, "IntegrationsShopifyLocationsListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "include_inactive": { "default": false, "title": "Include Inactive", "type": "boolean" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsShopifyLocationsListRequest", "type": "object" }, "IntegrationsShopifyLocationsListResponseAddress": { "additionalProperties": false, "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "company": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company" }, "address1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address1" }, "address2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address2" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "province_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Province Code" }, "country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country Code" }, "zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zip" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone" } }, "required": [ "name", "company", "address1", "address2", "city", "province_code", "country_code", "zip", "phone" ], "title": "IntegrationsShopifyLocationsListResponseAddress", "type": "object" }, "IntegrationsShopifyLocationsListResponseLocationItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "fulfills_online_orders": { "title": "Fulfills Online Orders", "type": "boolean" }, "ships_inventory": { "title": "Ships Inventory", "type": "boolean" }, "address": { "$ref": "#/components/schemas/IntegrationsShopifyLocationsListResponseAddress" } }, "required": [ "id", "name", "is_active", "fulfills_online_orders", "ships_inventory", "address" ], "title": "IntegrationsShopifyLocationsListResponseLocationItem", "type": "object" }, "IntegrationsShopifyLocationsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyLocationsListResponseLocationItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsShopifyLocationsListResponse", "type": "object" }, "IntegrationsShopifyMarketingEventsListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Query" }, "reverse": { "default": true, "title": "Reverse", "type": "boolean" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsShopifyMarketingEventsListRequest", "type": "object" }, "IntegrationsShopifyMarketingEventsListResponseMarketingEventItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "type": { "title": "Type", "type": "string" }, "remote_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Remote Id" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "marketing_channel_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Marketing Channel Type" }, "app_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "App Name" }, "started_at": { "title": "Started At", "type": "string" }, "ended_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ended At" }, "scheduled_to_end_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled To End At" }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Utm Source" }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Utm Medium" }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Utm Campaign" }, "manage_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Manage Url" }, "preview_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Preview Url" } }, "required": [ "id", "type", "remote_id", "description", "marketing_channel_type", "app_name", "started_at", "ended_at", "scheduled_to_end_at", "utm_source", "utm_medium", "utm_campaign", "manage_url", "preview_url" ], "title": "IntegrationsShopifyMarketingEventsListResponseMarketingEventItem", "type": "object" }, "IntegrationsShopifyMarketingEventsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyMarketingEventsListResponseMarketingEventItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsShopifyMarketingEventsListResponse", "type": "object" }, "IntegrationsShopifyMarketsListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsShopifyMarketsListRequest", "type": "object" }, "IntegrationsShopifyMarketsListResponseMarketItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "handle": { "title": "Handle", "type": "string" }, "status": { "title": "Status", "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" }, "primary": { "title": "Primary", "type": "boolean" }, "base_currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Base Currency" }, "local_currencies": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Local Currencies" }, "region_country_codes": { "items": { "type": "string" }, "title": "Region Country Codes", "type": "array" } }, "required": [ "id", "name", "handle", "status", "type", "primary", "base_currency", "local_currencies", "region_country_codes" ], "title": "IntegrationsShopifyMarketsListResponseMarketItem", "type": "object" }, "IntegrationsShopifyMarketsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyMarketsListResponseMarketItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsShopifyMarketsListResponse", "type": "object" }, "IntegrationsShopifyMetafieldDefinitionsListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "owner_type": { "enum": [ "product", "product_variant", "collection", "customer", "order", "draft_order", "location", "shop", "company", "company_location", "market", "discount", "page", "article", "blog" ], "title": "Owner Type", "type": "string" }, "namespace": { "anyOf": [ { "pattern": "^[A-Za-z0-9_$.-]{1,255}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Namespace" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "owner_type" ], "title": "IntegrationsShopifyMetafieldDefinitionsListRequest", "type": "object" }, "IntegrationsShopifyMetafieldDefinitionsListResponseMetafieldDefinitionItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "namespace": { "title": "Namespace", "type": "string" }, "key": { "title": "Key", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "type": { "title": "Type", "type": "string" }, "owner_type": { "title": "Owner Type", "type": "string" }, "pinned_position": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Pinned Position" }, "metafields_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Metafields Count" }, "validations": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyMetafieldDefinitionsListResponseNamedValue" }, "title": "Validations", "type": "array" } }, "required": [ "id", "name", "namespace", "key", "description", "type", "owner_type", "pinned_position", "metafields_count", "validations" ], "title": "IntegrationsShopifyMetafieldDefinitionsListResponseMetafieldDefinitionItem", "type": "object" }, "IntegrationsShopifyMetafieldDefinitionsListResponseNamedValue": { "additionalProperties": false, "properties": { "name": { "title": "Name", "type": "string" }, "value": { "title": "Value", "type": "string" } }, "required": [ "name", "value" ], "title": "IntegrationsShopifyMetafieldDefinitionsListResponseNamedValue", "type": "object" }, "IntegrationsShopifyMetafieldDefinitionsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyMetafieldDefinitionsListResponseMetafieldDefinitionItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsShopifyMetafieldDefinitionsListResponse", "type": "object" }, "IntegrationsShopifyMetafieldsListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "owner_id": { "maxLength": 80, "minLength": 1, "title": "Owner Id", "type": "string" }, "namespace": { "anyOf": [ { "pattern": "^[A-Za-z0-9_$.-]{1,255}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Namespace" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "owner_id" ], "title": "IntegrationsShopifyMetafieldsListRequest", "type": "object" }, "IntegrationsShopifyMetafieldsListResponseMetafieldItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "namespace": { "title": "Namespace", "type": "string" }, "key": { "title": "Key", "type": "string" }, "type": { "title": "Type", "type": "string" }, "value": { "title": "Value", "type": "string" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "id", "namespace", "key", "type", "value", "updated_at" ], "title": "IntegrationsShopifyMetafieldsListResponseMetafieldItem", "type": "object" }, "IntegrationsShopifyMetafieldsListResponse": { "additionalProperties": false, "properties": { "owner_id": { "title": "Owner Id", "type": "string" }, "items": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyMetafieldsListResponseMetafieldItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "owner_id", "items", "next_cursor" ], "title": "IntegrationsShopifyMetafieldsListResponse", "type": "object" }, "IntegrationsShopifyMetaobjectDefinitionsListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsShopifyMetaobjectDefinitionsListRequest", "type": "object" }, "IntegrationsShopifyMetaobjectDefinitionsListResponseMetaobjectDefinitionItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "type": { "title": "Type", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "display_name_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name Key" }, "metaobjects_count": { "title": "Metaobjects Count", "type": "integer" }, "field_definitions": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyMetaobjectDefinitionsListResponseMetaobjectFieldDefinition" }, "title": "Field Definitions", "type": "array" } }, "required": [ "id", "name", "type", "description", "display_name_key", "metaobjects_count", "field_definitions" ], "title": "IntegrationsShopifyMetaobjectDefinitionsListResponseMetaobjectDefinitionItem", "type": "object" }, "IntegrationsShopifyMetaobjectDefinitionsListResponseMetaobjectFieldDefinition": { "additionalProperties": false, "properties": { "key": { "title": "Key", "type": "string" }, "name": { "title": "Name", "type": "string" }, "type": { "title": "Type", "type": "string" }, "required": { "title": "Required", "type": "boolean" } }, "required": [ "key", "name", "type", "required" ], "title": "IntegrationsShopifyMetaobjectDefinitionsListResponseMetaobjectFieldDefinition", "type": "object" }, "IntegrationsShopifyMetaobjectDefinitionsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyMetaobjectDefinitionsListResponseMetaobjectDefinitionItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsShopifyMetaobjectDefinitionsListResponse", "type": "object" }, "IntegrationsShopifyMetaobjectsListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "type": { "pattern": "^[A-Za-z0-9_$:-]{1,255}$", "title": "Type", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "type" ], "title": "IntegrationsShopifyMetaobjectsListRequest", "type": "object" }, "IntegrationsShopifyMetaobjectsListResponseMetaobjectItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "handle": { "title": "Handle", "type": "string" }, "type": { "title": "Type", "type": "string" }, "display_name": { "title": "Display Name", "type": "string" }, "fields": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": "Fields", "type": "object" }, "updated_at": { "title": "Updated At", "type": "string" } }, "required": [ "id", "handle", "type", "display_name", "fields", "updated_at" ], "title": "IntegrationsShopifyMetaobjectsListResponseMetaobjectItem", "type": "object" }, "IntegrationsShopifyMetaobjectsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyMetaobjectsListResponseMetaobjectItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsShopifyMetaobjectsListResponse", "type": "object" }, "IntegrationsShopifyOrdersGetRequest": { "additionalProperties": false, "properties": { "order_id": { "maxLength": 80, "minLength": 1, "title": "Order Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "order_id" ], "title": "IntegrationsShopifyOrdersGetRequest", "type": "object" }, "IntegrationsShopifyOrdersGetResponseAddress": { "additionalProperties": false, "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "company": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company" }, "address1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address1" }, "address2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address2" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "province_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Province Code" }, "country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country Code" }, "zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zip" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone" } }, "required": [ "name", "company", "address1", "address2", "city", "province_code", "country_code", "zip", "phone" ], "title": "IntegrationsShopifyOrdersGetResponseAddress", "type": "object" }, "IntegrationsShopifyOrdersGetResponseCustomerReference": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" } }, "required": [ "id", "display_name", "email" ], "title": "IntegrationsShopifyOrdersGetResponseCustomerReference", "type": "object" }, "IntegrationsShopifyOrdersGetResponseFulfillmentItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "status": { "title": "Status", "type": "string" }, "display_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Status" }, "created_at": { "title": "Created At", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" }, "tracking": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyOrdersGetResponseTrackingInfo" }, "title": "Tracking", "type": "array" } }, "required": [ "id", "status", "display_status", "created_at", "updated_at", "tracking" ], "title": "IntegrationsShopifyOrdersGetResponseFulfillmentItem", "type": "object" }, "IntegrationsShopifyOrdersGetResponseFulfillmentOrderReference": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "status": { "title": "Status", "type": "string" }, "request_status": { "title": "Request Status", "type": "string" }, "assigned_location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assigned Location" } }, "required": [ "id", "status", "request_status", "assigned_location" ], "title": "IntegrationsShopifyOrdersGetResponseFulfillmentOrderReference", "type": "object" }, "IntegrationsShopifyOrdersGetResponseLineItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "title": { "title": "Title", "type": "string" }, "variant_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Variant Title" }, "sku": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sku" }, "product_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Product Id" }, "variant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Variant Id" }, "quantity": { "title": "Quantity", "type": "integer" }, "unfulfilled_quantity": { "title": "Unfulfilled Quantity", "type": "integer" }, "original_total": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyOrdersGetResponseMoney" }, { "type": "null" } ] }, "discounted_total": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyOrdersGetResponseMoney" }, { "type": "null" } ] }, "requires_shipping": { "title": "Requires Shipping", "type": "boolean" }, "taxable": { "title": "Taxable", "type": "boolean" } }, "required": [ "id", "title", "variant_title", "sku", "product_id", "variant_id", "quantity", "unfulfilled_quantity", "original_total", "discounted_total", "requires_shipping", "taxable" ], "title": "IntegrationsShopifyOrdersGetResponseLineItem", "type": "object" }, "IntegrationsShopifyOrdersGetResponseMetafieldItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "namespace": { "title": "Namespace", "type": "string" }, "key": { "title": "Key", "type": "string" }, "type": { "title": "Type", "type": "string" }, "value": { "title": "Value", "type": "string" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "id", "namespace", "key", "type", "value", "updated_at" ], "title": "IntegrationsShopifyOrdersGetResponseMetafieldItem", "type": "object" }, "IntegrationsShopifyOrdersGetResponseMoney": { "additionalProperties": false, "properties": { "amount": { "title": "Amount", "type": "string" }, "currency_code": { "title": "Currency Code", "type": "string" } }, "required": [ "amount", "currency_code" ], "title": "IntegrationsShopifyOrdersGetResponseMoney", "type": "object" }, "IntegrationsShopifyOrdersGetResponseRefundItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "created_at": { "title": "Created At", "type": "string" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" }, "total": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyOrdersGetResponseMoney" }, { "type": "null" } ] } }, "required": [ "id", "created_at", "note", "total" ], "title": "IntegrationsShopifyOrdersGetResponseRefundItem", "type": "object" }, "IntegrationsShopifyOrdersGetResponseReturnItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "status": { "title": "Status", "type": "string" } }, "required": [ "id", "name", "status" ], "title": "IntegrationsShopifyOrdersGetResponseReturnItem", "type": "object" }, "IntegrationsShopifyOrdersGetResponseShippingLine": { "additionalProperties": false, "properties": { "title": { "title": "Title", "type": "string" }, "price": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyOrdersGetResponseMoney" }, { "type": "null" } ] } }, "required": [ "title", "price" ], "title": "IntegrationsShopifyOrdersGetResponseShippingLine", "type": "object" }, "IntegrationsShopifyOrdersGetResponseTrackingInfo": { "additionalProperties": false, "properties": { "company": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company" }, "number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Number" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" } }, "required": [ "company", "number", "url" ], "title": "IntegrationsShopifyOrdersGetResponseTrackingInfo", "type": "object" }, "IntegrationsShopifyOrdersGetResponseTransactionItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "kind": { "title": "Kind", "type": "string" }, "status": { "title": "Status", "type": "string" }, "gateway": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gateway" }, "amount": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyOrdersGetResponseMoney" }, { "type": "null" } ] }, "processed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Processed At" } }, "required": [ "id", "kind", "status", "gateway", "amount", "processed_at" ], "title": "IntegrationsShopifyOrdersGetResponseTransactionItem", "type": "object" }, "IntegrationsShopifyOrdersGetResponse": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "created_at": { "title": "Created At", "type": "string" }, "processed_at": { "title": "Processed At", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" }, "cancelled_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cancelled At" }, "closed": { "title": "Closed", "type": "boolean" }, "test": { "title": "Test", "type": "boolean" }, "display_financial_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Financial Status" }, "display_fulfillment_status": { "title": "Display Fulfillment Status", "type": "string" }, "currency_code": { "title": "Currency Code", "type": "string" }, "subtotal": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyOrdersGetResponseMoney" }, { "type": "null" } ] }, "total_price": { "$ref": "#/components/schemas/IntegrationsShopifyOrdersGetResponseMoney" }, "total_tax": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyOrdersGetResponseMoney" }, { "type": "null" } ] }, "total_discounts": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyOrdersGetResponseMoney" }, { "type": "null" } ] }, "total_shipping": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyOrdersGetResponseMoney" }, { "type": "null" } ] }, "total_refunded": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyOrdersGetResponseMoney" }, { "type": "null" } ] }, "customer": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyOrdersGetResponseCustomerReference" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "line_items_quantity": { "title": "Line Items Quantity", "type": "integer" }, "source_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Name" }, "sales_channel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sales Channel" }, "shipping_country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Shipping Country Code" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone" }, "line_items": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyOrdersGetResponseLineItem" }, "title": "Line Items", "type": "array" }, "line_items_truncated": { "title": "Line Items Truncated", "type": "boolean" }, "shipping_address": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyOrdersGetResponseAddress" }, { "type": "null" } ] }, "billing_address": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyOrdersGetResponseAddress" }, { "type": "null" } ] }, "shipping_line": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyOrdersGetResponseShippingLine" }, { "type": "null" } ] }, "discount_codes": { "items": { "type": "string" }, "title": "Discount Codes", "type": "array" }, "payment_gateway_names": { "items": { "type": "string" }, "title": "Payment Gateway Names", "type": "array" }, "fulfillments": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyOrdersGetResponseFulfillmentItem" }, "title": "Fulfillments", "type": "array" }, "fulfillment_orders": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyOrdersGetResponseFulfillmentOrderReference" }, "title": "Fulfillment Orders", "type": "array" }, "transactions": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyOrdersGetResponseTransactionItem" }, "title": "Transactions", "type": "array" }, "refunds": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyOrdersGetResponseRefundItem" }, "title": "Refunds", "type": "array" }, "returns": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyOrdersGetResponseReturnItem" }, "title": "Returns", "type": "array" }, "metafields": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyOrdersGetResponseMetafieldItem" }, "title": "Metafields", "type": "array" } }, "required": [ "id", "name", "created_at", "processed_at", "updated_at", "cancelled_at", "closed", "test", "display_financial_status", "display_fulfillment_status", "currency_code", "subtotal", "total_price", "total_tax", "total_discounts", "total_shipping", "total_refunded", "customer", "email", "tags", "line_items_quantity", "source_name", "sales_channel", "shipping_country_code", "note", "phone", "line_items", "line_items_truncated", "shipping_address", "billing_address", "shipping_line", "discount_codes", "payment_gateway_names", "fulfillments", "fulfillment_orders", "transactions", "refunds", "returns", "metafields" ], "title": "IntegrationsShopifyOrdersGetResponse", "type": "object" }, "IntegrationsShopifyOrdersListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Query" }, "reverse": { "default": true, "title": "Reverse", "type": "boolean" }, "sort_key": { "default": "processed_at", "enum": [ "processed_at", "total_price", "order_number", "created_at", "updated_at", "financial_status", "fulfillment_status", "id", "relevance" ], "title": "Sort Key", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsShopifyOrdersListRequest", "type": "object" }, "IntegrationsShopifyOrdersListResponseCustomerReference": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" } }, "required": [ "id", "display_name", "email" ], "title": "IntegrationsShopifyOrdersListResponseCustomerReference", "type": "object" }, "IntegrationsShopifyOrdersListResponseMoney": { "additionalProperties": false, "properties": { "amount": { "title": "Amount", "type": "string" }, "currency_code": { "title": "Currency Code", "type": "string" } }, "required": [ "amount", "currency_code" ], "title": "IntegrationsShopifyOrdersListResponseMoney", "type": "object" }, "IntegrationsShopifyOrdersListResponseOrderSummary": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "created_at": { "title": "Created At", "type": "string" }, "processed_at": { "title": "Processed At", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" }, "cancelled_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cancelled At" }, "closed": { "title": "Closed", "type": "boolean" }, "test": { "title": "Test", "type": "boolean" }, "display_financial_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Financial Status" }, "display_fulfillment_status": { "title": "Display Fulfillment Status", "type": "string" }, "currency_code": { "title": "Currency Code", "type": "string" }, "subtotal": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyOrdersListResponseMoney" }, { "type": "null" } ] }, "total_price": { "$ref": "#/components/schemas/IntegrationsShopifyOrdersListResponseMoney" }, "total_tax": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyOrdersListResponseMoney" }, { "type": "null" } ] }, "total_discounts": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyOrdersListResponseMoney" }, { "type": "null" } ] }, "total_shipping": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyOrdersListResponseMoney" }, { "type": "null" } ] }, "total_refunded": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyOrdersListResponseMoney" }, { "type": "null" } ] }, "customer": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyOrdersListResponseCustomerReference" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "line_items_quantity": { "title": "Line Items Quantity", "type": "integer" }, "source_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Name" }, "sales_channel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sales Channel" }, "shipping_country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Shipping Country Code" } }, "required": [ "id", "name", "created_at", "processed_at", "updated_at", "cancelled_at", "closed", "test", "display_financial_status", "display_fulfillment_status", "currency_code", "subtotal", "total_price", "total_tax", "total_discounts", "total_shipping", "total_refunded", "customer", "email", "tags", "line_items_quantity", "source_name", "sales_channel", "shipping_country_code" ], "title": "IntegrationsShopifyOrdersListResponseOrderSummary", "type": "object" }, "IntegrationsShopifyOrdersListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyOrdersListResponseOrderSummary" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsShopifyOrdersListResponse", "type": "object" }, "IntegrationsShopifyPayoutsListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Query" }, "reverse": { "default": true, "title": "Reverse", "type": "boolean" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsShopifyPayoutsListRequest", "type": "object" }, "IntegrationsShopifyPayoutsListResponseMoney": { "additionalProperties": false, "properties": { "amount": { "title": "Amount", "type": "string" }, "currency_code": { "title": "Currency Code", "type": "string" } }, "required": [ "amount", "currency_code" ], "title": "IntegrationsShopifyPayoutsListResponseMoney", "type": "object" }, "IntegrationsShopifyPayoutsListResponsePayoutItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "status": { "title": "Status", "type": "string" }, "transaction_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Transaction Type" }, "issued_at": { "title": "Issued At", "type": "string" }, "net": { "$ref": "#/components/schemas/IntegrationsShopifyPayoutsListResponseMoney" }, "charges_gross": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyPayoutsListResponseMoney" }, { "type": "null" } ] }, "charges_fee": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyPayoutsListResponseMoney" }, { "type": "null" } ] }, "refunds_fee": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyPayoutsListResponseMoney" }, { "type": "null" } ] }, "refunds_fee_gross": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyPayoutsListResponseMoney" }, { "type": "null" } ] }, "adjustments_gross": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyPayoutsListResponseMoney" }, { "type": "null" } ] }, "adjustments_fee": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyPayoutsListResponseMoney" }, { "type": "null" } ] }, "reserved_funds_gross": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyPayoutsListResponseMoney" }, { "type": "null" } ] }, "retried_payouts_gross": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyPayoutsListResponseMoney" }, { "type": "null" } ] } }, "required": [ "id", "status", "transaction_type", "issued_at", "net", "charges_gross", "charges_fee", "refunds_fee", "refunds_fee_gross", "adjustments_gross", "adjustments_fee", "reserved_funds_gross", "retried_payouts_gross" ], "title": "IntegrationsShopifyPayoutsListResponsePayoutItem", "type": "object" }, "IntegrationsShopifyPayoutsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyPayoutsListResponsePayoutItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsShopifyPayoutsListResponse", "type": "object" }, "IntegrationsShopifyProductTagsListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 50, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsShopifyProductTagsListRequest", "type": "object" }, "IntegrationsShopifyProductTagsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "type": "string" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsShopifyProductTagsListResponse", "type": "object" }, "IntegrationsShopifyProductTypesListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 50, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsShopifyProductTypesListRequest", "type": "object" }, "IntegrationsShopifyProductTypesListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "type": "string" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsShopifyProductTypesListResponse", "type": "object" }, "IntegrationsShopifyProductVariantsGetRequest": { "additionalProperties": false, "properties": { "variant_id": { "maxLength": 80, "minLength": 1, "title": "Variant Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "variant_id" ], "title": "IntegrationsShopifyProductVariantsGetRequest", "type": "object" }, "IntegrationsShopifyProductVariantsGetResponseNamedValue": { "additionalProperties": false, "properties": { "name": { "title": "Name", "type": "string" }, "value": { "title": "Value", "type": "string" } }, "required": [ "name", "value" ], "title": "IntegrationsShopifyProductVariantsGetResponseNamedValue", "type": "object" }, "IntegrationsShopifyProductVariantsGetResponse": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "product_id": { "title": "Product Id", "type": "string" }, "title": { "title": "Title", "type": "string" }, "display_name": { "title": "Display Name", "type": "string" }, "sku": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sku" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Barcode" }, "price": { "title": "Price", "type": "string" }, "compare_at_price": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Compare At Price" }, "position": { "title": "Position", "type": "integer" }, "inventory_quantity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Inventory Quantity" }, "inventory_item_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Inventory Item Id" }, "inventory_policy": { "title": "Inventory Policy", "type": "string" }, "taxable": { "title": "Taxable", "type": "boolean" }, "available_for_sale": { "title": "Available For Sale", "type": "boolean" }, "selected_options": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyProductVariantsGetResponseNamedValue" }, "title": "Selected Options", "type": "array" }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Url" }, "created_at": { "title": "Created At", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" } }, "required": [ "id", "product_id", "title", "display_name", "sku", "barcode", "price", "compare_at_price", "position", "inventory_quantity", "inventory_item_id", "inventory_policy", "taxable", "available_for_sale", "selected_options", "image_url", "created_at", "updated_at" ], "title": "IntegrationsShopifyProductVariantsGetResponse", "type": "object" }, "IntegrationsShopifyProductVariantsListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Query" }, "reverse": { "default": false, "title": "Reverse", "type": "boolean" }, "sort_key": { "default": "id", "enum": [ "title", "sku", "inventory_quantity", "position", "name", "id", "relevance" ], "title": "Sort Key", "type": "string" }, "product_id": { "anyOf": [ { "maxLength": 80, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Product Id" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsShopifyProductVariantsListRequest", "type": "object" }, "IntegrationsShopifyProductVariantsListResponseNamedValue": { "additionalProperties": false, "properties": { "name": { "title": "Name", "type": "string" }, "value": { "title": "Value", "type": "string" } }, "required": [ "name", "value" ], "title": "IntegrationsShopifyProductVariantsListResponseNamedValue", "type": "object" }, "IntegrationsShopifyProductVariantsListResponseVariantItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "product_id": { "title": "Product Id", "type": "string" }, "title": { "title": "Title", "type": "string" }, "display_name": { "title": "Display Name", "type": "string" }, "sku": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sku" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Barcode" }, "price": { "title": "Price", "type": "string" }, "compare_at_price": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Compare At Price" }, "position": { "title": "Position", "type": "integer" }, "inventory_quantity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Inventory Quantity" }, "inventory_item_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Inventory Item Id" }, "inventory_policy": { "title": "Inventory Policy", "type": "string" }, "taxable": { "title": "Taxable", "type": "boolean" }, "available_for_sale": { "title": "Available For Sale", "type": "boolean" }, "selected_options": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyProductVariantsListResponseNamedValue" }, "title": "Selected Options", "type": "array" }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Url" }, "created_at": { "title": "Created At", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" } }, "required": [ "id", "product_id", "title", "display_name", "sku", "barcode", "price", "compare_at_price", "position", "inventory_quantity", "inventory_item_id", "inventory_policy", "taxable", "available_for_sale", "selected_options", "image_url", "created_at", "updated_at" ], "title": "IntegrationsShopifyProductVariantsListResponseVariantItem", "type": "object" }, "IntegrationsShopifyProductVariantsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyProductVariantsListResponseVariantItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsShopifyProductVariantsListResponse", "type": "object" }, "IntegrationsShopifyProductVendorsListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 50, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsShopifyProductVendorsListRequest", "type": "object" }, "IntegrationsShopifyProductVendorsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "type": "string" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsShopifyProductVendorsListResponse", "type": "object" }, "IntegrationsShopifyProductsGetRequest": { "additionalProperties": false, "properties": { "product_id": { "anyOf": [ { "maxLength": 80, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Product Id" }, "handle": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9._-]{0,254}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Handle" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsShopifyProductsGetRequest", "type": "object" }, "IntegrationsShopifyProductsGetResponseMediaItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "media_content_type": { "title": "Media Content Type", "type": "string" }, "alt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alt" }, "preview_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Preview Url" } }, "required": [ "id", "media_content_type", "alt", "preview_url" ], "title": "IntegrationsShopifyProductsGetResponseMediaItem", "type": "object" }, "IntegrationsShopifyProductsGetResponseMetafieldItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "namespace": { "title": "Namespace", "type": "string" }, "key": { "title": "Key", "type": "string" }, "type": { "title": "Type", "type": "string" }, "value": { "title": "Value", "type": "string" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "id", "namespace", "key", "type", "value", "updated_at" ], "title": "IntegrationsShopifyProductsGetResponseMetafieldItem", "type": "object" }, "IntegrationsShopifyProductsGetResponseMoney": { "additionalProperties": false, "properties": { "amount": { "title": "Amount", "type": "string" }, "currency_code": { "title": "Currency Code", "type": "string" } }, "required": [ "amount", "currency_code" ], "title": "IntegrationsShopifyProductsGetResponseMoney", "type": "object" }, "IntegrationsShopifyProductsGetResponseNamedValue": { "additionalProperties": false, "properties": { "name": { "title": "Name", "type": "string" }, "value": { "title": "Value", "type": "string" } }, "required": [ "name", "value" ], "title": "IntegrationsShopifyProductsGetResponseNamedValue", "type": "object" }, "IntegrationsShopifyProductsGetResponseProductOption": { "additionalProperties": false, "properties": { "name": { "title": "Name", "type": "string" }, "values": { "items": { "type": "string" }, "title": "Values", "type": "array" } }, "required": [ "name", "values" ], "title": "IntegrationsShopifyProductsGetResponseProductOption", "type": "object" }, "IntegrationsShopifyProductsGetResponseReference": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "required": [ "id", "name" ], "title": "IntegrationsShopifyProductsGetResponseReference", "type": "object" }, "IntegrationsShopifyProductsGetResponseSeo": { "additionalProperties": false, "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" } }, "required": [ "title", "description" ], "title": "IntegrationsShopifyProductsGetResponseSeo", "type": "object" }, "IntegrationsShopifyProductsGetResponseVariantItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "product_id": { "title": "Product Id", "type": "string" }, "title": { "title": "Title", "type": "string" }, "display_name": { "title": "Display Name", "type": "string" }, "sku": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sku" }, "barcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Barcode" }, "price": { "title": "Price", "type": "string" }, "compare_at_price": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Compare At Price" }, "position": { "title": "Position", "type": "integer" }, "inventory_quantity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Inventory Quantity" }, "inventory_item_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Inventory Item Id" }, "inventory_policy": { "title": "Inventory Policy", "type": "string" }, "taxable": { "title": "Taxable", "type": "boolean" }, "available_for_sale": { "title": "Available For Sale", "type": "boolean" }, "selected_options": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyProductsGetResponseNamedValue" }, "title": "Selected Options", "type": "array" }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Url" }, "created_at": { "title": "Created At", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" } }, "required": [ "id", "product_id", "title", "display_name", "sku", "barcode", "price", "compare_at_price", "position", "inventory_quantity", "inventory_item_id", "inventory_policy", "taxable", "available_for_sale", "selected_options", "image_url", "created_at", "updated_at" ], "title": "IntegrationsShopifyProductsGetResponseVariantItem", "type": "object" }, "IntegrationsShopifyProductsGetResponse": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "handle": { "title": "Handle", "type": "string" }, "title": { "title": "Title", "type": "string" }, "status": { "title": "Status", "type": "string" }, "vendor": { "title": "Vendor", "type": "string" }, "product_type": { "title": "Product Type", "type": "string" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "total_inventory": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Inventory" }, "tracks_inventory": { "title": "Tracks Inventory", "type": "boolean" }, "price_min": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyProductsGetResponseMoney" }, { "type": "null" } ] }, "price_max": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyProductsGetResponseMoney" }, { "type": "null" } ] }, "variants_count": { "title": "Variants Count", "type": "integer" }, "has_only_default_variant": { "title": "Has Only Default Variant", "type": "boolean" }, "online_store_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Online Store Url" }, "featured_image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Featured Image Url" }, "created_at": { "title": "Created At", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" }, "published_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Published At" }, "description": { "title": "Description", "type": "string" }, "options": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyProductsGetResponseProductOption" }, "title": "Options", "type": "array" }, "variants": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyProductsGetResponseVariantItem" }, "title": "Variants", "type": "array" }, "variants_truncated": { "title": "Variants Truncated", "type": "boolean" }, "media": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyProductsGetResponseMediaItem" }, "title": "Media", "type": "array" }, "collections": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyProductsGetResponseReference" }, "title": "Collections", "type": "array" }, "metafields": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyProductsGetResponseMetafieldItem" }, "title": "Metafields", "type": "array" }, "seo": { "$ref": "#/components/schemas/IntegrationsShopifyProductsGetResponseSeo" } }, "required": [ "id", "handle", "title", "status", "vendor", "product_type", "tags", "total_inventory", "tracks_inventory", "price_min", "price_max", "variants_count", "has_only_default_variant", "online_store_url", "featured_image_url", "created_at", "updated_at", "published_at", "description", "options", "variants", "variants_truncated", "media", "collections", "metafields", "seo" ], "title": "IntegrationsShopifyProductsGetResponse", "type": "object" }, "IntegrationsShopifyProductsListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Query" }, "reverse": { "default": false, "title": "Reverse", "type": "boolean" }, "sort_key": { "default": "updated_at", "enum": [ "title", "product_type", "vendor", "inventory_total", "updated_at", "created_at", "published_at", "id", "relevance" ], "title": "Sort Key", "type": "string" }, "status": { "anyOf": [ { "enum": [ "ACTIVE", "ARCHIVED", "DRAFT" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsShopifyProductsListRequest", "type": "object" }, "IntegrationsShopifyProductsListResponseMoney": { "additionalProperties": false, "properties": { "amount": { "title": "Amount", "type": "string" }, "currency_code": { "title": "Currency Code", "type": "string" } }, "required": [ "amount", "currency_code" ], "title": "IntegrationsShopifyProductsListResponseMoney", "type": "object" }, "IntegrationsShopifyProductsListResponseProductSummary": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "handle": { "title": "Handle", "type": "string" }, "title": { "title": "Title", "type": "string" }, "status": { "title": "Status", "type": "string" }, "vendor": { "title": "Vendor", "type": "string" }, "product_type": { "title": "Product Type", "type": "string" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "total_inventory": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Inventory" }, "tracks_inventory": { "title": "Tracks Inventory", "type": "boolean" }, "price_min": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyProductsListResponseMoney" }, { "type": "null" } ] }, "price_max": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationsShopifyProductsListResponseMoney" }, { "type": "null" } ] }, "variants_count": { "title": "Variants Count", "type": "integer" }, "has_only_default_variant": { "title": "Has Only Default Variant", "type": "boolean" }, "online_store_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Online Store Url" }, "featured_image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Featured Image Url" }, "created_at": { "title": "Created At", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" }, "published_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Published At" } }, "required": [ "id", "handle", "title", "status", "vendor", "product_type", "tags", "total_inventory", "tracks_inventory", "price_min", "price_max", "variants_count", "has_only_default_variant", "online_store_url", "featured_image_url", "created_at", "updated_at", "published_at" ], "title": "IntegrationsShopifyProductsListResponseProductSummary", "type": "object" }, "IntegrationsShopifyProductsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyProductsListResponseProductSummary" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsShopifyProductsListResponse", "type": "object" }, "IntegrationsShopifyPublicationsListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsShopifyPublicationsListRequest", "type": "object" }, "IntegrationsShopifyPublicationsListResponsePublicationItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "title": { "title": "Title", "type": "string" }, "app_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "App Name" }, "supports_future_publishing": { "title": "Supports Future Publishing", "type": "boolean" }, "auto_publish": { "title": "Auto Publish", "type": "boolean" } }, "required": [ "id", "title", "app_name", "supports_future_publishing", "auto_publish" ], "title": "IntegrationsShopifyPublicationsListResponsePublicationItem", "type": "object" }, "IntegrationsShopifyPublicationsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyPublicationsListResponsePublicationItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsShopifyPublicationsListResponse", "type": "object" }, "IntegrationsShopifyReportsQueryRequest": { "additionalProperties": false, "properties": { "shopifyql": { "maxLength": 2000, "minLength": 1, "title": "Shopifyql", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "shopifyql" ], "title": "IntegrationsShopifyReportsQueryRequest", "type": "object" }, "IntegrationsShopifyReportsQueryResponseReportColumn": { "additionalProperties": false, "properties": { "name": { "title": "Name", "type": "string" }, "data_type": { "title": "Data Type", "type": "string" }, "display_name": { "title": "Display Name", "type": "string" } }, "required": [ "name", "data_type", "display_name" ], "title": "IntegrationsShopifyReportsQueryResponseReportColumn", "type": "object" }, "IntegrationsShopifyReportsQueryResponse": { "additionalProperties": false, "properties": { "columns": { "items": { "$ref": "#/components/schemas/IntegrationsShopifyReportsQueryResponseReportColumn" }, "title": "Columns", "type": "array" }, "rows": { "items": { "additionalProperties": true, "type": "object" }, "title": "Rows", "type": "array" }, "row_count": { "title": "Row Count", "type": "integer" }, "truncated": { "title": "Truncated", "type": "boolean" }, "parse_errors": { "items": { "type": "string" }, "title": "Parse Errors", "type": "array" } }, "required": [ "columns", "rows", "row_count", "truncated", "parse_errors" ], "title": "IntegrationsShopifyReportsQueryResponse", "type": "object" }, "IntegrationsShopifySegmentsListRequest": { "additionalProperties": false, "properties": { "limit": { "default": 25, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_.:-]{1,1024}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsShopifySegmentsListRequest", "type": "object" }, "IntegrationsShopifySegmentsListResponseSegmentItem": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "query": { "title": "Query", "type": "string" }, "creation_date": { "title": "Creation Date", "type": "string" }, "last_edit_date": { "title": "Last Edit Date", "type": "string" } }, "required": [ "id", "name", "query", "creation_date", "last_edit_date" ], "title": "IntegrationsShopifySegmentsListResponseSegmentItem", "type": "object" }, "IntegrationsShopifySegmentsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsShopifySegmentsListResponseSegmentItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsShopifySegmentsListResponse", "type": "object" }, "IntegrationsShopifyShopGetRequest": { "additionalProperties": false, "properties": { "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsShopifyShopGetRequest", "type": "object" }, "IntegrationsShopifyShopGetResponse": { "additionalProperties": false, "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "myshopify_domain": { "title": "Myshopify Domain", "type": "string" }, "primary_domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primary Domain" }, "contact_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Contact Email" }, "currency_code": { "title": "Currency Code", "type": "string" }, "enabled_presentment_currencies": { "items": { "type": "string" }, "title": "Enabled Presentment Currencies", "type": "array" }, "timezone": { "title": "Timezone", "type": "string" }, "country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country Code" }, "plan_name": { "title": "Plan Name", "type": "string" }, "weight_unit": { "title": "Weight Unit", "type": "string" }, "taxes_included": { "title": "Taxes Included", "type": "boolean" }, "created_at": { "title": "Created At", "type": "string" } }, "required": [ "id", "name", "myshopify_domain", "primary_domain", "contact_email", "currency_code", "enabled_presentment_currencies", "timezone", "country_code", "plan_name", "weight_unit", "taxes_included", "created_at" ], "title": "IntegrationsShopifyShopGetResponse", "type": "object" }, "IntegrationsSlackConversationsListRequest": { "additionalProperties": false, "properties": { "types": { "default": [ "public", "private", "mpim", "im" ], "items": { "enum": [ "public", "private", "mpim", "im" ], "type": "string" }, "maxItems": 4, "minItems": 1, "title": "Types", "type": "array" }, "exclude_archived": { "default": true, "title": "Exclude Archived", "type": "boolean" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_-]{1,512}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 100, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsSlackConversationsListRequest", "type": "object" }, "IntegrationsSlackConversationsListResponseConversationItem": { "additionalProperties": false, "properties": { "channel_id": { "title": "Channel Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "kind": { "enum": [ "public", "private", "mpim", "im" ], "title": "Kind", "type": "string" }, "is_member": { "title": "Is Member", "type": "boolean" }, "is_archived": { "title": "Is Archived", "type": "boolean" }, "member_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Member Count" }, "topic": { "title": "Topic", "type": "string" }, "purpose": { "title": "Purpose", "type": "string" } }, "required": [ "channel_id", "name", "kind", "is_member", "is_archived", "member_count", "topic", "purpose" ], "title": "IntegrationsSlackConversationsListResponseConversationItem", "type": "object" }, "IntegrationsSlackConversationsListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsSlackConversationsListResponseConversationItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsSlackConversationsListResponse", "type": "object" }, "IntegrationsSlackConversationsOpenRequest": { "additionalProperties": false, "properties": { "user_ids": { "items": { "pattern": "^[UW][A-Z0-9]{8,20}$", "type": "string" }, "maxItems": 8, "minItems": 1, "title": "User Ids", "type": "array" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "user_ids" ], "title": "IntegrationsSlackConversationsOpenRequest", "type": "object" }, "IntegrationsSlackConversationsOpenResponse": { "type": "object", "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "job_id": { "type": "string" }, "safe_error_code": { "type": "string" } }, "required": [ "invocation_id", "status", "job_id" ], "additionalProperties": false, "title": "IntegrationsSlackConversationsOpenResponse" }, "IntegrationsSlackMessagesListRequest": { "additionalProperties": false, "properties": { "channel_id": { "pattern": "^[CDG][A-Z0-9]{8,20}$", "title": "Channel Id", "type": "string" }, "oldest": { "anyOf": [ { "pattern": "^[0-9]{10}\\.[0-9]{6}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Oldest" }, "latest": { "anyOf": [ { "pattern": "^[0-9]{10}\\.[0-9]{6}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Latest" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_-]{1,512}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 15, "maximum": 15, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "channel_id" ], "title": "IntegrationsSlackMessagesListRequest", "type": "object" }, "IntegrationsSlackMessagesListResponseMessageItem": { "additionalProperties": false, "properties": { "channel_id": { "title": "Channel Id", "type": "string" }, "ts": { "title": "Ts", "type": "string" }, "sent_at": { "title": "Sent At", "type": "string" }, "user_id": { "title": "User Id", "type": "string" }, "subtype": { "title": "Subtype", "type": "string" }, "text": { "title": "Text", "type": "string" }, "text_truncated": { "title": "Text Truncated", "type": "boolean" }, "thread_ts": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thread Ts" }, "reply_count": { "title": "Reply Count", "type": "integer" }, "reaction_names": { "items": { "type": "string" }, "title": "Reaction Names", "type": "array" }, "has_files": { "title": "Has Files", "type": "boolean" }, "permalink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Permalink" } }, "required": [ "channel_id", "ts", "sent_at", "user_id", "subtype", "text", "text_truncated", "thread_ts", "reply_count", "reaction_names", "has_files", "permalink" ], "title": "IntegrationsSlackMessagesListResponseMessageItem", "type": "object" }, "IntegrationsSlackMessagesListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsSlackMessagesListResponseMessageItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsSlackMessagesListResponse", "type": "object" }, "IntegrationsSlackMessagesSearchRequest": { "additionalProperties": false, "properties": { "query": { "pattern": "^[^\\x00-\\x1f\\x7f]{1,200}$", "title": "Query", "type": "string" }, "page": { "default": 1, "maximum": 100, "minimum": 1, "title": "Page", "type": "integer" }, "count": { "default": 20, "maximum": 50, "minimum": 1, "title": "Count", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "query" ], "title": "IntegrationsSlackMessagesSearchRequest", "type": "object" }, "IntegrationsSlackMessagesSearchResponseMessageItem": { "additionalProperties": false, "properties": { "channel_id": { "title": "Channel Id", "type": "string" }, "ts": { "title": "Ts", "type": "string" }, "sent_at": { "title": "Sent At", "type": "string" }, "user_id": { "title": "User Id", "type": "string" }, "subtype": { "title": "Subtype", "type": "string" }, "text": { "title": "Text", "type": "string" }, "text_truncated": { "title": "Text Truncated", "type": "boolean" }, "thread_ts": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thread Ts" }, "reply_count": { "title": "Reply Count", "type": "integer" }, "reaction_names": { "items": { "type": "string" }, "title": "Reaction Names", "type": "array" }, "has_files": { "title": "Has Files", "type": "boolean" }, "permalink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Permalink" } }, "required": [ "channel_id", "ts", "sent_at", "user_id", "subtype", "text", "text_truncated", "thread_ts", "reply_count", "reaction_names", "has_files", "permalink" ], "title": "IntegrationsSlackMessagesSearchResponseMessageItem", "type": "object" }, "IntegrationsSlackMessagesSearchResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsSlackMessagesSearchResponseMessageItem" }, "title": "Items", "type": "array" }, "total": { "title": "Total", "type": "integer" }, "has_more": { "title": "Has More", "type": "boolean" } }, "required": [ "items", "total", "has_more" ], "title": "IntegrationsSlackMessagesSearchResponse", "type": "object" }, "IntegrationsSlackMessagesSendRequest": { "additionalProperties": false, "properties": { "channel_id": { "pattern": "^[CDG][A-Z0-9]{8,20}$", "title": "Channel Id", "type": "string" }, "text": { "maxLength": 4000, "minLength": 1, "title": "Text", "type": "string" }, "thread_ts": { "anyOf": [ { "pattern": "^[0-9]{10}\\.[0-9]{6}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Thread Ts" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "channel_id", "text" ], "title": "IntegrationsSlackMessagesSendRequest", "type": "object" }, "IntegrationsSlackMessagesSendResponse": { "type": "object", "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "job_id": { "type": "string" }, "safe_error_code": { "type": "string" } }, "required": [ "invocation_id", "status", "job_id" ], "additionalProperties": false, "title": "IntegrationsSlackMessagesSendResponse" }, "IntegrationsSlackReactionsAddRequest": { "additionalProperties": false, "properties": { "channel_id": { "pattern": "^[CDG][A-Z0-9]{8,20}$", "title": "Channel Id", "type": "string" }, "message_ts": { "pattern": "^[0-9]{10}\\.[0-9]{6}$", "title": "Message Ts", "type": "string" }, "reaction": { "pattern": "^:?[a-z0-9_+\\-](?:[a-z0-9_+\\-:]{0,97}[a-z0-9_+\\-])?:?$", "title": "Reaction", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "channel_id", "message_ts", "reaction" ], "title": "IntegrationsSlackReactionsAddRequest", "type": "object" }, "IntegrationsSlackReactionsAddResponse": { "type": "object", "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "job_id": { "type": "string" }, "safe_error_code": { "type": "string" } }, "required": [ "invocation_id", "status", "job_id" ], "additionalProperties": false, "title": "IntegrationsSlackReactionsAddResponse" }, "IntegrationsSlackThreadsGetRequest": { "additionalProperties": false, "properties": { "channel_id": { "pattern": "^[CDG][A-Z0-9]{8,20}$", "title": "Channel Id", "type": "string" }, "thread_ts": { "pattern": "^[0-9]{10}\\.[0-9]{6}$", "title": "Thread Ts", "type": "string" }, "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_-]{1,512}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 15, "maximum": 15, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "channel_id", "thread_ts" ], "title": "IntegrationsSlackThreadsGetRequest", "type": "object" }, "IntegrationsSlackThreadsGetResponseMessageItem": { "additionalProperties": false, "properties": { "channel_id": { "title": "Channel Id", "type": "string" }, "ts": { "title": "Ts", "type": "string" }, "sent_at": { "title": "Sent At", "type": "string" }, "user_id": { "title": "User Id", "type": "string" }, "subtype": { "title": "Subtype", "type": "string" }, "text": { "title": "Text", "type": "string" }, "text_truncated": { "title": "Text Truncated", "type": "boolean" }, "thread_ts": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thread Ts" }, "reply_count": { "title": "Reply Count", "type": "integer" }, "reaction_names": { "items": { "type": "string" }, "title": "Reaction Names", "type": "array" }, "has_files": { "title": "Has Files", "type": "boolean" }, "permalink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Permalink" } }, "required": [ "channel_id", "ts", "sent_at", "user_id", "subtype", "text", "text_truncated", "thread_ts", "reply_count", "reaction_names", "has_files", "permalink" ], "title": "IntegrationsSlackThreadsGetResponseMessageItem", "type": "object" }, "IntegrationsSlackThreadsGetResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsSlackThreadsGetResponseMessageItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsSlackThreadsGetResponse", "type": "object" }, "IntegrationsSlackUsersGetRequest": { "additionalProperties": false, "properties": { "user_id": { "pattern": "^[UW][A-Z0-9]{8,20}$", "title": "User Id", "type": "string" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "user_id" ], "title": "IntegrationsSlackUsersGetRequest", "type": "object" }, "IntegrationsSlackUsersGetResponse": { "additionalProperties": false, "properties": { "user_id": { "title": "User Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "real_name": { "title": "Real Name", "type": "string" }, "display_name": { "title": "Display Name", "type": "string" }, "email": { "title": "Email", "type": "string" }, "is_bot": { "title": "Is Bot", "type": "boolean" }, "deleted": { "title": "Deleted", "type": "boolean" }, "tz": { "title": "Tz", "type": "string" } }, "required": [ "user_id", "name", "real_name", "display_name", "email", "is_bot", "deleted", "tz" ], "title": "IntegrationsSlackUsersGetResponse", "type": "object" }, "IntegrationsSlackUsersListRequest": { "additionalProperties": false, "properties": { "cursor": { "anyOf": [ { "pattern": "^[A-Za-z0-9+/=_-]{1,512}$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Cursor" }, "limit": { "default": 100, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" }, "space_id": { "type": [ "string", "null" ], "format": "uuid" }, "grant_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "IntegrationsSlackUsersListRequest", "type": "object" }, "IntegrationsSlackUsersListResponseUserItem": { "additionalProperties": false, "properties": { "user_id": { "title": "User Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "real_name": { "title": "Real Name", "type": "string" }, "display_name": { "title": "Display Name", "type": "string" }, "email": { "title": "Email", "type": "string" }, "is_bot": { "title": "Is Bot", "type": "boolean" }, "deleted": { "title": "Deleted", "type": "boolean" }, "tz": { "title": "Tz", "type": "string" } }, "required": [ "user_id", "name", "real_name", "display_name", "email", "is_bot", "deleted", "tz" ], "title": "IntegrationsSlackUsersListResponseUserItem", "type": "object" }, "IntegrationsSlackUsersListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/IntegrationsSlackUsersListResponseUserItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "IntegrationsSlackUsersListResponse", "type": "object" } }, "parameters": { "IdempotencyKey": { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key for this intended write. Reuse it only for an identical retry.", "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "example": "123e4567-e89b-42d3-a456-426614174000" }, "RequestId": { "name": "X-Request-Id", "in": "header", "description": "Optional correlation identifier.", "schema": { "type": "string", "maxLength": 128 } }, "cursor": { "name": "cursor", "in": "query", "description": "Opaque continuation cursor.", "schema": { "type": "string", "maxLength": 2048 } }, "limit": { "name": "limit", "in": "query", "description": "Maximum items in this page.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } }, "headers": { "RateLimit": { "description": "Remaining requests and reset time for the active quota.", "schema": { "type": "string" } }, "RateLimit-Policy": { "description": "API key and tenant request quotas.", "schema": { "type": "string" } }, "ETag": { "description": "Weak representation validator.", "schema": { "type": "string" } }, "Deprecation": { "description": "Deprecation date as an HTTP structured timestamp.", "schema": { "type": "string" } }, "Sunset": { "description": "Date this endpoint will stop responding.", "schema": { "type": "string" } }, "X-Request-Id": { "description": "Correlation identifier for support and audit.", "schema": { "type": "string" } }, "Idempotent-Replayed": { "description": "True when replaying a previous write.", "schema": { "type": "string" } }, "Location": { "description": "Polling resource for the accepted operation.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds before retrying or polling.", "schema": { "type": "string" } } }, "responses": { "Problem": { "description": "RFC 9457 problem details.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }