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

Sweep Documentation Platform API

The Documentation Platform API from Sweep — 49 operation(s) for documentation platform.

Sweep Documentation Platform 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 Platform. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and authentication docs.

This API exposes 49 operations across 49 paths, and defines 1 schema. It is described by OpenAPI 3.2.0, at version 0.1.

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

49 operations 49 paths 1 schemas 45 GET4 POST

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 Platform API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 49

Across 49 paths, the API surfaces 49 operations — 45 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Documentation Platform 49
GET
/documentation-platform/snowflake/search
DocumentationPlatformController_searchElements 4 params → 200
GET
/documentation-platform/snowflake/search-by-metadata
DocumentationPlatformController_findElementByName 4 params → 200
GET
/documentation-platform/snowflake/{metadataId}/dependencies
DocumentationPlatformController_getElementDependencies 2 params → 200
GET
/documentation-platform/snowflake/{metadataId}/dependents
DocumentationPlatformController_getElementDependents 2 params → 200
GET
/documentation-platform/snowflake/{metadataId}/summary
DocumentationPlatformController_getElementSummary 2 params → 200
GET
/documentation-platform/snowflake/{metadataId}/source
DocumentationPlatformController_getElementSource 2 params → 200
POST
/documentation-platform/snowflake/{metadataId}/chat
DocumentationPlatformController_chatWithElement 2 params body → 201
GET
/documentation-platform/snowflake/{elementType}
DocumentationPlatformController_listElements 2 params → 200
GET
/documentation-platform/data360/search
DocumentationPlatformController_searchData360Elements 3 params → 200
GET
/documentation-platform/data360/search-by-metadata
DocumentationPlatformController_findData360ElementByName 3 params → 200
GET
/documentation-platform/data360/{metadataId}/dependencies
DocumentationPlatformController_getData360ElementDependencies 2 params → 200
GET
/documentation-platform/data360/{metadataId}/dependents
DocumentationPlatformController_getData360ElementDependents 2 params → 200
GET
/documentation-platform/data360/{metadataId}/children
DocumentationPlatformController_getData360ElementChildren 2 params → 200
GET
/documentation-platform/data360/{metadataId}/summary
DocumentationPlatformController_getData360ElementSummary 2 params → 200
GET
/documentation-platform/data360/{metadataId}/source
DocumentationPlatformController_getData360ElementSource 2 params → 200
POST
/documentation-platform/data360/{metadataId}/chat
DocumentationPlatformController_chatWithData360Element 2 params body → 201
GET
/documentation-platform/data360/{elementType}
DocumentationPlatformController_listData360Elements 2 params → 200
GET
/documentation-platform/workato/search
DocumentationPlatformController_searchWorkatoElements 3 params → 200
GET
/documentation-platform/workato/search-by-metadata
DocumentationPlatformController_findWorkatoElementByName 3 params → 200
GET
/documentation-platform/workato/{metadataId}/dependencies
DocumentationPlatformController_getWorkatoElementDependencies 2 params → 200
GET
/documentation-platform/workato/{metadataId}/dependents
DocumentationPlatformController_getWorkatoElementDependents 2 params → 200
GET
/documentation-platform/workato/{metadataId}/children
DocumentationPlatformController_getWorkatoElementChildren 2 params → 200
GET
/documentation-platform/workato/{metadataId}/source
DocumentationPlatformController_getWorkatoElementSource 2 params → 200
GET
/documentation-platform/workato/{metadataId}/summary
DocumentationPlatformController_getWorkatoElementSummary 2 params → 200
GET
/documentation-platform/workato/{elementType}
DocumentationPlatformController_listWorkatoElements 2 params → 200
GET
/documentation-platform/hubspot/search
DocumentationPlatformController_searchHubspotElements 3 params → 200
GET
/documentation-platform/hubspot/search-by-metadata
DocumentationPlatformController_findHubspotElementByName 3 params → 200
GET
/documentation-platform/hubspot/{metadataId}/dependencies
DocumentationPlatformController_getHubspotElementDependencies 2 params → 200
GET
/documentation-platform/hubspot/{metadataId}/dependents
DocumentationPlatformController_getHubspotElementDependents 2 params → 200
GET
/documentation-platform/hubspot/{metadataId}/children
DocumentationPlatformController_getHubspotElementChildren 2 params → 200
GET
/documentation-platform/hubspot/{metadataId}/summary
DocumentationPlatformController_getHubspotElementSummary 2 params → 200
GET
/documentation-platform/hubspot/{metadataId}/source
DocumentationPlatformController_getHubspotElementSource 2 params → 200
POST
/documentation-platform/hubspot/{metadataId}/chat
DocumentationPlatformController_chatWithHubspotElement 2 params body → 201
GET
/documentation-platform/hubspot/{elementType}
DocumentationPlatformController_listHubspotElements 2 params → 200
GET
/documentation-platform/servicenow/search
DocumentationPlatformController_searchServiceNowElements 2 params → 200
GET
/documentation-platform/servicenow/search-by-metadata
DocumentationPlatformController_findServiceNowElementByName 2 params → 200
GET
/documentation-platform/servicenow/tables/{tableName}/fields
DocumentationPlatformController_getServiceNowTableFields 3 params → 200
GET
/documentation-platform/servicenow/{metadataId}/summary
DocumentationPlatformController_getServiceNowElementSummary 2 params → 200
POST
/documentation-platform/servicenow/{metadataId}/chat
DocumentationPlatformController_chatWithServiceNowElement 2 params body → 201
GET
/documentation-platform/servicenow/{metadataId}/source
DocumentationPlatformController_getServiceNowElementSource 2 params → 200
GET
/documentation-platform/servicenow/{metadataId}/choices
DocumentationPlatformController_getServiceNowFieldChoices 2 params → 200
GET
/documentation-platform/servicenow/{elementType}
DocumentationPlatformController_listServiceNowElements 2 params → 200
GET
/documentation-platform/salesforce/objects
DocumentationPlatformController_listSalesforceObjects 1 param → 200
GET
/documentation-platform/salesforce/element-types
DocumentationPlatformController_listSalesforceElementTypes 1 param → 200
GET
/documentation-platform/salesforce/objects/{objectName}/elements
DocumentationPlatformController_getSalesforceObjectDetailElements 3 params → 200
GET
/documentation-platform/salesforce/objects/{objectName}/counters
DocumentationPlatformController_getSalesforceObjectCounters 2 params → 200
GET
/documentation-platform/salesforce/{elementType}
DocumentationPlatformController_listSalesforceElements 2 params → 200
GET
/documentation-platform/salesforce/{metadataId}/dependencies
DocumentationPlatformController_getSalesforceElementDependencies 2 params → 200
GET
/documentation-platform/salesforce/{metadataId}/dependents
DocumentationPlatformController_getSalesforceElementDependents 2 params → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is DocumentationChatRequestDto (3 properties). Each schema is shown below with its type and property counts.

DocumentationChatRequestDto
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sweep-documentation-platform-api-openapi.yml Raw ↑

Other APIs Sweep publishes across the network.

Sweep MCP Server
Sweep Account Selection API
Sweep Agentic Features API
Sweep Ai Agents API
Sweep AI Artifacts (unauthenticated) API
Sweep AI Attachments API
Sweep AI Prompts API
Sweep AI Retrievers API
Sweep AI Session API
Sweep AI Stream API
Sweep AI User Skills API
Sweep Assignment Groups API
Where this information came from

This is an independent, third-party profile of Sweep Documentation Platform 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.