Sweep API
Sweep's public REST API — the contract behind the Sweep agentic workspace. 698 operations across 591 paths covering CRM org connection and metadata (Salesforce, HubSpot, Snowflake, ServiceNow, Workato, Data360), the documentation platform (element search, dependencies, dependents, summaries, source and per-element chat), AI retrievers and AI agents, automations, funnels and funnel maps, assignment groups, territories, rollups, scheduling, campaigns, deployments, projects, comments and MCP connectors. Bearer JWT authentication; JSON request and response bodies; served from api.sweep.io with a public Swagger UI at /api and the machine-readable document at /api-json.
Documentation
APIReference
https://api.sweep.io/api
Authentication
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/authentication/sweep-authentication.yml
Specifications
Other Resources
Conventions
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/conventions/sweep-conventions.yml
DataModel
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/data-model/sweep-data-model.yml
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/errors/sweep-problem-types.yml
Overlay
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/overlays/sweep-api-overlay.yaml
APIsJSON
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/apis.yml