The Rollups API from Sweep — 5 operation(s) for rollups.
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-rollups-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 Rollups 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: Rollups
paths:
/rollups:
get:
operationId: RollupController_getRollups
parameters: []
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/RollupDto'
security:
- bearer: []
tags:
- Rollups
summary: Rollup controller get rollups
x-summary-source: derived
post:
operationId: RollupController_createRollup
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateRollupDto'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RollupDto'
security:
- bearer: []
tags:
- Rollups
summary: Rollup controller create rollup
x-summary-source: derived
/rollups/{rollupId}:
get:
operationId: RollupController_getRollupById
parameters:
- name: rollupId
required: true
in: path
schema:
type: string
- name: crmOrgId
required: true
in: query
schema:
type: string
- name: includeReadOnly
required: true
in: query
schema:
type: boolean
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
security:
- bearer: []
tags:
- Rollups
summary: Rollup controller get rollup by id
x-summary-source: derived
delete:
operationId: RollupController_deleteRollup
parameters:
- name: rollupId
required: true
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: boolean
security:
- bearer: []
tags:
- Rollups
summary: Rollup controller delete rollup
x-summary-source: derived
/rollups/read-only:
post:
operationId: RollupController_createReadOnlyRollup
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateRollupDto'
responses:
'201':
description: ''
content:
application/json:
schema:
type: object
security:
- bearer: []
tags:
- Rollups
summary: Rollup controller create read only rollup
x-summary-source: derived
/rollups/{rollupId}/{versionId}:
put:
operationId: RollupController_editRollup
parameters:
- name: rollupId
required: true
in: path
schema:
type: string
- name: versionId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateRollupDto'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RollupDto'
security:
- bearer: []
tags:
- Rollups
summary: Rollup controller edit rollup
x-summary-source: derived
post:
operationId: RollupController_deployRollup
parameters:
- name: rollupId
required: true
in: path
schema:
type: string
- name: versionId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeployRollupDto'
responses:
'201':
description: ''
security:
- bearer: []
tags:
- Rollups
summary: Rollup controller deploy rollup
x-summary-source: derived
/rollups/admin-notification/{rollupId}/{versionId}:
patch:
operationId: RollupController_notifyAdminOnRollup
parameters:
- name: rollupId
required: true
in: path
schema:
type: string
- name: versionId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AdminNotificationDto'
responses:
'200':
description: ''
security:
- bearer: []
tags:
- Rollups
summary: Rollup controller notify admin on rollup
x-summary-source: derived
components:
schemas:
SweepFieldRollupDto:
type: object
properties:
id:
type: string
objectName:
type: string
sweepFieldName:
type: string
sfFieldName:
type: string
fieldType:
enum:
- Id
- Address
- AutoNumber
- Checkbox
- Currency
- Date
- DateTime
- Email
- Html
- EncryptedText
- Geolocation
- Hierarchy
- LongTextArea
- Lookup
- MasterDetail
- MultiselectPicklist
- Name
- Name2
- Number
- Percent
- Phone
- Picklist
- Summary
- Text
- TextArea
- Time
- Unknown
- Url
- FormulaCheckbox
- FormulaCurrency
- FormulaDate
- FormulaDateTime
- FormulaNumber
- FormulaPercent
- FormulaText
- FormulaTime
- Combobox
type: string
compoundFieldId:
type: string
isCompound:
type: boolean
properties:
type: object
origin:
enum:
- SF_STANDARD
- SF_CUSTOM
- SWEEP_CUSTOM
- MP_CUSTOM
type: string
isRequired:
type: boolean
isCreatedInSweep:
type: boolean
helpText:
type: string
description:
type: string
pinToFunnelMap:
type: string
sfDisplayType:
enum:
- ADDRESS
- BOOLEAN
- CURRENCY
- DATE
- DATETIME
- EMAIL
- GEOLOCATION
- TEXTAREA
- LONGTEXTAREA
- REFERENCE
- MULTIPICKLIST
- NUMBER
- PERCENT
- PHONE
- PICKLIST
- COMBOBOX
- STRING
- TIME
- URL
- INTEGER
- DOUBLE
- ID
- ENCRYPTEDSTRING
- Unknown
type: string
rollup:
type: object
required:
- objectName
- sweepFieldName
- fieldType
- properties
SweepFieldOutgoingDto:
type: object
properties:
id:
type: string
objectName:
type: string
sweepFieldName:
type: string
sfFieldName:
type: string
fieldType:
type: string
enum:
- Id
- Address
- AutoNumber
- Checkbox
- Currency
- Date
- DateTime
- Email
- Html
- EncryptedText
- Geolocation
- Hierarchy
- LongTextArea
- Lookup
- MasterDetail
- MultiselectPicklist
- Name
- Name2
- Number
- Percent
- Phone
- Picklist
- Summary
- Text
- TextArea
- Time
- Unknown
- Url
- FormulaCheckbox
- FormulaCurrency
- FormulaDate
- FormulaDateTime
- FormulaNumber
- FormulaPercent
- FormulaText
- FormulaTime
- Combobox
isCompound:
type: boolean
properties:
type: object
origin:
type: string
enum:
- SF_STANDARD
- SF_CUSTOM
- SWEEP_CUSTOM
- MP_CUSTOM
isRequired:
type: boolean
isCreatedInSweep:
type: boolean
helpText:
type: string
description:
type: string
compoundFieldId:
type: string
rollup:
type: object
required:
- objectName
- sweepFieldName
- fieldType
- properties
- rollup
DeployRollupDto:
type: object
properties:
deployToOrgIds:
minItems: 1
type: array
items:
type: string
format: uuid
required:
- deployToOrgIds
CreateRollupDto:
type: object
properties:
rollupField:
$ref: '#/components/schemas/SweepFieldRollupDto'
objectName:
type: string
required:
- rollupField
- objectName
AdminNotificationDto:
type: object
properties:
note:
type: string
UpdateRollupDto:
type: object
properties:
rollupField:
$ref: '#/components/schemas/SweepFieldRollupDto'
required:
- rollupField
RollupDto:
type: object
properties:
name:
type: string
rollupId:
type: string
versionId:
type: string
rollupField:
$ref: '#/components/schemas/SweepFieldOutgoingDto'
crmOrgId:
type: string
accountId:
type: string
objectName:
type: string
status:
enum:
- Draft
- Deployed
type: string
isActive:
type: boolean
notifyAdmin:
type: boolean
priority:
type: number
type:
type: string
createdById:
type: string
createdAt:
format: date-time
type: string
updatedById:
type: string
updatedAt:
format: date-time
type: string
required:
- name
- rollupId
- versionId
- rollupField
- crmOrgId
- accountId
- objectName
- status
- isActive
- notifyAdmin
- priority
- type
- createdById
- createdAt
- updatedById
- updatedAt
securitySchemes:
bearer:
scheme: bearer
bearerFormat: JWT
type: http