How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Sweep

Sweep Backoffice API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Sweep Backoffice API is one of 70 APIs that Sweep publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Back Office. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and authentication docs.

This API exposes 75 operations across 67 paths, and defines 24 schemas. It is described by OpenAPI 3.2.0, at version 0.1.

Requests are made against a single base URL, https://api.sweep.io.

75 operations 67 paths 24 schemas 4 DELETE36 GET1 PATCH28 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1
Base URL
https://api.sweep.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Sweep Backoffice API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 75

Across 67 paths, the API surfaces 75 operations — 4 DELETE, 36 GET, 1 PATCH, 28 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Backoffice 75
GET
/backoffice/accounts
BackofficeController_getAllAccounts → 200
POST
/backoffice/accounts
BackofficeController_updateAccountsMany → 201
GET
/backoffice/users
BackofficeController_getAllUsers → 200
GET
/backoffice/accounts/installed-packages
BackofficeController_getInstalledPackagesForFreeAccounts → 200
POST
/backoffice/accounts/{accountId}
BackofficeController_releaseAccount 2 params → 201
GET
/backoffice/crm_orgs/{crmOrgId}/sweep_transactions_log
BackofficeController_getSweepTransactionsLog 3 params → 200
GET
/backoffice/crm_orgs/{crmOrgId}/fetch
BackofficeController_fetch 2 params → 200
POST
/backoffice/crm_orgs/{orgId}/force-refresh-token
BackofficeController_forceRefreshToken 1 param → 201
POST
/backoffice/crm_orgs/{orgId}/force-refresh-user-token
BackofficeController_forceRefreshUserToken 2 params → 201
GET
/backoffice/crm_orgs/all/get_soql
BackofficeController_getAnySoqlQueryAllOrgs 2 params → 200
GET
/backoffice/ai_agents/{agentId}/trigger_scan
BackofficeController_triggerScan 1 param → 200
GET
/backoffice/crm_orgs/{crmOrgId}/get_soql
BackofficeController_getAnySoqlQuery 4 params → 200
GET
/backoffice/accounts/{accountId}/crm_orgs
BackofficeController_getAllCrmOrgs 1 param → 200
GET
/backoffice/accounts/{accountId}/orgs
BackofficeController_getAllOrgs 1 param → 200
POST
/backoffice/orgs/{orgId}/fetch
BackofficeController_fetchAnyOrg 2 params → 201
GET
/backoffice/orgs/{orgId}/metadata-search
BackofficeController_searchOrgMetadata 3 params → 200
GET
/backoffice/orgs/{orgId}
BackofficeController_getOrgById 1 param → 200
POST
/backoffice/snowflake-orgs/{orgId}/query
BackofficeController_runSnowflakeQuery 1 param → 201
GET
/backoffice/crm-orgs/{crmOrgId}
BackofficeController_getCrmOrgById 1 param → 200
POST
/backoffice/crm_orgs/{crmOrgId}/salesforce-event-monitoring-log-export
BackofficeController_exportSalesforceEventMonitoringLogs 1 param body → 201
PUT
/backoffice/crm-orgs/{crmOrgId}/tier
BackofficeController_updateCrmOrgTier 2 params → 200
POST
/backoffice/parse-all
BackofficeController_parseAllOrgs → 201
POST
/backoffice/housekeeping/purge-salto-workspaces
BackofficeController_archiveAllSaltoWorkspaces → 201
POST
/backoffice/recovery/init-missing-bare-repos
BackofficeController_recoverMissingBareRepos → 201
POST
/backoffice/ai-projects/backfill-origin-template-ids
BackofficeController_backfillPlaybookOriginTemplateIds → 201
POST
/backoffice/accounts/{accountId}/invite
BackofficeController_inviteUserToAccount 2 params → 201
GET
/backoffice/accounts/{accountId}/users
BackofficeController_getUsersByAccount 1 param → 200
GET
/backoffice/accounts/{accountId}/roles
BackofficeController_getRoleGroupsForAccount 1 param → 200
PUT
/backoffice/users/{userId}/role
BackofficeController_updateUserRole 1 param → 200
DELETE
/backoffice/users/{userId}
BackofficeController_removeUser 1 param → 200
POST
/backoffice/accounts/{accountId}/move-user
BackofficeController_moveUserToAccount 2 params → 201
GET
/backoffice/crm-orgs/{crmOrgId}/automations
BackofficeController_getAutomationsMetadata 1 param → 200
PUT
/backoffice/accounts/{accountId}/trial
BackofficeController_setTrialEnd 2 params → 200
POST
/backoffice/accounts/{orgId}/named-credential
BackofficeController_createNamedCredential 1 param → 201
DELETE
/backoffice/accounts/{orgId}/named-credential
BackofficeController_deleteNamedCredential 1 param → 200
POST
/backoffice/mp-version
Update a file in s3 folder
BackofficeController_updateMPVersionFile → 201
GET
/backoffice/cache
BackofficeController_getValueFromCache 1 param → 200
DELETE
/backoffice/cache
BackofficeController_deleteValueFromCache 1 param → 200
GET
/backoffice/crm_orgs/{orgId}/analyse/{objectName}
BackofficeController_createOrgAnalysisJob 2 params → 200
GET
/backoffice/crm_orgs/{orgId}/unused-apex-classes
BackofficeController_analyzeUnusedApexClasses 2 params → 200
GET
/backoffice/job-execution/failed
BackofficeController_getFailedJobExecutions → 200
GET
/backoffice/auto-fetch/org/{orgId}
BackofficeController_getAutoFetchByOrgId 1 param → 200
PUT
/backoffice/auto-fetch/org/{orgId}
BackofficeController_updateAutoFetchByOrgId 1 param → 200
POST
/backoffice/crm_orgs/{orgId}/opt-monitoring
BackofficeController_changeOrgOptMonitoring 1 param body → 201
GET
/backoffice/lock/{lockKey}
BackofficeController_isLocked 1 param → 200
DELETE
/backoffice/lock/{lockKey}/{ownerId}
BackofficeController_releaseLock 2 params → 200
GET
/backoffice/lock/{lockKey}/{ownerId}
BackofficeController_getLock 4 params → 200
GET
/backoffice/product-plan/available-product-policies
BackofficeController_getAvailablePlan → 200
GET
/backoffice/product-plan/available-features
BackofficeController_getAvailableFeatures → 200
GET
/backoffice/product-plan/{accountId}
BackofficeController_getPlan 1 param → 200
PATCH
/backoffice/product-plan/{accountId}
BackofficeController_updatePolicy 1 param body → 200
PUT
/backoffice/product-plan/{accountId}/features
BackofficeController_updateFeaturesForSelectedFeatureProductPolicy 1 param body → 200
GET
/backoffice/product-plan/{accountId}/features
BackofficeController_getAllowedFeaturePlanForAccount 1 param → 200
GET
/backoffice/dump-automations/{folderName}
BackofficeController_dumpAutomations 1 param → 200
POST
/backoffice/restart-python-agent
BackofficeController_restartPythonAgent → 201
POST
/backoffice/crm_orgs/{orgId}/ai-process-mining
BackofficeController_createAiProcessMiningFunnels 1 param → 201
POST
/backoffice/opensearch/reset-index/{orgId}
BackofficeController_reindexOpenSearch 1 param → 201
POST
/backoffice/opensearch/migrate-index/{orgId}
BackofficeController_migrateOpenSearchIndex 1 param → 201
POST
/backoffice/opensearch/purge-inactive-index/{orgId}
BackofficeController_purgeInactiveOpenSearchIndex 1 param → 201
POST
/backoffice/opensearch/search-by-content/{orgId}
BackofficeController_searchByContent 1 param → 201
POST
/backoffice/opensearch/search-by-filename/{orgId}
BackofficeController_searchByFilename 1 param → 201
POST
/backoffice/opensearch/raw-search/{orgId}
BackofficeController_rawSearch 1 param → 201
GET
/backoffice/opensearch/scope/{orgId}
BackofficeController_getOpenSearchScope 1 param → 200
PUT
/backoffice/opensearch/scope/{orgId}
BackofficeController_updateOpenSearchScope 1 param → 200
POST
/backoffice/agent-files/{fileId}/generate-summary
BackofficeController_generateAgentFileSummary 1 param → 201
POST
/backoffice/agent-files/regenerate-all-summaries
BackofficeController_regenerateAllAgentFileSummaries → 201
POST
/backoffice/accounts/{accountId}/copy-prompt-group/{promptGroupId}
BackofficeController_copyPromptGroupToAccounts 2 params → 201
GET
/backoffice/agent-summaries
BackofficeController_getAgentSummaries 13 params → 200
GET
/backoffice/agent-summaries/stats
BackofficeController_getAgentSummariesStats 9 params → 200
GET
/backoffice/agent-summaries/accounts
BackofficeController_getAccountGroupedSummaries 9 params → 200
GET
/backoffice/agent-summaries/users
BackofficeController_getUserGroupedSummaries 9 params → 200
GET
/backoffice/agent-summaries/agents
BackofficeController_getAgentGroupedSummaries 9 params → 200
GET
/backoffice/agent-summaries/modes
BackofficeController_getModeGroupedSummaries 8 params → 200
GET
/backoffice/ai-artifacts/{versionId}
Fetch a single AI artifact by its version id (primary key of AiArtifact). versionId matches the naming used in the dashboard's artifact API and in the [Artifact: (ID: , Version: )] markers embedded i…
BackofficeController_getAiArtifactByVersionId 1 param → 200
POST
/backoffice/sync-graph-db-batch
BackofficeController_syncGraphDbBatch → 201

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are CrmOrg (24 properties), Account (16 properties), FunnelSnapshot (15 properties), User (15 properties). Each schema is shown below with its type and property counts.

SweepFieldReference
object
2 properties 1 required
FunnelDetailsDto
object
6 properties 3 required
SweepAssignmentRule
object
6 properties 6 required
User
object
15 properties 13 required
SweepExitCriteria
object
6 properties 3 required
JobExecution
object
9 properties 9 required
FunnelLinkDto
object
4 properties 3 required
FunnelSnapshot
object
15 properties 15 required
OpenSearchScope
object
10 properties 10 required
RoleGroup
object
14 properties 13 required
UpdatePlanDto
object
LeadingObjectDto
object
4 properties 3 required
JobResultDetails
object
RoleGroupAccountRole
object
3 properties 3 required
FunnelDeployment
object
9 properties 9 required
CrmOrg
object
24 properties 24 required
Account
object
16 properties 16 required
JobExecutionParams
object
UpdateFeaturePlanDto
object
Org
object
3 properties 3 required
SweepStage
object
12 properties 5 required
SalesforceEventMonitoringLogExportDto
object
RoleGroupOrgRole
object
5 properties 5 required
FunnelPluginsDto
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sweep-backoffice-api-openapi.yml Raw ↑

Other APIs Sweep publishes across the network.

Sweep MCP Server
AE Profile APIs.io
Sweep Account Selection API
AE Profile APIs.io
Sweep Agentic Features API
AE Profile APIs.io
Sweep Ai Agents API
AE Profile APIs.io
Sweep AI Artifacts (unauthenticated) API
AE Profile APIs.io
Sweep AI Attachments API
AE Profile APIs.io
Sweep AI Prompts API
AE Profile APIs.io
Sweep AI Retrievers API
AE Profile APIs.io
Sweep AI Session API
AE Profile APIs.io
Sweep AI Stream API
AE Profile APIs.io
Sweep AI User Skills API
AE Profile APIs.io
Sweep Assignment Groups API
AE Profile APIs.io
#Back Office
← Back to S APIs
API Details
ID
sweep:sweep-backoffice-api
Base URL
https://api.sweep.io
Docs
https://api.sweep.io/api
Provider
Sweep
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=sweep-backoffice-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/sweep-backoffice-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Sweep Backoffice API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.