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 Documentation Salesforce API

The Documentation Salesforce API from Sweep — 21 operation(s) for documentation salesforce.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 26 operations across 21 paths, and defines 26 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.

26 operations 21 paths 26 schemas 3 DELETE14 GET3 PATCH5 POST1 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 Documentation Salesforce API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 26

Across 21 paths, the API surfaces 26 operations — 3 DELETE, 14 GET, 3 PATCH, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Documentation Salesforce 26
GET
/documentation-salesforce/{crmOrgId}
DocumentationSalesforceController_getDocumentationData 1 param → 200
GET
/documentation-salesforce/{crmOrgId}/objects
DocumentationSalesforceController_getObjectTypes 1 param → 200
POST
/documentation-salesforce/{crmOrgId}/objects/{objectName}
DocumentationSalesforceController_createObjectDocumentation 2 params body → 201
PATCH
/documentation-salesforce/{crmOrgId}/objects/{objectName}
DocumentationSalesforceController_toggleObjectFavorite 2 params body → 200
GET
/documentation-salesforce/{crmOrgId}/metadataTypes
DocumentationSalesforceController_getMetadataTypes 1 param → 200
GET
/documentation-salesforce/{crmOrgId}/metadataTypes/{metadataTypeName}
DocumentationSalesforceController_getMetadata 2 params → 200
GET
/documentation-salesforce/{crmOrgId}/layouts/{metadataId}
DocumentationSalesforceController_getLayoutProperties 2 params → 200
POST
/documentation-salesforce/{crmOrgId}/ai-chat
DocumentationSalesforceController_createAiDocumentationChat 1 param body → 201
POST
/documentation-salesforce/{crmOrgId}/generate-configuration-gpt
DocumentationSalesforceController_getConfigurationGpt 1 param body → 201
GET
/documentation-salesforce/{crmOrgId}/configuration/dependencies
DocumentationSalesforceController_getConfigurationDependencies 2 params → 200
GET
/documentation-salesforce/{crmOrgId}/configuration/consumers
DocumentationSalesforceController_getConfigurationConsumers 2 params → 200
GET
/documentation-salesforce/{crmOrgId}/field-consumers
DocumentationSalesforceController_getFieldConsumers 4 params → 200
GET
/documentation-salesforce/{crmOrgId}/search
DocumentationSalesforceController_getSearchResults 3 params → 200
GET
/documentation-salesforce/{crmOrgId}/search-content
DocumentationSalesforceController_getSearchContent 3 params → 200
GET
/documentation-salesforce/{crmOrgId}/nacl-file
DocumentationSalesforceController_getNaclFile 2 params → 200
GET
/documentation-salesforce/user-inputs/tags
DocumentationSalesforceController_getUserInputTags 1 param → 200
POST
/documentation-salesforce/user-inputs/tags
DocumentationSalesforceController_createUserInputTag body → 201
PATCH
/documentation-salesforce/user-inputs/tags/{tagId}
DocumentationSalesforceController_editUserInputTag 1 param body → 200
DELETE
/documentation-salesforce/user-inputs/tags/{tagId}
DocumentationSalesforceController_deleteUserInputTag 1 param → 200
GET
/documentation-salesforce/user-inputs/users
DocumentationSalesforceController_getUserInputsUsersWithMetadataElements 1 param → 200
DELETE
/documentation-salesforce/user-inputs/users/{userId}
DocumentationSalesforceController_deleteUserInputUserConfigurations 1 param → 200
PUT
/documentation-salesforce/user-inputs/{metadataId}
DocumentationSalesforceController_updateUserInputConfiguration 2 params body → 200
GET
/documentation-salesforce/user-inputs/{metadataId}/comments
DocumentationSalesforceController_getUserInputConfigurationComments 2 params → 200
POST
/documentation-salesforce/user-inputs/{metadataId}/comments
DocumentationSalesforceController_createUserInputConfigurationComment 2 params body → 201
PATCH
/documentation-salesforce/user-inputs/{metadataId}/comments/{commentId}
DocumentationSalesforceController_editUserInputConfigurationComment 3 params body → 200
DELETE
/documentation-salesforce/user-inputs/{metadataId}/comments/{commentId}
DocumentationSalesforceController_deleteUserInputConfigurationComment 3 params → 200

Schemas 26

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

SweepFieldReference
object
2 properties 1 required
UpsertConfigurationCommentDto
object
3 properties 3 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
FunnelLinkDto
object
4 properties 3 required
FunnelSnapshot
object
15 properties 15 required
RoleGroup
object
14 properties 13 required
ConfigurationCommentPropertiesDto
object
1 property 1 required
LeadingObjectDto
object
4 properties 3 required
UpdateConfigurationUserInputsDto
object
3 properties 3 required
CalcParsedConfigurationGptDto
object
1 property 1 required
RoleGroupAccountRole
object
3 properties 3 required
ConfigurationUserInputComment
object
11 properties 11 required
EditTagDto
object
2 properties
FunnelDeployment
object
9 properties 9 required
CrmOrg
object
24 properties 24 required
Account
object
16 properties 16 required
Org
object
3 properties 3 required
SweepStage
object
12 properties 5 required
DocumentationObjectDto
object
1 property 1 required
RoleGroupOrgRole
object
5 properties 5 required
CreateTagDto
object
2 properties 2 required
AiChatDto
object
4 properties 4 required
FunnelPluginsDto
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sweep-documentation-salesforce-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
#Documentation Salesforce
← Back to S APIs
API Details
ID
sweep:sweep-documentation-salesforce-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-documentation-salesforce-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/sweep-documentation-salesforce-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 Documentation Salesforce 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.