Sweep

Sweep Backoffice API

The Backoffice API from Sweep — 67 operation(s) for backoffice.

GitHub OpenAPI

Operations 75

GET /backoffice/accounts Backoffice controller get all accounts #
POST /backoffice/accounts Backoffice controller update accounts many #
GET /backoffice/users Backoffice controller get all users #
GET /backoffice/accounts/installed-packages Backoffice controller get installed packages for free accounts #
POST /backoffice/accounts/{accountId} Backoffice controller release account #
GET /backoffice/crm_orgs/{crmOrgId}/sweep_transactions_log Backoffice controller get sweep transactions log #
GET /backoffice/crm_orgs/{crmOrgId}/fetch Backoffice controller fetch #
POST /backoffice/crm_orgs/{orgId}/force-refresh-token Backoffice controller force refresh token #
POST /backoffice/crm_orgs/{orgId}/force-refresh-user-token Backoffice controller force refresh user token #
GET /backoffice/crm_orgs/all/get_soql Backoffice controller get any soql query all orgs #
GET /backoffice/ai_agents/{agentId}/trigger_scan Backoffice controller trigger scan #
GET /backoffice/crm_orgs/{crmOrgId}/get_soql Backoffice controller get any soql query #
GET /backoffice/accounts/{accountId}/crm_orgs Backoffice controller get all crm orgs #
GET /backoffice/accounts/{accountId}/orgs Backoffice controller get all orgs #
POST /backoffice/orgs/{orgId}/fetch Backoffice controller fetch any org #
GET /backoffice/orgs/{orgId}/metadata-search Backoffice controller search org metadata #
GET /backoffice/orgs/{orgId} Backoffice controller get org by id #
POST /backoffice/snowflake-orgs/{orgId}/query Backoffice controller run snowflake query #
GET /backoffice/crm-orgs/{crmOrgId} Backoffice controller get crm org by id #
POST /backoffice/crm_orgs/{crmOrgId}/salesforce-event-monitoring-log-export Backoffice controller export salesforce event monitoring logs #
PUT /backoffice/crm-orgs/{crmOrgId}/tier Backoffice controller update crm org tier #
POST /backoffice/parse-all Backoffice controller parse all orgs #
POST /backoffice/housekeeping/purge-salto-workspaces Backoffice controller archive all salto workspaces #
POST /backoffice/recovery/init-missing-bare-repos Backoffice controller recover missing bare repos #
POST /backoffice/ai-projects/backfill-origin-template-ids Backoffice controller backfill playbook origin template ids #
POST /backoffice/accounts/{accountId}/invite Backoffice controller invite user to account #
GET /backoffice/accounts/{accountId}/users Backoffice controller get users by account #
GET /backoffice/accounts/{accountId}/roles Backoffice controller get role groups for account #
PUT /backoffice/users/{userId}/role Backoffice controller update user role #
DELETE /backoffice/users/{userId} Backoffice controller remove user #
POST /backoffice/accounts/{accountId}/move-user Backoffice controller move user to account #
GET /backoffice/crm-orgs/{crmOrgId}/automations Backoffice controller get automations metadata #
PUT /backoffice/accounts/{accountId}/trial Backoffice controller set trial end #
POST /backoffice/accounts/{orgId}/named-credential Backoffice controller create named credential #
DELETE /backoffice/accounts/{orgId}/named-credential Backoffice controller delete named credential #
POST /backoffice/mp-version Update a file in s3 folder #
GET /backoffice/cache Backoffice controller get value from cache #
DELETE /backoffice/cache Backoffice controller delete value from cache #
GET /backoffice/crm_orgs/{orgId}/analyse/{objectName} Backoffice controller create org analysis job #
GET /backoffice/crm_orgs/{orgId}/unused-apex-classes Backoffice controller analyze unused apex classes #
GET /backoffice/job-execution/failed Backoffice controller get failed job executions #
GET /backoffice/auto-fetch/org/{orgId} Backoffice controller get auto fetch by org id #
PUT /backoffice/auto-fetch/org/{orgId} Backoffice controller update auto fetch by org id #
POST /backoffice/crm_orgs/{orgId}/opt-monitoring Backoffice controller change org opt monitoring #
GET /backoffice/lock/{lockKey} Backoffice controller is locked #
DELETE /backoffice/lock/{lockKey}/{ownerId} Backoffice controller release lock #
GET /backoffice/lock/{lockKey}/{ownerId} Backoffice controller get lock #
GET /backoffice/product-plan/available-product-policies Backoffice controller get available plan #
GET /backoffice/product-plan/available-features Backoffice controller get available features #
GET /backoffice/product-plan/{accountId} Backoffice controller get plan #
PATCH /backoffice/product-plan/{accountId} Backoffice controller update policy #
PUT /backoffice/product-plan/{accountId}/features Backoffice controller update features for selected feature product policy #
GET /backoffice/product-plan/{accountId}/features Backoffice controller get allowed feature plan for account #
GET /backoffice/dump-automations/{folderName} Backoffice controller dump automations #
POST /backoffice/restart-python-agent Backoffice controller restart python agent #
POST /backoffice/crm_orgs/{orgId}/ai-process-mining Backoffice controller create ai process mining funnels #
POST /backoffice/opensearch/reset-index/{orgId} Backoffice controller reindex open search #
POST /backoffice/opensearch/migrate-index/{orgId} Backoffice controller migrate open search index #
POST /backoffice/opensearch/purge-inactive-index/{orgId} Backoffice controller purge inactive open search index #
POST /backoffice/opensearch/search-by-content/{orgId} Backoffice controller search by content #
POST /backoffice/opensearch/search-by-filename/{orgId} Backoffice controller search by filename #
POST /backoffice/opensearch/raw-search/{orgId} Backoffice controller raw search #
GET /backoffice/opensearch/scope/{orgId} Backoffice controller get open search scope #
PUT /backoffice/opensearch/scope/{orgId} Backoffice controller update open search scope #
POST /backoffice/agent-files/{fileId}/generate-summary Backoffice controller generate agent file summary #
POST /backoffice/agent-files/regenerate-all-summaries Backoffice controller regenerate all agent file summaries #
POST /backoffice/accounts/{accountId}/copy-prompt-group/{promptGroupId} Backoffice controller copy prompt group to accounts #
GET /backoffice/agent-summaries Backoffice controller get agent summaries #
GET /backoffice/agent-summaries/stats Backoffice controller get agent summaries stats #
GET /backoffice/agent-summaries/accounts Backoffice controller get account grouped summaries #
GET /backoffice/agent-summaries/users Backoffice controller get user grouped summaries #
GET /backoffice/agent-summaries/agents Backoffice controller get agent grouped summaries #
GET /backoffice/agent-summaries/modes Backoffice controller get mode grouped summaries #
GET /backoffice/ai-artifacts/{versionId} Fetch a single AI artifact by its version id (primary key of AiArtifact). #
POST /backoffice/sync-graph-db-batch Backoffice controller sync graph db batch #

Documentation

📖
APIReference
https://api.sweep.io/api
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/authentication/sweep-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/openapi/sweep-backoffice-api-openapi.yml

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

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-backoffice-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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-backoffice-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sweep Backoffice 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 (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/openapi/sweep-backoffice-api-openapi.yml