{ "openapi": "3.1.0", "info": { "title": "Extract API", "description": "The Extract API lets you programmatically manage your data pipelines \u2014 sources,\ndestinations, connections, and more.\n\n## Authentication\n\nMost endpoints require a Bearer token in the `Authorization` header:\n\n```\nAuthorization: Bearer \n```\n\nTo find your API key in the Extract app, open the account menu and go to **Profile**,\nor visit `https://app.extract.to/users/edit/me`, then copy the **API Key** field.\n\nThis API key represents your user, should be kept secret, and is valid for **90 days**.\n\n## Permissions\n\nMost read operations require any authenticated user. Write operations\n(create, update, delete) require the **Creator** or **Admin** role unless\notherwise noted. Billing endpoints require the **Billing** permission.\n\n## IDs\n\nAll resource IDs are opaque UUID-format strings\n(e.g. `a1b2c3d4-e5f6-7890-abcd-ef1234567890`). Always treat them as\nopaque \u2014 do not parse or construct them.\n\n## Errors\n\nErrors return a JSON body with a `detail` field:\n\n```json\n{\"detail\": \"Connection not found\"}\n```\n", "version": "1.0.0" }, "servers": [ { "url": "https://api.extract.to" } ], "paths": { "/connections": { "get": { "tags": [ "Connections" ], "summary": "List connections", "operationId": "list_connections_connections_get", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionSchema" }, "title": "Response List Connections Connections Get" } } } } } }, "post": { "tags": [ "Connections" ], "summary": "Create connection", "operationId": "create_connection_connections_post", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "date_range", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/AggregateUsageDateRange", "default": "current_billing_period" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Start Date" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "End Date" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConnectionRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/connections/{connection_id}": { "get": { "tags": [ "Connections" ], "summary": "Get connection", "operationId": "get_connection_connections__connection_id__get", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "connection_id", "in": "path", "required": true, "schema": { "title": "Connection Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Connections" ], "summary": "Update connection", "operationId": "update_connection_connections__connection_id__post", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "connection_id", "in": "path", "required": true, "schema": { "title": "Connection Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateConnectionRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Connections" ], "summary": "Delete connection", "operationId": "delete_connection_connections__connection_id__delete", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "connection_id", "in": "path", "required": true, "schema": { "title": "Connection Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/connections/{connection_id}/runs": { "get": { "tags": [ "Connections" ], "summary": "List connection runs", "operationId": "get_connection_runs_connections__connection_id__runs_get", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "connection_id", "in": "path", "required": true, "schema": { "title": "Connection Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionRunSchema" }, "title": "Response Get Connection Runs Connections Connection Id Runs Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/connections/{connection_id}/runs/{connection_run_id}/stream_runs": { "get": { "tags": [ "Connections" ], "summary": "List stream runs", "description": "Get stream runs for a connection run.", "operationId": "connection_run_stream_runs_connections__connection_id__runs__connection_run_id__stream_runs_get", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "connection_id", "in": "path", "required": true, "schema": { "title": "Connection Id" } }, { "name": "connection_run_id", "in": "path", "required": true, "schema": { "title": "Connection Run Id" } }, { "name": "cross_account", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Cross Account" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StreamRunSchema" }, "title": "Response Connection Run Stream Runs Connections Connection Id Runs Connection Run Id Stream Runs Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/connections/{connection_id}/run": { "post": { "tags": [ "Connections" ], "summary": "Trigger connection run", "operationId": "run_connection_connections__connection_id__run_post", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "connection_id", "in": "path", "required": true, "schema": { "title": "Connection Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/CustomRunParameters" }, { "type": "null" } ], "title": "Custom Parameters" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Response Run Connection Connections Connection Id Run Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/connections/{connection_run_id}/stop": { "post": { "tags": [ "Connections" ], "summary": "Stop connection run", "operationId": "stop_connection_connections__connection_run_id__stop_post", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "connection_run_id", "in": "path", "required": true, "schema": { "title": "Connection Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Response Stop Connection Connections Connection Run Id Stop Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/connections/{connection_id}/update_catalog": { "post": { "tags": [ "Connections" ], "summary": "Refresh connection catalog", "operationId": "update_catalog_connections__connection_id__update_catalog_post", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "connection_id", "in": "path", "required": true, "schema": { "title": "Connection Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "string", "title": "Response Update Catalog Connections Connection Id Update Catalog Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/connectors": { "get": { "tags": [ "Connectors" ], "summary": "List connectors", "operationId": "list_connectors_connectors_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ConnectorSchema" }, "type": "array", "title": "Response List Connectors Connectors Get" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/connectors/{connector_type}/{connector_name}": { "get": { "tags": [ "Connectors" ], "summary": "Get connector", "operationId": "get_connector_connectors__connector_type___connector_name__get", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "connector_type", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ConnectorType" } }, { "name": "connector_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Connector Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/account_connectors/generate_ssh_key": { "post": { "tags": [ "Sources & Destinations" ], "summary": "Generate SSH key pair", "description": "Generate an SSH key pair, return encrypted private key + public key.", "operationId": "generate_ssh_key_account_connectors_generate_ssh_key_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateSSHKeyResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/account_connectors": { "get": { "tags": [ "Sources & Destinations" ], "summary": "List sources and destinations", "operationId": "list_account_connectors_account_connectors_get", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "connector_type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ConnectorType" }, { "type": "null" } ], "title": "Connector Type" } }, { "name": "connector_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connector Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountConnectorSchema" }, "title": "Response List Account Connectors Account Connectors Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Sources & Destinations" ], "summary": "Create source or destination", "operationId": "create_account_connector_account_connectors_post", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "date_range", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/AggregateUsageDateRange", "default": "current_billing_period" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Start Date" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "End Date" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccountConnectorRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountConnectorSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/account_connectors/{connector_type}/{account_connector_id}": { "get": { "tags": [ "Sources & Destinations" ], "summary": "Get source or destination", "operationId": "get_account_connector_account_connectors__connector_type___account_connector_id__get", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "connector_type", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ConnectorType" } }, { "name": "account_connector_id", "in": "path", "required": true, "schema": { "title": "Account Connector Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountConnectorSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/account_connectors/{account_connector_id}/catalog": { "post": { "tags": [ "Sources & Destinations" ], "summary": "Update catalog field overrides", "operationId": "update_account_connector_catalog_account_connectors__account_connector_id__catalog_post", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "account_connector_id", "in": "path", "required": true, "schema": { "title": "Account Connector Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAccountConnectorCatalogRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountConnectorCatalogItemSchema" }, "title": "Response Update Account Connector Catalog Account Connectors Account Connector Id Catalog Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/account_connectors/{account_connector_id}": { "post": { "tags": [ "Sources & Destinations" ], "summary": "Update source or destination", "operationId": "update_account_connector_account_connectors__account_connector_id__post", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "account_connector_id", "in": "path", "required": true, "schema": { "title": "Account Connector Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAccountConnectorRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountConnectorSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Sources & Destinations" ], "summary": "Delete source or destination", "operationId": "delete_account_connector_account_connectors__account_connector_id__delete", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "account_connector_id", "in": "path", "required": true, "schema": { "title": "Account Connector Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/account_connectors/{account_connector_id}/login": { "post": { "tags": [ "Sources & Destinations" ], "summary": "Authenticate source or destination", "operationId": "login_account_connectors__account_connector_id__login_post", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "account_connector_id", "in": "path", "required": true, "schema": { "title": "Account Connector Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "string", "title": "Response Login Account Connectors Account Connector Id Login Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/account_connectors/{account_connector_id}/source_tasks/export_metadata": { "post": { "tags": [ "Sources & Destinations" ], "summary": "Export source metadata", "operationId": "export_account_connector_source_metadata_account_connectors__account_connector_id__source_tasks_export_metadata_post", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "account_connector_id", "in": "path", "required": true, "schema": { "title": "Account Connector Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExportSourceMetadataRequest" }, { "type": "null" } ], "title": "Req" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "string", "title": "Response Export Account Connector Source Metadata Account Connectors Account Connector Id Source Tasks Export Metadata Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/account_connectors/{account_connector_id}/dynamic_possible_values/{parameter_name}": { "get": { "tags": [ "Sources & Destinations" ], "summary": "Get dynamic parameter values", "operationId": "get_dynamic_possible_values_account_connectors__account_connector_id__dynamic_possible_values__parameter_name__get", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "parameter_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Parameter Name" } }, { "name": "account_connector_id", "in": "path", "required": true, "schema": { "title": "Account Connector Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" }, "title": "Response Get Dynamic Possible Values Account Connectors Account Connector Id Dynamic Possible Values Parameter Name Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/account_connectors/{account_connector_id}/validate_parameter": { "post": { "tags": [ "Sources & Destinations" ], "summary": "Validate parameter value", "operationId": "validate_parameter_account_connectors__account_connector_id__validate_parameter_post", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "account_connector_id", "in": "path", "required": true, "schema": { "title": "Account Connector Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users": { "get": { "tags": [ "Users" ], "summary": "List Users", "operationId": "list_users_users_get", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserSchemaWithMeTagged" }, "title": "Response List Users Users Get" } } } } } }, "post": { "tags": [ "Users" ], "summary": "Create User", "operationId": "create_user_users_post", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "date_range", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/AggregateUsageDateRange", "default": "current_billing_period" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Start Date" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "End Date" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/me": { "get": { "tags": [ "Users" ], "summary": "Get Me", "operationId": "get_me_users_me_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpandedUserSchema" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/users/{user_id}": { "get": { "tags": [ "Users" ], "summary": "Get User", "operationId": "get_user_users__user_id__get", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Users" ], "summary": "Update Update", "operationId": "update_update_users__user_id__post", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Users" ], "summary": "Delete User", "operationId": "delete_user_users__user_id__delete", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/me/avatar": { "post": { "tags": [ "Users" ], "summary": "Upload Avatar", "operationId": "upload_avatar_users_me_avatar_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_avatar_users_me_avatar_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvatarUploadResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/users/me/onboarding-state": { "put": { "tags": [ "Users" ], "summary": "Update Onboarding State", "operationId": "update_onboarding_state_users_me_onboarding_state_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardingStateSchema" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardingStateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/roles": { "get": { "tags": [ "Roles & Permissions" ], "summary": "List Roles", "operationId": "list_roles_roles_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/RoleSchema" }, "type": "array", "title": "Response List Roles Roles Get" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Roles & Permissions" ], "summary": "Create Role", "operationId": "create_role_roles_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/roles/{role_id}": { "get": { "tags": [ "Roles & Permissions" ], "summary": "Get Role", "operationId": "get_role_roles__role_id__get", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "role_id", "in": "path", "required": true, "schema": { "title": "Role Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Roles & Permissions" ], "summary": "Update Role", "operationId": "update_role_roles__role_id__post", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "role_id", "in": "path", "required": true, "schema": { "title": "Role Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Roles & Permissions" ], "summary": "Delete Role", "operationId": "delete_role_roles__role_id__delete", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "role_id", "in": "path", "required": true, "schema": { "title": "Role Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/roles/{role_id}/users/{user_id}": { "post": { "tags": [ "Roles & Permissions" ], "summary": "Add User To Role", "operationId": "add_user_to_role_roles__role_id__users__user_id__post", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "role_id", "in": "path", "required": true, "schema": { "title": "Role Id" } }, { "name": "user_id", "in": "path", "required": true, "schema": { "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Roles & Permissions" ], "summary": "Remove User From Role", "operationId": "remove_user_from_role_roles__role_id__users__user_id__delete", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "role_id", "in": "path", "required": true, "schema": { "title": "Role Id" } }, { "name": "user_id", "in": "path", "required": true, "schema": { "title": "User Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/automation/evaluate_automator_rule": { "post": { "tags": [ "Automation" ], "summary": "Evaluate automation rule", "operationId": "evaluate_automator_rule_automation_evaluate_automator_rule_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Evaluate Automator Rule Automation Evaluate Automator Rule Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/automation/events": { "get": { "tags": [ "Automation" ], "summary": "List events", "operationId": "list_events_automation_events_get", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_EventSchema_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/automation/triggers": { "get": { "tags": [ "Automation" ], "summary": "List triggers", "operationId": "list_triggers_automation_triggers_get", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "include_system", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include System" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TriggerSchema" }, "title": "Response List Triggers Automation Triggers Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Automation" ], "summary": "Create trigger", "operationId": "create_trigger_automation_triggers_post", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTriggerRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriggerSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/automation/triggers/{trigger_id}": { "get": { "tags": [ "Automation" ], "summary": "Get trigger", "operationId": "get_trigger_automation_triggers__trigger_id__get", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "trigger_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Trigger Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriggerSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Automation" ], "summary": "Update trigger", "operationId": "update_trigger_automation_triggers__trigger_id__post", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "trigger_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Trigger Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTriggerRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriggerSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Automation" ], "summary": "Delete trigger", "operationId": "delete_trigger_automation_triggers__trigger_id__delete", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "trigger_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Trigger Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/automation/cases": { "get": { "tags": [ "Automation" ], "summary": "List cases", "operationId": "list_cases_automation_cases_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/CaseSchema" }, "type": "array", "title": "Response List Cases Automation Cases Get" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/automation/cases/{case_id}": { "get": { "tags": [ "Automation" ], "summary": "Get case", "operationId": "get_case_automation_cases__case_id__get", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "case_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Case Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Automation" ], "summary": "Update case status", "operationId": "update_case_status_automation_cases__case_id__post", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "case_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Case Id" } }, { "name": "status", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CaseStatus" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/automation/slack_channels/{account_connector_id}": { "get": { "tags": [ "Automation" ], "summary": "List Slack channels", "operationId": "get_slack_channels_automation_slack_channels__account_connector_id__get", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "account_connector_id", "in": "path", "required": true, "schema": { "title": "Account Connector Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SlackChannel" }, "title": "Response Get Slack Channels Automation Slack Channels Account Connector Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/billing/plans": { "get": { "tags": [ "Billing" ], "summary": "Get Plans", "description": "Get all Available plans.", "operationId": "get_plans_billing_plans_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/PlanSchema" }, "type": "array", "title": "Response Get Plans Billing Plans Get" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/billing/usage/aggregated": { "get": { "tags": [ "Billing" ], "summary": "Get Aggregated Usage", "operationId": "get_aggregated_usage_billing_usage_aggregated_get", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "date_range", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/AggregateUsageDateRange", "default": "current_billing_period" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Start Date" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "End Date" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AggregateUsageSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/billing/usage/connection-usage": { "get": { "tags": [ "Billing" ], "summary": "Get Connection Usage", "operationId": "get_connection_usage_billing_usage_connection_usage_get", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "title": "Start Date" } }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "title": "End Date" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionUsageSchema" }, "title": "Response Get Connection Usage Billing Usage Connection Usage Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "AccountConnectorCatalogItemSchema": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "catalog_object": { "$ref": "#/components/schemas/CatalogObjectSchema" }, "field_overrides": { "additionalProperties": { "$ref": "#/components/schemas/SchemaFieldSpecOverride" }, "type": "object", "title": "Field Overrides" } }, "type": "object", "required": [ "id", "name", "catalog_object", "field_overrides" ], "title": "AccountConnectorCatalogItemSchema" }, "AccountConnectorOrConnectionOrStreamParameterSchema": { "properties": { "parameter": { "anyOf": [ { "$ref": "#/components/schemas/ConnectorParameterSchema" }, { "type": "null" } ] }, "value": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "items": {}, "type": "array" }, { "type": "string" }, { "type": "boolean" }, { "type": "integer" }, { "type": "null" } ], "title": "Value" } }, "type": "object", "required": [ "parameter", "value" ], "title": "AccountConnectorOrConnectionOrStreamParameterSchema" }, "AccountConnectorSchema": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique source/destination instance identifier" }, "name": { "type": "string", "title": "Name", "description": "User-defined name for this source or destination" }, "connector": { "anyOf": [ { "$ref": "#/components/schemas/ConnectorSchema" }, { "type": "null" } ], "description": "The underlying connector type" }, "status": { "$ref": "#/components/schemas/AccountConnectorStatus", "description": "Current status (SETUP, AUTHENTICATED, LIVE)" }, "enabled": { "type": "boolean", "title": "Enabled" }, "records_read_last_30_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Records Read Last 30 Days", "default": 0 }, "records_failed_validation_last_30_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Records Failed Validation Last 30 Days", "default": 0 }, "records_produced_last_30_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Records Produced Last 30 Days", "default": 0 }, "credits_last_30_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Credits Last 30 Days", "default": 0 }, "last_run_start_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Run Start Time" }, "last_run_end_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Run End Time" }, "last_successful_run_end_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Successful Run End Time" }, "modified_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Modified At" }, "source_connections": { "items": { "$ref": "#/components/schemas/ConnectionSchema" }, "type": "array", "title": "Source Connections" }, "destination_connections": { "items": { "$ref": "#/components/schemas/ConnectionSchema" }, "type": "array", "title": "Destination Connections" }, "parameters": { "items": { "$ref": "#/components/schemas/AccountConnectorOrConnectionOrStreamParameterSchema" }, "type": "array", "title": "Parameters" }, "catalog_items": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AccountConnectorCatalogItemSchema" }, "type": "array" }, { "type": "null" } ], "title": "Catalog Items" } }, "type": "object", "required": [ "id", "name", "connector", "status", "enabled", "source_connections", "destination_connections", "parameters" ], "title": "AccountConnectorSchema" }, "AccountConnectorStatus": { "type": "string", "enum": [ "SETUP", "AUTHENTICATED", "LIVE", "ERROR", "REQUIRES_REAUTH" ], "title": "AccountConnectorStatus" }, "AccountPlanSchema": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "modified_at": { "type": "string", "format": "date-time", "title": "Modified At" }, "plan": { "anyOf": [ { "$ref": "#/components/schemas/PlanSchema" }, { "type": "null" } ] }, "status": { "$ref": "#/components/schemas/AccountPlanStatus" }, "start_date": { "type": "string", "format": "date", "title": "Start Date" }, "end_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "End Date" }, "payment_frequency": { "anyOf": [ { "$ref": "#/components/schemas/PaymentFrequency" }, { "type": "null" } ] }, "payment_method": { "anyOf": [ { "$ref": "#/components/schemas/PaymentMethod" }, { "type": "null" } ] }, "committed_monthly_credits": { "type": "integer", "title": "Committed Monthly Credits" }, "committed_cpm": { "type": "number", "title": "Committed Cpm" }, "overage_cpm": { "type": "number", "title": "Overage Cpm" }, "max_sources": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Sources" }, "max_destinations": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Destinations" }, "max_live_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Live Connections" }, "max_sync_frequency_minutes": { "type": "integer", "title": "Max Sync Frequency Minutes" }, "max_users": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Users" }, "sso": { "type": "boolean", "title": "Sso" }, "transformations": { "type": "boolean", "title": "Transformations" } }, "type": "object", "required": [ "id", "created_at", "modified_at", "status", "start_date", "end_date", "payment_frequency", "payment_method", "committed_monthly_credits", "committed_cpm", "overage_cpm", "max_sources", "max_destinations", "max_live_connections", "max_sync_frequency_minutes", "max_users", "sso", "transformations" ], "title": "AccountPlanSchema" }, "AccountPlanStatus": { "type": "string", "enum": [ "ACTIVATING", "ACTIVE", "PAYMENT_FAILED", "BLOCKED" ], "title": "AccountPlanStatus" }, "AccountSchema": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "status": { "$ref": "#/components/schemas/AccountStatus" }, "sources_creation_status": { "$ref": "#/components/schemas/AccountTaskStatus" }, "destinations_creation_status": { "$ref": "#/components/schemas/AccountTaskStatus" }, "connections_creation_status": { "$ref": "#/components/schemas/AccountTaskStatus" }, "has_successful_connection_runs": { "type": "boolean", "title": "Has Successful Connection Runs" }, "current_plan": { "anyOf": [ { "$ref": "#/components/schemas/AccountPlanSchema" }, { "type": "null" } ] }, "card_info": { "anyOf": [ { "$ref": "#/components/schemas/CardInformation" }, { "type": "null" } ] }, "singular_organization_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Singular Organization Id" }, "salesforce_account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Salesforce Account Id" } }, "type": "object", "required": [ "id", "name", "status", "sources_creation_status", "destinations_creation_status", "connections_creation_status", "has_successful_connection_runs", "singular_organization_id", "salesforce_account_id" ], "title": "AccountSchema" }, "AccountStatus": { "type": "string", "enum": [ "PENDING_VERIFICATION", "ACTIVE", "DISABLED" ], "title": "AccountStatus" }, "AccountTaskStatus": { "type": "string", "enum": [ "NOT_STARTED", "IN_PROGRESS", "COMPLETED" ], "title": "AccountTaskStatus" }, "ActionSchema": { "properties": { "send_slack_message": { "anyOf": [ { "$ref": "#/components/schemas/SendSlackMessageSchema" }, { "type": "null" } ] }, "send_email": { "anyOf": [ { "$ref": "#/components/schemas/SendEmailSchema" }, { "type": "null" } ] } }, "type": "object", "title": "ActionSchema" }, "AggregateUsageDateRange": { "type": "string", "enum": [ "current_billing_period", "last_30_days", "custom" ], "title": "AggregateUsageDateRange" }, "AggregateUsageSchema": { "properties": { "free_credits": { "type": "integer", "title": "Free Credits" }, "paid_credits": { "type": "integer", "title": "Paid Credits" }, "singular_credits": { "type": "integer", "title": "Singular Credits", "default": 0 }, "live_connections": { "type": "integer", "title": "Live Connections" }, "users": { "type": "integer", "title": "Users" }, "sources": { "type": "integer", "title": "Sources" }, "destinations": { "type": "integer", "title": "Destinations" } }, "type": "object", "required": [ "free_credits", "paid_credits", "live_connections", "users", "sources", "destinations" ], "title": "AggregateUsageSchema" }, "AvatarUploadResponse": { "properties": { "avatar": { "type": "string", "title": "Avatar" } }, "type": "object", "required": [ "avatar" ], "title": "AvatarUploadResponse" }, "Body_upload_avatar_users_me_avatar_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_avatar_users_me_avatar_post" }, "CPMCurveEntry": { "properties": { "min_credits": { "type": "integer", "title": "Min Credits" }, "max_credits": { "type": "integer", "title": "Max Credits" }, "cpm": { "type": "number", "title": "Cpm" }, "overage_cpm": { "type": "number", "title": "Overage Cpm" } }, "type": "object", "required": [ "min_credits", "max_credits", "cpm", "overage_cpm" ], "title": "CPMCurveEntry" }, "CardInformation": { "properties": { "id": { "type": "string", "title": "Id" }, "brand": { "type": "string", "title": "Brand" }, "last_4": { "type": "string", "title": "Last 4" }, "exp_month": { "type": "string", "title": "Exp Month" }, "exp_year": { "type": "string", "title": "Exp Year" } }, "type": "object", "required": [ "id", "brand", "last_4", "exp_month", "exp_year" ], "title": "CardInformation" }, "CaseSchema": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "trigger": { "anyOf": [ { "$ref": "#/components/schemas/TriggerSchema" }, { "type": "null" } ] }, "status": { "$ref": "#/components/schemas/CaseStatus" } }, "type": "object", "required": [ "id", "trigger", "status" ], "title": "CaseSchema" }, "CaseStatus": { "type": "string", "enum": [ "OPEN", "ASSIGNED", "RESOLVED" ], "title": "CaseStatus" }, "CatalogObjectSchema": { "properties": { "title": { "type": "string", "title": "Title" }, "properties": { "additionalProperties": { "$ref": "#/components/schemas/SchemaFieldSpec" }, "type": "object", "title": "Properties" }, "primary_key": { "items": { "type": "string" }, "type": "array", "title": "Primary Key" }, "extract_spec": { "$ref": "#/components/schemas/ExtractSpecSchema" }, "supported_diff_mode": { "anyOf": [ { "$ref": "#/components/schemas/DiffMode" }, { "type": "null" } ] }, "cursor_spec": { "$ref": "#/components/schemas/CursorSpecSchema" }, "parent_stream": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Stream" } }, "type": "object", "required": [ "title", "properties", "primary_key", "extract_spec", "cursor_spec" ], "title": "CatalogObjectSchema" }, "ChangePlanRequest": { "properties": { "plan_id": { "type": "string", "format": "uuid", "title": "Plan Id" }, "required_credits": { "type": "integer", "title": "Required Credits" } }, "type": "object", "required": [ "plan_id", "required_credits" ], "title": "ChangePlanRequest" }, "ConnectionRunSchema": { "properties": { "id": { "type": "string", "title": "Id" }, "connection_id": { "type": "string", "title": "Connection Id" }, "connection": { "anyOf": [ { "$ref": "#/components/schemas/ConnectionSchema" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "start_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start Time" }, "end_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Time" }, "status": { "$ref": "#/components/schemas/ConnectionRunStatus" }, "records_produced": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Records Produced", "default": 0 }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "run_type": { "$ref": "#/components/schemas/ConnectionRunType" }, "source_records_read": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Source Records Read" }, "source_records_failed_validation": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Source Records Failed Validation" }, "source_records_produced": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Source Records Produced" }, "destination_records_read": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Destination Records Read" }, "destination_records_failed_validation": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Destination Records Failed Validation" }, "destination_records_produced": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Destination Records Produced" }, "credits": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Credits" }, "streams": { "items": { "$ref": "#/components/schemas/StreamRunSchema" }, "type": "array", "title": "Streams" } }, "type": "object", "required": [ "id", "connection_id", "connection", "created_at", "start_time", "end_time", "status", "error_message", "run_type", "source_records_read", "source_records_failed_validation", "source_records_produced", "destination_records_read", "destination_records_failed_validation", "destination_records_produced", "credits", "streams" ], "title": "ConnectionRunSchema" }, "ConnectionRunStatus": { "type": "string", "enum": [ "PENDING", "STARTED", "SUCCESS", "PARTIAL_SUCCESS", "FAILURE", "CANCELLED" ], "title": "ConnectionRunStatus" }, "ConnectionRunType": { "type": "string", "enum": [ "MANUAL", "CUSTOM", "SCHEDULED", "FAILURE_RETRY" ], "title": "ConnectionRunType" }, "ConnectionSchedule": { "type": "string", "enum": [ "MANUAL", "HOURLY", "EVERY_2_HOURS", "EVERY_4_HOURS", "EVERY_6_HOURS", "EVERY_8_HOURS", "EVERY_12_HOURS", "DAILY", "CUSTOM" ], "title": "ConnectionSchedule" }, "ConnectionSchema": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique connection identifier" }, "source": { "anyOf": [ { "$ref": "#/components/schemas/AccountConnectorSchema" }, { "type": "null" } ], "description": "Source connector instance" }, "destination": { "anyOf": [ { "$ref": "#/components/schemas/AccountConnectorSchema" }, { "type": "null" } ], "description": "Destination connector instance" }, "alias": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alias", "description": "User-defined display name for the connection" }, "schedule": { "type": "string", "title": "Schedule", "description": "Schedule type (e.g. MANUAL, HOURLY, CUSTOM)" }, "cron_expression": { "type": "string", "title": "Cron Expression", "description": "Cron expression for custom schedules" }, "status": { "$ref": "#/components/schemas/ConnectionStatus", "description": "Current connection status" }, "enabled": { "type": "boolean", "title": "Enabled" }, "deleted": { "type": "boolean", "title": "Deleted" }, "next_scheduled": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Next Scheduled", "description": "Next scheduled run time" }, "next_retry": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Next Retry", "description": "Next retry time after a failure" }, "last_run_start_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Run Start Time" }, "last_run_end_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Run End Time" }, "last_successful_run_end_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Successful Run End Time" }, "source_records_read_last_30_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Source Records Read Last 30 Days", "default": 0 }, "source_records_failed_validation_last_30_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Source Records Failed Validation Last 30 Days", "default": 0 }, "source_records_produced_last_30_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Source Records Produced Last 30 Days", "default": 0 }, "destination_records_read_last_30_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Destination Records Read Last 30 Days", "default": 0 }, "destination_records_failed_validation_last_30_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Destination Records Failed Validation Last 30 Days", "default": 0 }, "destination_records_produced_last_30_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Destination Records Produced Last 30 Days", "default": 0 }, "credits_last_30_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Credits Last 30 Days", "default": 0 }, "runs": { "items": { "$ref": "#/components/schemas/ConnectionRunSchema" }, "type": "array", "title": "Runs" }, "streams": { "items": { "$ref": "#/components/schemas/StreamSchema" }, "type": "array", "title": "Streams" }, "data_contracts": { "items": { "$ref": "#/components/schemas/DataContractSchema" }, "type": "array", "title": "Data Contracts" }, "parameters": { "items": { "$ref": "#/components/schemas/AccountConnectorOrConnectionOrStreamParameterSchema" }, "type": "array", "title": "Parameters" } }, "type": "object", "required": [ "id", "source", "destination", "alias", "schedule", "cron_expression", "status", "enabled", "deleted", "runs", "streams", "data_contracts", "parameters" ], "title": "ConnectionSchema" }, "ConnectionStatus": { "type": "string", "enum": [ "SETUP", "LIVE", "ERROR", "DELETED" ], "title": "ConnectionStatus" }, "ConnectionUsageSchema": { "properties": { "usage_date": { "type": "string", "format": "date", "title": "Usage Date" }, "source_connector_name": { "type": "string", "title": "Source Connector Name" }, "destination_connector_name": { "type": "string", "title": "Destination Connector Name" }, "source_account_connector_name": { "type": "string", "title": "Source Account Connector Name" }, "destination_account_connector_name": { "type": "string", "title": "Destination Account Connector Name" }, "connection_created_at": { "type": "string", "format": "date-time", "title": "Connection Created At" }, "free_period_start": { "type": "string", "format": "date", "title": "Free Period Start" }, "paid_period_start": { "type": "string", "format": "date", "title": "Paid Period Start" }, "records": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Records" }, "free_credits": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Free Credits" }, "paid_credits": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Paid Credits" }, "singular_credits": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Singular Credits" } }, "type": "object", "required": [ "usage_date", "source_connector_name", "destination_connector_name", "source_account_connector_name", "destination_account_connector_name", "connection_created_at", "free_period_start", "paid_period_start", "records", "free_credits", "paid_credits" ], "title": "ConnectionUsageSchema" }, "ConnectorConnectionType": { "type": "string", "enum": [ "BATCH", "EVENT_STREAM" ], "title": "ConnectorConnectionType" }, "ConnectorParameterDataType": { "type": "string", "enum": [ "BOOLEAN", "CUSTOM_OBJECT_LIST", "DATE", "DATETIME", "FILTER", "CUSTOM_FILTER", "MAP", "SINGLE_VALUE", "MULTIPLE_VALUES", "NUMBER", "OAUTH", "STRING", "MULTILINE_STRING", "PASSWORD", "MULTILINE_PASSWORD", "TWO_FACTOR_PHONE", "EMAIL_ADDRESS", "STATIC", "CHECKBOX_GROUP", "COMBOBOX_GROUP", "ACCOUNT_ID", "SSH_KEY_PAIR" ], "title": "ConnectorParameterDataType" }, "ConnectorParameterSchema": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "display_name": { "type": "string", "title": "Display Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "type": { "$ref": "#/components/schemas/ConnectorParameterType" }, "data_type": { "$ref": "#/components/schemas/ConnectorParameterDataType" }, "optional": { "type": "boolean", "title": "Optional" }, "default_value": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "items": {}, "type": "array" }, { "type": "string" }, { "type": "boolean" }, { "type": "integer" }, { "type": "null" } ], "title": "Default Value" }, "possible_values": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Possible Values" }, "dynamic_possible_values": { "type": "boolean", "title": "Dynamic Possible Values" }, "requires_validation": { "type": "boolean", "title": "Requires Validation" }, "custom_object_parameters": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Custom Object Parameters" }, "conditionally_shown_by_paramater_and_value": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "integer" }, { "items": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "integer" } ] }, "type": "array" } ] }, "type": "object" }, { "type": "null" } ], "title": "Conditionally Shown By Paramater And Value" }, "order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order" }, "advanced": { "type": "boolean", "title": "Advanced", "default": false }, "required_for_login": { "type": "boolean", "title": "Required For Login", "default": false } }, "type": "object", "required": [ "id", "name", "display_name", "description", "type", "data_type", "optional", "default_value", "possible_values", "dynamic_possible_values", "requires_validation", "custom_object_parameters", "conditionally_shown_by_paramater_and_value", "order" ], "title": "ConnectorParameterSchema" }, "ConnectorParameterType": { "type": "string", "enum": [ "SYSTEM_WIDE", "ACCOUNT_CONNECTOR", "CONNECTION", "STREAM" ], "title": "ConnectorParameterType" }, "ConnectorSchema": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique connector identifier" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "modified_at": { "type": "string", "format": "date-time", "title": "Modified At" }, "name": { "type": "string", "title": "Name", "description": "Connector name (e.g. 'Google Ads', 'Snowflake')" }, "type": { "$ref": "#/components/schemas/ConnectorType", "description": "SOURCE or DESTINATION" }, "connection_type": { "$ref": "#/components/schemas/ConnectorConnectionType" }, "supported_load_modes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Supported Load Modes", "description": "Supported destination load modes" }, "categories": { "items": { "type": "string" }, "type": "array", "title": "Categories", "description": "Connector categories for grouping" }, "icon_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon Url", "description": "URL to the connector icon" }, "popularity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Popularity", "description": "Relative popularity score" }, "availability": { "type": "string", "title": "Availability", "description": "Availability status (e.g. 'GA', 'BETA')" }, "parameters": { "items": { "$ref": "#/components/schemas/ConnectorParameterSchema" }, "type": "array", "title": "Parameters", "description": "Configuration parameters for this connector" }, "docs_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Docs Uri", "description": "Link to connector documentation" } }, "type": "object", "required": [ "id", "created_at", "modified_at", "name", "type", "connection_type", "supported_load_modes", "categories", "icon_url", "availability", "parameters", "docs_uri" ], "title": "ConnectorSchema" }, "ConnectorType": { "type": "string", "enum": [ "SOURCE", "DESTINATION" ], "title": "ConnectorType" }, "ContactSalesRequest": { "properties": { "plan_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "string" } ], "title": "Plan Id" }, "required_credits": { "type": "integer", "title": "Required Credits" } }, "type": "object", "required": [ "plan_id", "required_credits" ], "title": "ContactSalesRequest" }, "CreateAccountConnectorRequest": { "properties": { "connector_id": { "type": "string", "title": "Connector Id" }, "name": { "type": "string", "title": "Name" }, "enabled": { "type": "boolean", "title": "Enabled" }, "parameters": { "additionalProperties": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "items": {}, "type": "array" }, { "type": "string" }, { "type": "boolean" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ] }, "type": "object", "title": "Parameters" } }, "type": "object", "required": [ "connector_id", "name", "enabled" ], "title": "CreateAccountConnectorRequest" }, "CreateConnectionRequest": { "properties": { "source_id": { "type": "string", "title": "Source Id" }, "destination_id": { "type": "string", "title": "Destination Id" } }, "type": "object", "required": [ "source_id", "destination_id" ], "title": "CreateConnectionRequest" }, "CreateRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "permissions": { "items": { "$ref": "#/components/schemas/FullPermissions" }, "type": "array", "title": "Permissions" } }, "type": "object", "required": [ "name", "description", "permissions" ], "title": "CreateRequest" }, "CreateTriggerRequest": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "trigger_type": { "type": "string", "const": "EVENT", "title": "Trigger Type" }, "name": { "type": "string", "title": "Name" }, "enabled": { "type": "boolean", "title": "Enabled" }, "rule": { "type": "string", "title": "Rule" }, "actions": { "items": { "$ref": "#/components/schemas/EditableActionSchema" }, "type": "array", "title": "Actions" } }, "type": "object", "required": [ "id", "trigger_type", "name", "enabled", "rule", "actions" ], "title": "CreateTriggerRequest" }, "CreateUserRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "email": { "type": "string", "format": "email", "title": "Email" }, "roles": { "items": { "type": "string" }, "type": "array", "title": "Roles" } }, "type": "object", "required": [ "name", "email" ], "title": "CreateUserRequest" }, "CursorSpecSchema": { "properties": { "cursor_field": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor Field" }, "cursor_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor Description" } }, "type": "object", "title": "CursorSpecSchema" }, "CustomRunParameters": { "properties": { "whitelist_stream_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Whitelist Stream Ids" }, "failure_retry": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Failure Retry" }, "starting_cursor": { "anyOf": [ { "$ref": "#/components/schemas/RunCursor" }, { "type": "null" } ] }, "ending_cursor": { "anyOf": [ { "$ref": "#/components/schemas/RunCursor" }, { "type": "null" } ] }, "source_parameter_overrides": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "items": {}, "type": "array" }, { "type": "string" }, { "type": "boolean" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ] }, "type": "object" }, { "type": "null" } ], "title": "Source Parameter Overrides" }, "destination_parameter_overrides": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "items": {}, "type": "array" }, { "type": "string" }, { "type": "boolean" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ] }, "type": "object" }, { "type": "null" } ], "title": "Destination Parameter Overrides" } }, "type": "object", "title": "CustomRunParameters" }, "DataContractSchema": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "primary_key": { "items": { "type": "string" }, "type": "array", "title": "Primary Key" }, "properties": { "additionalProperties": { "$ref": "#/components/schemas/SchemaFieldSpec" }, "type": "object", "title": "Properties" }, "connector_specific": { "additionalProperties": true, "type": "object", "title": "Connector Specific" } }, "type": "object", "required": [ "id", "name", "primary_key", "properties", "connector_specific" ], "title": "DataContractSchema" }, "DiffMode": { "type": "string", "enum": [ "Sorted" ], "title": "DiffMode", "description": "The mode in which the source can support diffing." }, "EditableActionSchema": { "properties": { "send_slack_message": { "anyOf": [ { "$ref": "#/components/schemas/SendSlackMessageSchema" }, { "type": "null" } ] }, "send_email": { "anyOf": [ { "$ref": "#/components/schemas/EditableSendEmailSchema" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "title": "EditableActionSchema" }, "EditableSendEmailSchema": { "properties": { "recipient": { "type": "string", "title": "Recipient" }, "recipient_mode": { "$ref": "#/components/schemas/SendEmailRecipientMode", "default": "STATIC" }, "message_subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message Subject" }, "message_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message Text" }, "included_event_properties": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Included Event Properties" } }, "additionalProperties": false, "type": "object", "required": [ "recipient" ], "title": "EditableSendEmailSchema" }, "EvaluateRequest": { "properties": { "expression": { "type": "string", "title": "Expression" }, "event_properties": { "additionalProperties": true, "type": "object", "title": "Event Properties" } }, "type": "object", "required": [ "expression", "event_properties" ], "title": "EvaluateRequest" }, "EventSchema": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "name": { "type": "string", "title": "Name" }, "properties": { "additionalProperties": true, "type": "object", "title": "Properties" }, "processed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Processed At" }, "triggers_matched": { "type": "integer", "title": "Triggers Matched" } }, "type": "object", "required": [ "id", "created_at", "name", "properties", "processed_at", "triggers_matched" ], "title": "EventSchema" }, "ExpandedUserSchema": { "properties": { "id": { "type": "string", "title": "Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "account": { "anyOf": [ { "$ref": "#/components/schemas/AccountSchema" }, { "type": "null" } ] }, "email": { "type": "string", "title": "Email" }, "name": { "type": "string", "title": "Name" }, "registered": { "type": "boolean", "title": "Registered" }, "enabled": { "type": "boolean", "title": "Enabled" }, "roles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RoleSchema" }, "type": "array" }, { "type": "null" } ], "title": "Roles" }, "onboarding_state": { "anyOf": [ { "$ref": "#/components/schemas/OnboardingStateSchema" }, { "type": "null" } ] }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar" }, "intercom_hash": { "type": "string", "title": "Intercom Hash" }, "is_singular_client": { "type": "boolean", "title": "Is Singular Client" } }, "type": "object", "required": [ "id", "created_at", "email", "name", "registered", "enabled", "avatar", "intercom_hash", "is_singular_client" ], "title": "ExpandedUserSchema" }, "ExportSourceMetadataRequest": { "properties": { "schema_filters": { "items": { "type": "string" }, "type": "array", "title": "Schema Filters" } }, "type": "object", "title": "ExportSourceMetadataRequest" }, "ExtractMode": { "type": "string", "enum": [ "FullRefresh", "IncrementalChanges", "Partition" ], "title": "ExtractMode", "description": "Our sources can support multiple extract modes:\n* Full Refresh - The source will fetch the entire data set. The cursor doesn't matter.\n* IncrementalChanges - The source will utilize the cursor and only fetch data that has been updated since that cursor.\n* Data Partition - the source is performing a full refresh for a set of dates (e.g. last 7 days). This is specifically designed for the data\n that updates retroactively (up to a certain point), where neither a full refresh nor incremental updates are suitable.\n\nEach catalog item in the source's catalog can define which extract modes are supported." }, "ExtractSpecSchema": { "properties": { "extract_mode": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "title": "Extract Mode" } }, "type": "object", "required": [ "extract_mode" ], "title": "ExtractSpecSchema" }, "FieldMapSpec": { "properties": { "type": { "type": "string", "title": "Type" }, "data_contract_field": { "type": "string", "title": "Data Contract Field" }, "apply_hashing": { "type": "boolean", "title": "Apply Hashing", "default": true }, "source_field_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Field Name" }, "static_value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Static Value" } }, "type": "object", "required": [ "type", "data_contract_field" ], "title": "FieldMapSpec" }, "FullPermissions": { "type": "string", "enum": [ "administrator", "billing", "creator", "viewer" ], "title": "FullPermissions" }, "GenerateSSHKeyResponse": { "properties": { "encrypted_private_key": { "type": "string", "title": "Encrypted Private Key" }, "public_key": { "type": "string", "title": "Public Key" } }, "type": "object", "required": [ "encrypted_private_key", "public_key" ], "title": "GenerateSSHKeyResponse" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "LoadMode": { "type": "string", "enum": [ "Append", "Replace", "Upsert", "History", "SoftDelete", "Replica" ], "title": "LoadMode", "description": "@see https://www.notion.so/gadie/Load-Extract-mode-naming-2cb3677e1e984f22a1d718e294d0f52d?pvs=4" }, "OnboardingStateResponse": { "properties": { "onboarding_state": { "$ref": "#/components/schemas/OnboardingStateSchema" } }, "type": "object", "required": [ "onboarding_state" ], "title": "OnboardingStateResponse" }, "OnboardingStateSchema": { "properties": { "help_center_seen": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Help Center Seen" } }, "type": "object", "title": "OnboardingStateSchema" }, "PaginatedResponse_EventSchema_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/EventSchema" }, "type": "array", "title": "Data" }, "total_count": { "type": "integer", "title": "Total Count" }, "limit": { "type": "integer", "title": "Limit" }, "offset": { "type": "integer", "title": "Offset" } }, "type": "object", "required": [ "data", "total_count", "limit", "offset" ], "title": "PaginatedResponse[EventSchema]" }, "PaymentFrequency": { "type": "integer", "enum": [ 12, 3, 1 ], "title": "PaymentFrequency" }, "PaymentMethod": { "type": "string", "enum": [ "CARD", "BANK_WIRE" ], "title": "PaymentMethod" }, "PlanSchema": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "version": { "type": "integer", "title": "Version" }, "available": { "type": "boolean", "title": "Available" }, "min_credits": { "type": "integer", "title": "Min Credits" }, "max_credits": { "type": "integer", "title": "Max Credits" }, "cpm_curve": { "items": { "$ref": "#/components/schemas/CPMCurveEntry" }, "type": "array", "title": "Cpm Curve" }, "max_sources": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Sources" }, "max_destinations": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Destinations" }, "max_live_connections": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Live Connections" }, "max_sync_frequency_minutes": { "type": "integer", "title": "Max Sync Frequency Minutes" }, "max_users": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Users" }, "sso": { "type": "boolean", "title": "Sso" }, "transformations": { "type": "boolean", "title": "Transformations" } }, "type": "object", "required": [ "id", "name", "version", "available", "min_credits", "max_credits", "cpm_curve", "max_sources", "max_destinations", "max_live_connections", "max_sync_frequency_minutes", "max_users", "sso", "transformations" ], "title": "PlanSchema" }, "RolePermissionSchema": { "properties": { "permission": { "$ref": "#/components/schemas/FullPermissions" } }, "type": "object", "required": [ "permission" ], "title": "RolePermissionSchema" }, "RoleSchema": { "properties": { "id": { "type": "string", "title": "Id" }, "account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Id" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "user_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "User Count" }, "users": { "anyOf": [ { "items": { "$ref": "#/components/schemas/UserSchema" }, "type": "array" }, { "type": "null" } ], "title": "Users" }, "permissions": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RolePermissionSchema" }, "type": "array" }, { "type": "null" } ], "title": "Permissions" } }, "type": "object", "required": [ "id", "account_id", "name", "description" ], "title": "RoleSchema" }, "RunCursor": { "properties": { "incremental_cursor_value": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Incremental Cursor Value" }, "date_partition_cursor_value": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date Partition Cursor Value" } }, "type": "object", "title": "RunCursor" }, "SchemaChangeType": { "type": "string", "enum": [ "stream_added", "stream_deleted", "field_added", "field_deleted", "field_selected", "field_deselected", "field_renamed" ], "title": "SchemaChangeType" }, "SchemaFieldSpec": { "properties": { "type": { "type": "string", "title": "Type" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Format" }, "maxLength": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Maxlength" }, "date_format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date Format" }, "timezone_included": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Timezone Included" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "optional": { "type": "boolean", "title": "Optional", "default": false }, "hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hash" }, "allowed_values": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Allowed Values" }, "items": { "anyOf": [ { "$ref": "#/components/schemas/SchemaFieldSpec" }, { "type": "null" } ] }, "properties": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/SchemaFieldSpec" }, "type": "object" }, { "type": "null" } ], "title": "Properties" }, "foreign_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Foreign Key" } }, "type": "object", "required": [ "type" ], "title": "SchemaFieldSpec" }, "SchemaFieldSpecOverride": { "properties": { "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Format" }, "date_format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date Format" }, "timezone_included": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Timezone Included" } }, "type": "object", "title": "SchemaFieldSpecOverride" }, "ScopedParameterRequest": { "properties": { "source": { "additionalProperties": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "items": {}, "type": "array" }, { "type": "string" }, { "type": "boolean" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ] }, "type": "object", "title": "Source" }, "destination": { "additionalProperties": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "items": {}, "type": "array" }, { "type": "string" }, { "type": "boolean" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ] }, "type": "object", "title": "Destination" } }, "additionalProperties": false, "type": "object", "title": "ScopedParameterRequest", "example": { "destination": { "schema": "example_schema" }, "source": { "apps_to_sync": [ "1234567890", "0987654321" ], "backfill": 3 } } }, "SendEmailRecipientMode": { "type": "string", "enum": [ "STATIC", "ACCOUNT_STAKEHOLDERS" ], "title": "SendEmailRecipientMode" }, "SendEmailSchema": { "properties": { "recipient": { "type": "string", "title": "Recipient" }, "recipient_mode": { "$ref": "#/components/schemas/SendEmailRecipientMode", "default": "STATIC" }, "message_subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message Subject" }, "message_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message Text" }, "included_event_properties": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Included Event Properties" } }, "type": "object", "required": [ "recipient" ], "title": "SendEmailSchema" }, "SendSlackMessageSchema": { "properties": { "account_connector_id": { "type": "string", "title": "Account Connector Id" }, "channel_id": { "type": "string", "title": "Channel Id" }, "message_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message Title" }, "message_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message Text" }, "message_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message Color" }, "included_event_properties": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Included Event Properties" } }, "type": "object", "required": [ "account_connector_id", "channel_id" ], "title": "SendSlackMessageSchema" }, "SlackChannel": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "id", "name" ], "title": "SlackChannel" }, "StreamRunSchema": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "stream": { "anyOf": [ { "$ref": "#/components/schemas/StreamSchema" }, { "type": "null" } ] }, "celery_task_id": { "type": "string", "title": "Celery Task Id" }, "source_start_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Source Start Time" }, "source_end_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Source End Time" }, "source_status": { "$ref": "#/components/schemas/StreamRunStatus" }, "source_error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Error Message" }, "source_records_read": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Source Records Read" }, "source_records_failed_validation": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Source Records Failed Validation" }, "source_records_produced": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Source Records Produced" }, "source_has_network_logs": { "type": "boolean", "title": "Source Has Network Logs" }, "destination_start_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Destination Start Time" }, "destination_end_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Destination End Time" }, "destination_status": { "$ref": "#/components/schemas/StreamRunStatus" }, "destination_error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Destination Error Message" }, "destination_records_read": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Destination Records Read" }, "destination_records_failed_validation": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Destination Records Failed Validation" }, "destination_records_produced": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Destination Records Produced" }, "destination_has_network_logs": { "type": "boolean", "title": "Destination Has Network Logs" }, "starting_cursor": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Starting Cursor" }, "ending_cursor": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Ending Cursor" } }, "type": "object", "required": [ "id", "stream", "celery_task_id", "source_start_time", "source_end_time", "source_status", "source_error_message", "source_records_read", "source_records_failed_validation", "source_records_produced", "source_has_network_logs", "destination_start_time", "destination_end_time", "destination_status", "destination_error_message", "destination_records_read", "destination_records_failed_validation", "destination_records_produced", "destination_has_network_logs", "starting_cursor", "ending_cursor" ], "title": "StreamRunSchema" }, "StreamRunStatus": { "type": "string", "enum": [ "PENDING", "STARTED", "SUCCESS", "FAILURE", "CANCELLED" ], "title": "StreamRunStatus" }, "StreamSchema": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "catalog_object": { "$ref": "#/components/schemas/CatalogObjectSchema" }, "deleted": { "type": "boolean", "title": "Deleted" }, "enabled_schema_fields": { "items": { "type": "string" }, "type": "array", "title": "Enabled Schema Fields" }, "sync_enabled": { "type": "boolean", "title": "Sync Enabled" }, "extract_mode": { "$ref": "#/components/schemas/ExtractMode" }, "apply_diff": { "type": "boolean", "title": "Apply Diff" }, "load_mode": { "$ref": "#/components/schemas/LoadMode" }, "last_run_start_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Run Start Time" }, "cursor": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Cursor" }, "data_contract_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Data Contract Id" }, "field_map": { "items": { "$ref": "#/components/schemas/FieldMapSpec" }, "type": "array", "title": "Field Map" }, "schema_changes": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StreamSchemaChangeSchema" }, "type": "array" }, { "type": "null" } ], "title": "Schema Changes" }, "parameters": { "items": { "$ref": "#/components/schemas/AccountConnectorOrConnectionOrStreamParameterSchema" }, "type": "array", "title": "Parameters" } }, "type": "object", "required": [ "id", "name", "catalog_object", "deleted", "enabled_schema_fields", "sync_enabled", "extract_mode", "apply_diff", "load_mode", "cursor", "data_contract_id", "field_map", "parameters" ], "title": "StreamSchema" }, "StreamSchemaChangeSchema": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "schema_change_type": { "$ref": "#/components/schemas/SchemaChangeType" }, "field_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Field Name" }, "new_field_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "New Field Name" }, "handled": { "type": "boolean", "title": "Handled" }, "applied": { "type": "boolean", "title": "Applied" } }, "type": "object", "required": [ "id", "created_at", "schema_change_type", "field_name", "new_field_name", "handled", "applied" ], "title": "StreamSchemaChangeSchema" }, "TriggerSchema": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "trigger_type": { "$ref": "#/components/schemas/TriggerType", "description": "Type of trigger (e.g. EVENT, SCHEDULE)" }, "name": { "type": "string", "title": "Name", "description": "User-defined trigger name" }, "enabled": { "type": "boolean", "title": "Enabled" }, "rule": { "type": "string", "title": "Rule", "description": "Automator expression that determines when this trigger fires" }, "actions": { "items": { "$ref": "#/components/schemas/ActionSchema" }, "type": "array", "title": "Actions", "description": "Actions to execute when the trigger fires" }, "is_system": { "type": "boolean", "title": "Is System", "default": false }, "threshold_pct": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Threshold Pct" }, "last_trigger": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Trigger", "description": "When this trigger last fired" }, "times_triggered": { "type": "integer", "title": "Times Triggered", "description": "Total number of times this trigger has fired" } }, "type": "object", "required": [ "id", "trigger_type", "name", "enabled", "rule", "actions", "last_trigger", "times_triggered" ], "title": "TriggerSchema" }, "TriggerType": { "type": "string", "enum": [ "EVENT", "DATA" ], "title": "TriggerType" }, "UpdateAccountConnectorCatalogItemRequest": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "field_overrides": { "additionalProperties": { "$ref": "#/components/schemas/SchemaFieldSpecOverride" }, "type": "object", "title": "Field Overrides" } }, "type": "object", "required": [ "id", "field_overrides" ], "title": "UpdateAccountConnectorCatalogItemRequest" }, "UpdateAccountConnectorCatalogRequest": { "properties": { "items": { "items": { "$ref": "#/components/schemas/UpdateAccountConnectorCatalogItemRequest" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "UpdateAccountConnectorCatalogRequest" }, "UpdateAccountConnectorRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "enabled": { "type": "boolean", "title": "Enabled" }, "parameters": { "additionalProperties": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "items": {}, "type": "array" }, { "type": "string" }, { "type": "boolean" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ] }, "type": "object", "title": "Parameters" } }, "type": "object", "required": [ "name", "enabled" ], "title": "UpdateAccountConnectorRequest" }, "UpdateConnectionRequest": { "properties": { "alias": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alias" }, "enabled": { "type": "boolean", "title": "Enabled" }, "schedule": { "$ref": "#/components/schemas/ConnectionSchedule" }, "cron_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cron Expression" }, "parameters": { "$ref": "#/components/schemas/ScopedParameterRequest" }, "streams": { "items": { "$ref": "#/components/schemas/UpdateStreamRequest" }, "type": "array", "title": "Streams" } }, "type": "object", "required": [ "alias", "enabled", "schedule", "cron_expression", "streams" ], "title": "UpdateConnectionRequest", "example": { "alias": "", "cron_expression": "0 0 * * *", "enabled": true, "parameters": { "destination": { "schema": "example_schema" }, "source": { "apps_to_sync": [ "1234567890", "0987654321", "5555555555" ], "backfill": 3 } }, "schedule": "DAILY", "streams": [ { "apply_diff": false, "cursor": { "date_partition_cursor_value": "2026-04-16" }, "enabled_schema_fields": [ "date", "app_name", "counts" ], "extract_mode": "Partition", "field_map": [], "id": "4d9b25e0-b73b-4dc6-9b16-e417cd970814", "load_mode": "Replace", "parameters": { "destination": {}, "source": {} }, "sync_enabled": true } ] } }, "UpdateRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "permissions": { "items": { "$ref": "#/components/schemas/FullPermissions" }, "type": "array", "title": "Permissions" } }, "type": "object", "required": [ "name", "description", "permissions" ], "title": "UpdateRequest" }, "UpdateStreamRequest": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "enabled_schema_fields": { "items": { "type": "string" }, "type": "array", "title": "Enabled Schema Fields" }, "sync_enabled": { "type": "boolean", "title": "Sync Enabled" }, "extract_mode": { "type": "string", "title": "Extract Mode" }, "apply_diff": { "type": "boolean", "title": "Apply Diff" }, "load_mode": { "type": "string", "title": "Load Mode" }, "cursor": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Cursor" }, "data_contract_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Data Contract Id" }, "field_map": { "items": { "$ref": "#/components/schemas/FieldMapSpec" }, "type": "array", "title": "Field Map" }, "parameters": { "$ref": "#/components/schemas/ScopedParameterRequest" } }, "type": "object", "required": [ "id", "enabled_schema_fields", "sync_enabled", "extract_mode", "apply_diff", "load_mode", "cursor", "data_contract_id", "field_map" ], "title": "UpdateStreamRequest", "example": { "apply_diff": false, "cursor": { "date_partition_cursor_value": "2026-04-16" }, "enabled_schema_fields": [ "date", "app_name", "counts" ], "extract_mode": "Partition", "field_map": [], "id": "4d9b25e0-b73b-4dc6-9b16-e417cd970814", "load_mode": "Replace", "parameters": { "destination": {}, "source": {} }, "sync_enabled": true } }, "UpdateTriggerRequest": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "trigger_type": { "$ref": "#/components/schemas/TriggerType" }, "name": { "type": "string", "title": "Name" }, "enabled": { "type": "boolean", "title": "Enabled" }, "rule": { "type": "string", "title": "Rule" }, "actions": { "items": { "$ref": "#/components/schemas/UpdateableActionSchema" }, "type": "array", "title": "Actions" } }, "type": "object", "required": [ "id", "trigger_type", "name", "enabled", "rule", "actions" ], "title": "UpdateTriggerRequest" }, "UpdateUserRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "email": { "type": "string", "title": "Email" }, "registered": { "type": "boolean", "title": "Registered" }, "enabled": { "type": "boolean", "title": "Enabled" }, "currentPassword": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currentpassword" }, "newPassword": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Newpassword" }, "confirmNewPassword": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Confirmnewpassword" }, "roles": { "items": { "type": "string" }, "type": "array", "title": "Roles" } }, "type": "object", "required": [ "name", "email", "registered", "enabled", "roles" ], "title": "UpdateUserRequest" }, "UpdateableActionSchema": { "properties": { "send_slack_message": { "anyOf": [ { "$ref": "#/components/schemas/SendSlackMessageSchema" }, { "type": "null" } ] }, "send_email": { "anyOf": [ { "$ref": "#/components/schemas/UpdateableSendEmailSchema" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "title": "UpdateableActionSchema" }, "UpdateableSendEmailSchema": { "properties": { "recipient": { "type": "string", "title": "Recipient", "default": "" }, "recipient_mode": { "$ref": "#/components/schemas/SendEmailRecipientMode", "default": "STATIC" }, "message_subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message Subject" }, "message_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message Text" }, "included_event_properties": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Included Event Properties" } }, "additionalProperties": false, "type": "object", "title": "UpdateableSendEmailSchema" }, "UserSchema": { "properties": { "id": { "type": "string", "title": "Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "account": { "anyOf": [ { "$ref": "#/components/schemas/AccountSchema" }, { "type": "null" } ] }, "email": { "type": "string", "title": "Email" }, "name": { "type": "string", "title": "Name" }, "registered": { "type": "boolean", "title": "Registered" }, "enabled": { "type": "boolean", "title": "Enabled" }, "roles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RoleSchema" }, "type": "array" }, { "type": "null" } ], "title": "Roles" }, "onboarding_state": { "anyOf": [ { "$ref": "#/components/schemas/OnboardingStateSchema" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "created_at", "email", "name", "registered", "enabled" ], "title": "UserSchema" }, "UserSchemaWithMeTagged": { "properties": { "id": { "type": "string", "title": "Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "account": { "anyOf": [ { "$ref": "#/components/schemas/AccountSchema" }, { "type": "null" } ] }, "email": { "type": "string", "title": "Email" }, "name": { "type": "string", "title": "Name" }, "registered": { "type": "boolean", "title": "Registered" }, "enabled": { "type": "boolean", "title": "Enabled" }, "roles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RoleSchema" }, "type": "array" }, { "type": "null" } ], "title": "Roles" }, "onboarding_state": { "anyOf": [ { "$ref": "#/components/schemas/OnboardingStateSchema" }, { "type": "null" } ] }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar" }, "me": { "type": "boolean", "title": "Me" } }, "type": "object", "required": [ "id", "created_at", "email", "name", "registered", "enabled", "avatar", "me" ], "title": "UserSchemaWithMeTagged" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "ValidationRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "value": { "title": "Value" } }, "type": "object", "required": [ "name", "value" ], "title": "ValidationRequest" }, "ValidationResult": { "properties": { "success": { "type": "boolean", "title": "Success" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" } }, "type": "object", "required": [ "success", "error" ], "title": "ValidationResult" } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "tags": [ { "name": "Connections", "description": "Manage data pipeline connections, their runs, and catalogs." }, { "name": "Connectors", "description": "Browse available source and destination connector types." }, { "name": "Sources & Destinations", "description": "Configure account-level source and destination instances." }, { "name": "Automation", "description": "Scheduling triggers and event-based automation rules." }, { "name": "Users", "description": "Manage users in your account." }, { "name": "Roles & Permissions", "description": "Role-based access control." }, { "name": "Billing", "description": "View plans and credit usage." } ], "security": [ { "bearerAuth": [] } ] }