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 Users API

The Users API from Sweep — 15 operation(s) for users.

Sweep Users API is one of 70 APIs that Sweep publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and authentication docs.

This API exposes 18 operations across 15 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 0.1.

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

18 operations 15 paths 11 schemas 2 DELETE6 GET3 PATCH5 POST2 PUT

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

Paths & Operations 18

Across 15 paths, the API surfaces 18 operations — 2 DELETE, 6 GET, 3 PATCH, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 18
GET
/users
Get current logged in user.
UsersController_getUser → 200
PATCH
/users
Patches user details
UsersController_patchUserDetails body → 200
GET
/users/permissions
UsersController_getPermissions → 200
DELETE
/users/{userId}
UsersController_deleteUser 1 param → 200
POST
/users/account/trial
UsersController_startTrial → 201
PATCH
/users/account/onboarding
UsersController_updateOnboardingStatus body → 200
POST
/users/account/invitations
UsersController_createInvitation body → 201
DELETE
/users/account/invitations/{email}
UsersController_removeInvitation 1 param → 200
GET
/users/account
Get Users and pending invitations of account.
UsersController_getUsersAndInvitationOfAccount 1 param → 200
GET
/users/ws-code
returns WebSocket Registration code. This is used to connect between the websocket and the user ID. TODO: Deprecate for a more holistic solution that uses the Bearer token in the WebSocket.
UsersController_getWSRegistrationCode → 200
GET
/users/preferences
Returns the user preferences for the current user
UsersController_getUserPreferences → 200
PATCH
/users/preferences
Patches user preferences
UsersController_patchUserPreferences body → 200
PUT
/users/preferences
Replaces the preferences
UsersController_putUserPreferences body → 200
PUT
/users/{userId}/role
Change user role
UsersController_updateUserRoleGroup 1 param body → 200
POST
/users/image
UsersController_uploadImage body → 201
GET
/users/clearbit-enrichment
UsersController_getClearbitEnrichment → 200
POST
/users/hubspot-enrichment
UsersController_setHubspotEnrichment → 201
POST
/users/{orgId}/mcp-org
UsersController_setMcpOrgForUser 1 param → 201

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are UserDto (11 properties), InvitationDto (6 properties), UserPreferencesDto (4 properties), EditUserDto (4 properties). Each schema is shown below with its type and property counts.

ImageDataDto
object
1 property 1 required
InvitationDto
object
6 properties 5 required
UserRoleDto
object
1 property 1 required
UpdateOnboardingStatusDto
object
1 property 1 required
GetStartedDto
object
QuestionnaireDto
object
2 properties 1 required
UserPreferencesDto
object
4 properties
QuestionnaireDataDto
object
2 properties
EditUserDto
object
4 properties
UserDto
object
11 properties 9 required
UserEmojiDto
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sweep-users-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 Users 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.