Extract API

This static API reference is generated from the public OpenAPI specification so non-JavaScript clients and AI fetchers can read the API surface. The interactive API explorer loads for browsers with JavaScript enabled.

Download the OpenAPI JSON specification

Version: 1.0.0

Automation

• POST /automation/evaluate_automator_rule - Evaluate automation rule

  Operation ID: evaluate_automator_rule_automation_evaluate_automator_rule_post | Request body: required EvaluateRequest | Responses: 200, 422

• GET /automation/events - List events

  Operation ID: list_events_automation_events_get | Parameters: query: limit, query: offset | Responses: 200, 422

• GET /automation/triggers - List triggers

  Operation ID: list_triggers_automation_triggers_get | Parameters: query: include_system | Responses: 200, 422

• POST /automation/triggers - Create trigger

  Operation ID: create_trigger_automation_triggers_post | Request body: required CreateTriggerRequest | Responses: 201, 422

• GET /automation/triggers/{trigger_id} - Get trigger

  Operation ID: get_trigger_automation_triggers__trigger_id__get | Parameters: path: trigger_id required | Responses: 200, 422

• POST /automation/triggers/{trigger_id} - Update trigger

  Operation ID: update_trigger_automation_triggers__trigger_id__post | Parameters: path: trigger_id required | Request body: required UpdateTriggerRequest | Responses: 200, 422

• DELETE /automation/triggers/{trigger_id} - Delete trigger

  Operation ID: delete_trigger_automation_triggers__trigger_id__delete | Parameters: path: trigger_id required | Responses: 204, 422

• GET /automation/cases - List cases

  Operation ID: list_cases_automation_cases_get | Responses: 200

• GET /automation/cases/{case_id} - Get case

  Operation ID: get_case_automation_cases__case_id__get | Parameters: path: case_id required | Responses: 200, 422

• POST /automation/cases/{case_id} - Update case status

  Operation ID: update_case_status_automation_cases__case_id__post | Parameters: path: case_id required, query: status required | Responses: 200, 422

• GET /automation/slack_channels/{account_connector_id} - List Slack channels

  Operation ID: get_slack_channels_automation_slack_channels__account_connector_id__get | Parameters: path: account_connector_id required | Responses: 200, 422

Billing

• GET /billing/plans - Get Plans

  Operation ID: get_plans_billing_plans_get | Responses: 200

• GET /billing/usage/aggregated - Get Aggregated Usage

  Operation ID: get_aggregated_usage_billing_usage_aggregated_get | Parameters: query: date_range, query: start_date, query: end_date | Responses: 200, 422

• GET /billing/usage/connection-usage - Get Connection Usage

  Operation ID: get_connection_usage_billing_usage_connection_usage_get | Parameters: query: start_date required, query: end_date required | Responses: 200, 422

Connections

• GET /connections - List connections

  Operation ID: list_connections_connections_get | Responses: 200

• POST /connections - Create connection

  Operation ID: create_connection_connections_post | Parameters: query: date_range, query: start_date, query: end_date | Request body: required CreateConnectionRequest | Responses: 201, 422

• GET /connections/{connection_id} - Get connection

  Operation ID: get_connection_connections__connection_id__get | Parameters: path: connection_id required | Responses: 200, 422

• POST /connections/{connection_id} - Update connection

  Operation ID: update_connection_connections__connection_id__post | Parameters: path: connection_id required | Request body: required UpdateConnectionRequest | Responses: 200, 422

• DELETE /connections/{connection_id} - Delete connection

  Operation ID: delete_connection_connections__connection_id__delete | Parameters: path: connection_id required | Responses: 204, 422

• GET /connections/{connection_id}/runs - List connection runs

  Operation ID: get_connection_runs_connections__connection_id__runs_get | Parameters: path: connection_id required | Responses: 200, 422

• GET /connections/{connection_id}/runs/{connection_run_id}/stream_runs - List stream runs

  Operation ID: connection_run_stream_runs_connections__connection_id__runs__connection_run_id__stream_runs_get | Parameters: path: connection_id required, path: connection_run_id required, query: cross_account | Responses: 200, 422

• POST /connections/{connection_id}/run - Trigger connection run

  Operation ID: run_connection_connections__connection_id__run_post | Parameters: path: connection_id required | Request body: optional CustomRunParameters | null | Responses: 200, 422

• POST /connections/{connection_run_id}/stop - Stop connection run

  Operation ID: stop_connection_connections__connection_run_id__stop_post | Parameters: path: connection_run_id required | Responses: 200, 422

• POST /connections/{connection_id}/update_catalog - Refresh connection catalog

  Operation ID: update_catalog_connections__connection_id__update_catalog_post | Parameters: path: connection_id required | Responses: 200, 422

Connectors

• GET /connectors - List connectors

  Operation ID: list_connectors_connectors_get | Responses: 200

• GET /connectors/{connector_type}/{connector_name} - Get connector

  Operation ID: get_connector_connectors__connector_type___connector_name__get | Parameters: path: connector_type required, path: connector_name required | Responses: 200, 422

Roles & Permissions

• GET /roles - List Roles

  Operation ID: list_roles_roles_get | Responses: 200

• POST /roles - Create Role

  Operation ID: create_role_roles_post | Request body: required CreateRequest | Responses: 201, 422

• GET /roles/{role_id} - Get Role

  Operation ID: get_role_roles__role_id__get | Parameters: path: role_id required | Responses: 200, 422

• POST /roles/{role_id} - Update Role

  Operation ID: update_role_roles__role_id__post | Parameters: path: role_id required | Request body: required UpdateRequest | Responses: 200, 422

• DELETE /roles/{role_id} - Delete Role

  Operation ID: delete_role_roles__role_id__delete | Parameters: path: role_id required | Responses: 204, 422

• POST /roles/{role_id}/users/{user_id} - Add User To Role

  Operation ID: add_user_to_role_roles__role_id__users__user_id__post | Parameters: path: role_id required, path: user_id required | Responses: 200, 422

• DELETE /roles/{role_id}/users/{user_id} - Remove User From Role

  Operation ID: remove_user_from_role_roles__role_id__users__user_id__delete | Parameters: path: role_id required, path: user_id required | Responses: 204, 422

Sources & Destinations

• POST /account_connectors/generate_ssh_key - Generate SSH key pair

  Operation ID: generate_ssh_key_account_connectors_generate_ssh_key_post | Responses: 200

• GET /account_connectors - List sources and destinations

  Operation ID: list_account_connectors_account_connectors_get | Parameters: query: connector_type, query: connector_name | Responses: 200, 422

• POST /account_connectors - Create source or destination

  Operation ID: create_account_connector_account_connectors_post | Parameters: query: date_range, query: start_date, query: end_date | Request body: required CreateAccountConnectorRequest | Responses: 201, 422

• GET /account_connectors/{connector_type}/{account_connector_id} - Get source or destination

  Operation ID: get_account_connector_account_connectors__connector_type___account_connector_id__get | Parameters: path: connector_type required, path: account_connector_id required | Responses: 200, 422

• POST /account_connectors/{account_connector_id}/catalog - Update catalog field overrides

  Operation ID: update_account_connector_catalog_account_connectors__account_connector_id__catalog_post | Parameters: path: account_connector_id required | Request body: required UpdateAccountConnectorCatalogRequest | Responses: 200, 422

• POST /account_connectors/{account_connector_id} - Update source or destination

  Operation ID: update_account_connector_account_connectors__account_connector_id__post | Parameters: path: account_connector_id required | Request body: required UpdateAccountConnectorRequest | Responses: 200, 422

• DELETE /account_connectors/{account_connector_id} - Delete source or destination

  Operation ID: delete_account_connector_account_connectors__account_connector_id__delete | Parameters: path: account_connector_id required | Responses: 204, 422

• POST /account_connectors/{account_connector_id}/login - Authenticate source or destination

  Operation ID: login_account_connectors__account_connector_id__login_post | Parameters: path: account_connector_id required | Responses: 200, 422

• POST /account_connectors/{account_connector_id}/source_tasks/export_metadata - Export source metadata

  Operation ID: export_account_connector_source_metadata_account_connectors__account_connector_id__source_tasks_export_metadata_post | Parameters: path: account_connector_id required | Request body: optional ExportSourceMetadataRequest | null | Responses: 200, 422

• GET /account_connectors/{account_connector_id}/dynamic_possible_values/{parameter_name} - Get dynamic parameter values

  Operation ID: get_dynamic_possible_values_account_connectors__account_connector_id__dynamic_possible_values__parameter_name__get | Parameters: path: parameter_name required, path: account_connector_id required | Responses: 200, 422

• POST /account_connectors/{account_connector_id}/validate_parameter - Validate parameter value

  Operation ID: validate_parameter_account_connectors__account_connector_id__validate_parameter_post | Parameters: path: account_connector_id required | Request body: required ValidationRequest | Responses: 200, 422

Users

• GET /users - List Users

  Operation ID: list_users_users_get | Responses: 200

• POST /users - Create User

  Operation ID: create_user_users_post | Parameters: query: date_range, query: start_date, query: end_date | Request body: required CreateUserRequest | Responses: 201, 422

• GET /users/me - Get Me

  Operation ID: get_me_users_me_get | Responses: 200

• GET /users/{user_id} - Get User

  Operation ID: get_user_users__user_id__get | Parameters: path: user_id required | Responses: 200, 422

• POST /users/{user_id} - Update Update

  Operation ID: update_update_users__user_id__post | Parameters: path: user_id required | Request body: required UpdateUserRequest | Responses: 200, 422

• DELETE /users/{user_id} - Delete User

  Operation ID: delete_user_users__user_id__delete | Parameters: path: user_id required | Responses: 204, 422

• POST /users/me/avatar - Upload Avatar

  Operation ID: upload_avatar_users_me_avatar_post | Responses: 200, 422

• PUT /users/me/onboarding-state - Update Onboarding State

  Operation ID: update_onboarding_state_users_me_onboarding_state_put | Request body: required OnboardingStateSchema | Responses: 200, 422