Skip to Content
Welcome to 10ex Docs — explore Tutorials, Guides, Reference, Concepts, Use Cases, and the Agent Store.
ReferenceREST APIconnectors
Reference

connectors

Base path: /api/v1/connectors

The connectors module is how you wire 10ex to the rest of your stack. It handles the provider catalog, OAuth start and callback, status polling, BYOK (bring your own key) submission, and per-workspace connector config. Common connectors include Gmail, Outlook, Webflow, Sanity, Google Ads, LinkedIn Ads, Meta Ads, HubSpot, and Salesforce. Each connector plays a role (source, sink, primary data source, CRM sink) that downstream agents and flows use to pick the right pipe. Schemas live in app/modules/connectors/schemas.py.

What you can do with the connectors API

  • List supported providers and the connectors you’ve already configured
  • Kick off an OAuth grant and receive the redirect URL
  • Poll an in-flight OAuth grant until the user completes it
  • Submit a BYOK API key (for providers without OAuth)
  • Update connector role assignments (e.g., promote a CRM sink to primary)
  • Disable or delete a connector when rotating credentials

Common operations

  • List configured connectors with their health and last-checked timestamps
  • Start an OAuth flow and capture the resulting redirect URL
  • Refresh or revoke a connector
  • Test a connector by triggering a lightweight read (mailbox header fetch, ad account ping)
  • Update per-connector settings (sender alias, default labels, ad account ID)

Authentication & scoping

Workspace-scoped via API key in the Authorization: Bearer tnx_... header. Connector secrets are encrypted at rest and never returned in responses; only metadata and status come back.

Pagination & filtering

List endpoints support filtering by provider, role, and status. See Pagination.

How connector OAuth works end to end

You call start_oauth to get a redirect URL. The user completes consent in their browser. The provider redirects back to 10ex, which stores the tokens server-side. Your client polls get_status until the grant resolves. From that point on, agents and flows can use the connector by ID.

MCP equivalents

MCP prompt

list_connectors()

MCP prompt

start_connector_oauth({ provider: "gmail" })

MCP prompt

get_connector_status({ connector_id })

Last updated on
crmmarketing