Sweep

Sweep Automations API

The Automations API from Sweep — 43 operation(s) for automations.

GitHub OpenAPI

Operations 48

GET /automations Automation controller get automations #
POST /automations Automation controller create automation #
GET /automations/{automationId} Automation controller get automation by id #
DELETE /automations/{automationId} Automation controller delete automation #
GET /automations/{automationId}/history Automation controller get version history #
POST /automations/read-only Automation controller create read only automation #
POST /automations/alerts Automation controller create alert #
POST /automations/marketing-attributions Automation controller create marketing attribution #
POST /automations/marketing-attributions/templates Automation controller create marketing attribution templates #
POST /automations/assignments Automation controller create assignment #
POST /automations/dedupe-matching Automation controller create dedupe or matching #
POST /automations/ai-create Automation controller create automation with ai #
PUT /automations/{automationId}/{versionId} Automation controller edit automation #
PUT /automations/alerts/{automationId}/{versionId} Automation controller edit alert #
PUT /automations/marketing-attributions/{automationId}/{versionId} Automation controller edit marketing attribution #
PUT /automations/assignments/{automationId}/{versionId} Automation controller edit assignment #
PUT /automations/dedupe-matching/{automationId}/{versionId} Automation controller edit dedupe or matching #
POST /automations/deployment/{automationId}/{versionId} Automation controller deploy automation #
POST /automations/alerts/deployment/{automationId}/{versionId} Automation controller deploy alert #
POST /automations/marketing-attributions/deployment/{automationId}/{versionId} Automation controller deploy marketing attribution #
POST /automations/assignments/deployment/{automationId}/{versionId} Automation controller deploy assignment #
POST /automations/dedupe-matching/deployment/{automationId}/{versionId} Automation controller deploy dedupe or matching #
POST /automations/ai-impact-analysis-chat Automation controller create automation ai impact analysis chat #
POST /automations/assignments/ai-impact-analysis-chat Automation controller create assignment ai impact analysis chat #
PATCH /automations/activation/{automationId}/{versionId} Automation controller toggle activation #
PATCH /automations/alerts/activation/{automationId}/{versionId} Automation controller toggle alert activation #
PATCH /automations/assignments/activation/{automationId}/{versionId} Automation controller toggle assignment activation #
PATCH /automations/dedupe-matching/activation/{automationId}/{versionId} Automation controller toggle dedupe or matching activation #
PATCH /automations/admin-notification/{automationId}/{versionId} Automation controller notify admin on automation #
PATCH /automations/alerts/admin-notification/{automationId}/{versionId} Automation controller notify admin on alert #
PATCH /automations/assignments/admin-notification/{automationId}/{versionId} Automation controller notify admin on assignment #
PATCH /automations/dedupe-matching/admin-notification/{automationId}/{versionId} Automation controller notify admin on dedupe or matching #
DELETE /automations/alerts/{automationId} Automation controller delete alert #
DELETE /automations/assignments/{automationId} Automation controller delete assignment #
DELETE /automations/marketing-attributions/{automationId} Automation controller delete marketing attribution #
DELETE /automations/dedupe-matching/{automationId} Automation controller delete dedupe or matching #
POST /automations/booking Automation controller create booking #
PUT /automations/booking/{automationId}/{versionId} Automation controller edit booking #
POST /automations/booking/deployment/{automationId}/{versionId} Automation controller deploy booking #
PATCH /automations/booking/activation/{automationId}/{versionId} Automation controller toggle booking activation #
DELETE /automations/booking/{automationId} Automation controller delete booking #
PATCH /automations/booking/admin-notification/{automationId}/{versionId} Automation controller notify admin on booking #
GET /automations/order/Default Automation controller list automations execution order #
POST /automations/order/Default Automation controller deploy automations execution order #
GET /automations/order/Alert Automation controller list alerts execution order #
POST /automations/order/Alert Automation controller deploy alerts execution order #
GET /automations/order/Assignment Automation controller list assignments execution order #
POST /automations/order/Assignment Automation controller deploy assignments execution order #

Documentation

📖
APIReference
https://api.sweep.io/api
📖
Authentication
https://artifacts.apis.io/sweep/authentication/sweep-authentication.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/sweep/openapi/sweep-automations-api-openapi.yml

Other Resources

🔗
Conventions
https://artifacts.apis.io/sweep/conventions/sweep-conventions.yml
🔗
DataModel
https://artifacts.apis.io/sweep/data-model/sweep-data-model.yml
🔗
ErrorCatalog
https://artifacts.apis.io/sweep/errors/sweep-problem-types.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/sweep:sweep-automations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sweep-automations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sweep Automations API
  description: This is a publicly available Sweep API.
  version: '0.1'
  contact: {}
servers:
- url: https://api.sweep.io
  description: Sweep production API — the host this document was harvested from (GET /api-json); /health responds here
tags:


# --- truncated at 32 KB (43 KB total) ---
# Full source: https://artifacts.apis.io/sweep/openapi/sweep-automations-api-openapi.yml