Sweep

Sweep Documentation Platform API

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

GitHub OpenAPI

Operations 49

GET /documentation-platform/snowflake/search Documentation platform controller search elements #
GET /documentation-platform/snowflake/search-by-metadata Documentation platform controller find element by name #
GET /documentation-platform/snowflake/{metadataId}/dependencies Documentation platform controller get element dependencies #
GET /documentation-platform/snowflake/{metadataId}/dependents Documentation platform controller get element dependents #
GET /documentation-platform/snowflake/{metadataId}/summary Documentation platform controller get element summary #
GET /documentation-platform/snowflake/{metadataId}/source Documentation platform controller get element source #
POST /documentation-platform/snowflake/{metadataId}/chat Documentation platform controller chat with element #
GET /documentation-platform/snowflake/{elementType} Documentation platform controller list elements #
GET /documentation-platform/data360/search Documentation platform controller search data360 elements #
GET /documentation-platform/data360/search-by-metadata Documentation platform controller find data360 element by name #
GET /documentation-platform/data360/{metadataId}/dependencies Documentation platform controller get data360 element dependencies #
GET /documentation-platform/data360/{metadataId}/dependents Documentation platform controller get data360 element dependents #
GET /documentation-platform/data360/{metadataId}/children Documentation platform controller get data360 element children #
GET /documentation-platform/data360/{metadataId}/summary Documentation platform controller get data360 element summary #
GET /documentation-platform/data360/{metadataId}/source Documentation platform controller get data360 element source #
POST /documentation-platform/data360/{metadataId}/chat Documentation platform controller chat with data360 element #
GET /documentation-platform/data360/{elementType} Documentation platform controller list data360 elements #
GET /documentation-platform/workato/search Documentation platform controller search workato elements #
GET /documentation-platform/workato/search-by-metadata Documentation platform controller find workato element by name #
GET /documentation-platform/workato/{metadataId}/dependencies Documentation platform controller get workato element dependencies #
GET /documentation-platform/workato/{metadataId}/dependents Documentation platform controller get workato element dependents #
GET /documentation-platform/workato/{metadataId}/children Documentation platform controller get workato element children #
GET /documentation-platform/workato/{metadataId}/source Documentation platform controller get workato element source #
GET /documentation-platform/workato/{metadataId}/summary Documentation platform controller get workato element summary #
GET /documentation-platform/workato/{elementType} Documentation platform controller list workato elements #
GET /documentation-platform/hubspot/search Documentation platform controller search hubspot elements #
GET /documentation-platform/hubspot/search-by-metadata Documentation platform controller find hubspot element by name #
GET /documentation-platform/hubspot/{metadataId}/dependencies Documentation platform controller get hubspot element dependencies #
GET /documentation-platform/hubspot/{metadataId}/dependents Documentation platform controller get hubspot element dependents #
GET /documentation-platform/hubspot/{metadataId}/children Documentation platform controller get hubspot element children #
GET /documentation-platform/hubspot/{metadataId}/summary Documentation platform controller get hubspot element summary #
GET /documentation-platform/hubspot/{metadataId}/source Documentation platform controller get hubspot element source #
POST /documentation-platform/hubspot/{metadataId}/chat Documentation platform controller chat with hubspot element #
GET /documentation-platform/hubspot/{elementType} Documentation platform controller list hubspot elements #
GET /documentation-platform/servicenow/search Documentation platform controller search service now elements #
GET /documentation-platform/servicenow/search-by-metadata Documentation platform controller find service now element by name #
GET /documentation-platform/servicenow/tables/{tableName}/fields Documentation platform controller get service now table fields #
GET /documentation-platform/servicenow/{metadataId}/summary Documentation platform controller get service now element summary #
POST /documentation-platform/servicenow/{metadataId}/chat Documentation platform controller chat with service now element #
GET /documentation-platform/servicenow/{metadataId}/source Documentation platform controller get service now element source #
GET /documentation-platform/servicenow/{metadataId}/choices Documentation platform controller get service now field choices #
GET /documentation-platform/servicenow/{elementType} Documentation platform controller list service now elements #
GET /documentation-platform/salesforce/objects Documentation platform controller list salesforce objects #
GET /documentation-platform/salesforce/element-types Documentation platform controller list salesforce element types #
GET /documentation-platform/salesforce/objects/{objectName}/elements Documentation platform controller get salesforce object detail elements #
GET /documentation-platform/salesforce/objects/{objectName}/counters Documentation platform controller get salesforce object counters #
GET /documentation-platform/salesforce/{elementType} Documentation platform controller list salesforce elements #
GET /documentation-platform/salesforce/{metadataId}/dependencies Documentation platform controller get salesforce element dependencies #
GET /documentation-platform/salesforce/{metadataId}/dependents Documentation platform controller get salesforce element dependents #

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-documentation-platform-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-documentation-platform-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-documentation-platform-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sweep Documentation Platform 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 (37 KB total) ---
# Full source: https://artifacts.apis.io/sweep/openapi/sweep-documentation-platform-api-openapi.yml