Sweep

Sweep Documentation Salesforce API

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

GitHub OpenAPI

Operations 26

GET /documentation-salesforce/{crmOrgId} Documentation salesforce controller get documentation data #
GET /documentation-salesforce/{crmOrgId}/objects Documentation salesforce controller get object types #
POST /documentation-salesforce/{crmOrgId}/objects/{objectName} Documentation salesforce controller create object documentation #
PATCH /documentation-salesforce/{crmOrgId}/objects/{objectName} Documentation salesforce controller toggle object favorite #
GET /documentation-salesforce/{crmOrgId}/metadataTypes Documentation salesforce controller get metadata types #
GET /documentation-salesforce/{crmOrgId}/metadataTypes/{metadataTypeName} Documentation salesforce controller get metadata #
GET /documentation-salesforce/{crmOrgId}/layouts/{metadataId} Documentation salesforce controller get layout properties #
POST /documentation-salesforce/{crmOrgId}/ai-chat Documentation salesforce controller create ai documentation chat #
POST /documentation-salesforce/{crmOrgId}/generate-configuration-gpt Documentation salesforce controller get configuration gpt #
GET /documentation-salesforce/{crmOrgId}/configuration/dependencies Documentation salesforce controller get configuration dependencies #
GET /documentation-salesforce/{crmOrgId}/configuration/consumers Documentation salesforce controller get configuration consumers #
GET /documentation-salesforce/{crmOrgId}/field-consumers Documentation salesforce controller get field consumers #
GET /documentation-salesforce/{crmOrgId}/search Documentation salesforce controller get search results #
GET /documentation-salesforce/{crmOrgId}/search-content Documentation salesforce controller get search content #
GET /documentation-salesforce/{crmOrgId}/nacl-file Documentation salesforce controller get nacl file #
GET /documentation-salesforce/user-inputs/tags Documentation salesforce controller get user input tags #
POST /documentation-salesforce/user-inputs/tags Documentation salesforce controller create user input tag #
PATCH /documentation-salesforce/user-inputs/tags/{tagId} Documentation salesforce controller edit user input tag #
DELETE /documentation-salesforce/user-inputs/tags/{tagId} Documentation salesforce controller delete user input tag #
GET /documentation-salesforce/user-inputs/users Documentation salesforce controller get user inputs users with metadata elements #
DELETE /documentation-salesforce/user-inputs/users/{userId} Documentation salesforce controller delete user input user configurations #
PUT /documentation-salesforce/user-inputs/{metadataId} Documentation salesforce controller update user input configuration #
GET /documentation-salesforce/user-inputs/{metadataId}/comments Documentation salesforce controller get user input configuration comments #
POST /documentation-salesforce/user-inputs/{metadataId}/comments Documentation salesforce controller create user input configuration comment #
PATCH /documentation-salesforce/user-inputs/{metadataId}/comments/{commentId} Documentation salesforce controller edit user input configuration comment #
DELETE /documentation-salesforce/user-inputs/{metadataId}/comments/{commentId} Documentation salesforce controller delete user input configuration comment #

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