The Data Integrations API from Sweep — 20 operation(s) for data integrations.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/sweep:sweep-data-integrations-api"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.
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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Sweep Data Integrations 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:
- name: Data Integrations
paths:
/data-integrations/slack/oauth2-code:
post:
operationId: DataIntegrationsController_handleSlackAuthAuthorizationCode
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SlackOAuthDto'
responses:
'201':
description: ''
tags:
- Data Integrations
summary: Data integrations controller handle slack auth authorization code
x-summary-source: derived
/data-integrations/slack/recipients:
get:
operationId: DataIntegrationsController_getSlackRecipients
parameters:
- name: ids
required: true
in: query
schema:
type: array
items:
type: string
- name: invalidate-cache
required: true
in: query
schema:
type: boolean
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
type: object
tags:
- Data Integrations
summary: Data integrations controller get slack recipients
x-summary-source: derived
/data-integrations/slack:
get:
operationId: DataIntegrationsController_getSlackConnectionDetails
parameters: []
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SlackConnectionDto'
tags:
- Data Integrations
summary: Data integrations controller get slack connection details
x-summary-source: derived
patch:
operationId: DataIntegrationsController_editSlackConnection
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EditSlackConnectionDto'
responses:
'200':
description: ''
tags:
- Data Integrations
summary: Data integrations controller edit slack connection
x-summary-source: derived
delete:
operationId: DataIntegrationsController_disconnectSlackApp
parameters: []
responses:
'200':
description: ''
tags:
- Data Integrations
summary: Data integrations controller disconnect slack app
x-summary-source: derived
/data-integrations/audit:
get:
operationId: DataIntegrationsController_getAudit
parameters:
- name: automationId
required: true
in: query
schema:
type: string
- name: actionType
required: true
in: query
schema:
type: array
items:
type: string
- name: status
required: true
in: query
schema:
type: array
items:
type: string
- name: crmOrgId
required: true
in: query
schema:
type: array
items:
type: string
- name: customIntegrationId
required: true
in: query
schema:
type: array
items:
type: string
- name: search
required: true
in: query
schema:
type: string
- name: startTime
required: true
in: query
schema:
type: string
- name: endTime
required: true
in: query
schema:
type: string
- name: nextId
required: true
in: query
schema:
type: string
responses:
'200':
description: ''
tags:
- Data Integrations
summary: Data integrations controller get audit
x-summary-source: derived
/data-integrations/custom-integrations:
get:
operationId: DataIntegrationsController_getCustomIntegrations
parameters: []
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
type: object
tags:
- Data Integrations
summary: Data integrations controller get custom integrations
x-summary-source: derived
post:
operationId: DataIntegrationsController_createCustomIntegrations
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpsertCustomIntegrationDto'
responses:
'201':
description: ''
content:
application/json:
schema:
type: object
tags:
- Data Integrations
summary: Data integrations controller create custom integrations
x-summary-source: derived
/data-integrations/custom-integrations/{integrationId}:
put:
operationId: DataIntegrationsController_editCustomIntegrations
parameters:
- name: integrationId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpsertCustomIntegrationDto'
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
tags:
- Data Integrations
summary: Data integrations controller edit custom integrations
x-summary-source: derived
delete:
operationId: DataIntegrationsController_delete
parameters:
- name: integrationId
required: true
in: path
schema:
type: string
- name: dry-run
required: true
in: query
schema:
type: boolean
responses:
'200':
description: ''
tags:
- Data Integrations
summary: Data integrations controller delete
x-summary-source: derived
/data-integrations/custom-integrations/{integrationId}/reveal-password:
get:
operationId: DataIntegrationsController_getCustomIntegrationPassword
parameters:
- name: integrationId
required: true
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: string
tags:
- Data Integrations
summary: Data integrations controller get custom integration password
x-summary-source: derived
/data-integrations/teams/oauth2-callback:
post:
operationId: DataIntegrationsController_oauth2Callback
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TeamsOAuthDto'
responses:
'201':
description: ''
content:
application/json:
schema:
type: string
tags:
- Data Integrations
summary: Data integrations controller oauth2 callback
x-summary-source: derived
/data-integrations/teams/recipients:
get:
operationId: DataIntegrationsController_getTeamsRecipients
parameters:
- name: type
required: true
in: query
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TeamsRecipientInfo'
tags:
- Data Integrations
summary: Data integrations controller get teams recipients
x-summary-source: derived
/data-integrations/teams/channels/{teamId}:
get:
operationId: DataIntegrationsController_getChannelsByTeam
parameters:
- name: teamId
required: true
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TeamsRecipientInfo'
tags:
- Data Integrations
summary: Data integrations controller get channels by team
x-summary-source: derived
/data-integrations/webhook/test:
post:
operationId: DataIntegrationsController_testWebhook
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookTestDto'
responses:
'201':
description: ''
content:
application/json:
schema:
type: object
tags:
- Data Integrations
summary: Data integrations controller test webhook
x-summary-source: derived
/data-integrations/teams/connection-status:
get:
operationId: DataIntegrationsController_getTeamsConnectionDetails
parameters: []
responses:
'200':
description: ''
tags:
- Data Integrations
summary: Data integrations controller get teams connection details
x-summary-source: derived
/data-integrations/teams/recipients-by-id:
get:
operationId: DataIntegrationsController_resolveReceipientNames
parameters:
- name: ids
required: true
in: query
schema:
type: array
items:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TeamsRecipientInfo'
tags:
- Data Integrations
summary: Data integrations controller resolve receipient names
x-summary-source: derived
/data-integrations/teams:
delete:
operationId: DataIntegrationsController_disconnectTeamsApp
parameters: []
responses:
'200':
description: ''
tags:
- Data Integrations
summary: Data integrations controller disconnect teams app
x-summary-source: derived
/data-integrations/teams/recipients/search:
get:
operationId: DataIntegrationsController_searchTeamsUsers
parameters:
- name: query
required: true
in: query
schema:
type: string
- name: top
required: true
in: query
schema:
type: number
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TeamsRecipientInfo'
tags:
- Data Integrations
summary: Data integrations controller search teams users
x-summary-source: derived
/data-integrations/teams/users/count:
get:
operationId: DataIntegrationsController_getTeamsUsersCount
parameters: []
responses:
'200':
description: ''
content:
application/json:
schema:
type: number
tags:
- Data Integrations
summary: Data integrations controller get teams users count
x-summary-source: derived
/data-integrations/teams/users-by-team/{teamId}:
get:
operationId: DataIntegrationsController_getTeamMembers
parameters:
- name: teamId
required: true
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TeamsRecipientInfo'
tags:
- Data Integrations
summary: Data integrations controller get team members
x-summary-source: derived
/data-integrations/teams/all:
get:
operationId: DataIntegrationsController_getAllTeams
parameters: []
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TeamsWithInstallationStatus'
tags:
- Data Integrations
summary: Data integrations controller get all teams
x-summary-source: derived
/data-integrations/teams/install:
post:
operationId: DataIntegrationsController_installSweepOnTeams
parameters: []
responses:
'201':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TeamsWithInstallationStatus'
tags:
- Data Integrations
summary: Data integrations controller install sweep on teams
x-summary-source: derived
/data-integrations/teams/uninstall:
post:
operationId: DataIntegrationsController_uninstallSweepOnTeams
parameters: []
responses:
'201':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TeamsWithInstallationStatus'
tags:
- Data Integrations
summary: Data integrations controller uninstall sweep on teams
x-summary-source: derived
components:
schemas:
AutomationActionWebhook:
type: object
properties:
actionType:
enum: []
type: number
default: WEBHOOK
actionParams:
$ref: '#/components/schemas/AutomationActionParamsWebhook'
_id:
type: string
required:
- actionType
- actionParams
- _id
EditSlackConnectionDto:
type: object
properties:
includeSandboxes:
type: boolean
required:
- includeSandboxes
Logo:
type: object
properties:
name:
type: string
domain:
type: string
required:
- name
- domain
TeamsRecipientInfo:
type: object
properties:
label:
type: string
id:
type: string
type:
enum:
- channel
- user
- team
- user_stored_in_salesforce_field
- channel_stored_in_sweep
- channel_stored_in_salesforce_field
type: string
required:
- label
- id
- type
SlackConnectionDto:
type: object
properties:
status:
type: string
enum:
- connected
- error
- invalid_credentials
- initialization
- not_initialized
upgradeRequired:
type: boolean
includeSandboxes:
type: boolean
required:
- status
- includeSandboxes
AutomationConditionalActions:
type: object
properties:
_id:
type: string
when:
$ref: '#/components/schemas/OptionalCondition'
actions:
type: array
items:
type: object
_name:
type: string
required:
- _id
- actions
- _name
StringTemplate:
type: object
properties:
template:
type: string
variables:
type: array
items:
$ref: '#/components/schemas/SweepFieldReference'
required:
- template
- variables
SlackOAuthDto:
type: object
properties: {}
KeyValueStringTemplate:
type: object
properties:
key:
type: string
value:
$ref: '#/components/schemas/StringTemplate'
required:
- key
- value
Field:
type: object
properties:
fieldIds:
type: array
items:
type: string
value:
type: string
required:
- fieldIds
- value
SweepCondition:
type: object
properties:
criteria:
type: array
items:
type: object
criteriaLogic:
type: string
required:
- criteria
- criteriaLogic
TeamsWithInstallationStatus:
type: object
properties:
label:
type: string
id:
type: string
type:
enum:
- channel
- user
- team
- user_stored_in_salesforce_field
- channel_stored_in_sweep
- channel_stored_in_salesforce_field
type: string
isSweepAppInstalled:
type: boolean
required:
- label
- id
- type
- isSweepAppInstalled
WebhookTestDto:
type: object
properties:
fields:
type: array
items:
$ref: '#/components/schemas/Field'
action:
$ref: '#/components/schemas/AutomationActionWebhook'
required:
- fields
- action
AutomationActionParamsWebhook:
type: object
properties:
verb:
type: string
enum:
- GET
- POST
- PUT
- PATCH
- DELETE
path:
$ref: '#/components/schemas/StringTemplate'
queryParams:
type: array
items:
$ref: '#/components/schemas/KeyValueStringTemplate'
headers:
type: array
items:
$ref: '#/components/schemas/KeyValueStringTemplate'
body:
type: object
integrationId:
type: string
followUpActions:
type: array
items:
$ref: '#/components/schemas/AutomationConditionalActions'
required:
- verb
- path
- queryParams
- headers
- body
- integrationId
- followUpActions
SweepFieldReference:
type: object
properties:
fieldIds:
type: array
items:
type: string
fieldSource:
type: string
required:
- fieldIds
OptionalCondition:
type: object
properties:
isCriteria:
type: boolean
criteria:
$ref: '#/components/schemas/SweepCondition'
TeamsOAuthDto:
type: object
properties:
code:
type: string
state:
type: string
required:
- code
- state
UpsertCustomIntegrationDto:
type: object
properties:
name:
type: string
baseUrl:
type: string
format: uri
authentication:
type: object
logo:
$ref: '#/components/schemas/Logo'
required:
- name
- baseUrl
- authentication
securitySchemes:
bearer:
scheme: bearer
bearerFormat: JWT
type: http