Sweep

Sweep Users API

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

Documentation GitHub OpenAPI

Operations 18

GET /users Get current logged in user #

PATCH /users Patches user details #

GET /users/permissions Users controller get permissions #

DELETE /users/{userId} Users controller delete user #

POST /users/account/trial Users controller start trial #

PATCH /users/account/onboarding Users controller update onboarding status #

POST /users/account/invitations Users controller create invitation #

DELETE /users/account/invitations/{email} Users controller remove invitation #

GET /users/account Get Users and pending invitations of account #

GET /users/ws-code returns WebSocket Registration code. #

GET /users/preferences Returns the user preferences for the current user #

PATCH /users/preferences Patches user preferences #

PUT /users/preferences Replaces the preferences #

PUT /users/{userId}/role Change user role #

POST /users/image Users controller upload image #

GET /users/clearbit-enrichment Users controller get clearbit enrichment #

POST /users/hubspot-enrichment Users controller set hubspot enrichment #

POST /users/{orgId}/mcp-org Users controller set mcp org for user #

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-users-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

openapi: 3.2.0
info:
  title: Sweep Users 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: Users
paths:
  /users:
    get:
      operationId: UsersController_getUser
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDto'
      security:
      - bearer: []
      summary: Get current logged in user
      tags:
      - Users
    patch:
      operationId: UsersController_patchUserDetails
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditUserDto'
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Patches user details
      tags:
      - Users
  /users/permissions:
    get:
      operationId: UsersController_getPermissions
      parameters: []
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - Users
      summary: Users controller get permissions
      x-summary-source: derived
  /users/{userId}:
    delete:
      operationId: UsersController_deleteUser
      parameters:
      - name: userId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
      - bearer: []
      tags:
      - Users
      summary: Users controller delete user
      x-summary-source: derived
  /users/account/trial:
    post:
      operationId: UsersController_startTrial
      parameters: []
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      tags:
      - Users
      summary: Users controller start trial
      x-summary-source: derived
  /users/account/onboarding:
    patch:
      operationId: UsersController_updateOnboardingStatus
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOnboardingStatusDto'
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - Users
      summary: Users controller update onboarding status
      x-summary-source: derived
  /users/account/invitations:
    post:
      operationId: UsersController_createInvitation
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvitationDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      tags:
      - Users
      summary: Users controller create invitation
      x-summary-source: derived
  /users/account/invitations/{email}:
    delete:
      operationId: UsersController_removeInvitation
      parameters:
      - name: email
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - Users
      summary: Users controller remove invitation
      x-summary-source: derived
  /users/account:
    get:
      operationId: UsersController_getUsersAndInvitationOfAccount
      parameters:
      - name: includeInvitations
        required: true
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Get Users and pending invitations of account
      tags:
      - Users
  /users/ws-code:
    get:
      operationId: UsersController_getWSRegistrationCode
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: string
      security:
      - bearer: []
      summary: returns WebSocket Registration code.
      tags:
      - Users
  /users/preferences:
    get:
      operationId: UsersController_getUserPreferences
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserPreferencesDto'
      security:
      - bearer: []
      summary: Returns the user preferences for the current user
      tags:
      - Users
    patch:
      operationId: UsersController_patchUserPreferences
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserPreferencesDto'
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Patches user preferences
      tags:
      - Users
    put:
      operationId: UsersController_putUserPreferences
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserPreferencesDto'
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Replaces the preferences
      tags:
      - Users
  /users/{userId}/role:
    put:
      operationId: UsersController_updateUserRoleGroup
      parameters:
      - name: userId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserRoleDto'
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Change user role
      tags:
      - Users
  /users/image:
    post:
      operationId: UsersController_uploadImage
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImageDataDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: string
      security:
      - bearer: []
      tags:
      - Users
      summary: Users controller upload image
      x-summary-source: derived
  /users/clearbit-enrichment:
    get:
      operationId: UsersController_getClearbitEnrichment
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
      - bearer: []
      tags:
      - Users
      summary: Users controller get clearbit enrichment
      x-summary-source: derived
  /users/hubspot-enrichment:
    post:
      operationId: UsersController_setHubspotEnrichment
      parameters: []
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
      - bearer: []
      tags:
      - Users
      summary: Users controller set hubspot enrichment
      x-summary-source: derived
  /users/{orgId}/mcp-org:
    post:
      operationId: UsersController_setMcpOrgForUser
      parameters:
      - name: orgId
        required: true
        in: path
        schema:
          type: string
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
      - bearer: []
      tags:
      - Users
      summary: Users controller set mcp org for user
      x-summary-source: derived
components:
  schemas:
    UserPreferencesDto:
      type: object
      properties:
        getStarted:
          $ref: '#/components/schemas/GetStartedDto'
        defaultCreationCrmOrgId:
          type:
          - string
          - 'null'
        questionnaire:
          $ref: '#/components/schemas/QuestionnaireDto'
        tableColumnSettings:
          type: array
          items:
            type: object
    UserRoleDto:
      type: object
      properties:
        roleGroupId:
          type: string
      required:
      - roleGroupId
    UpdateOnboardingStatusDto:
      type: object
      properties:
        status:
          type: string
          enum:
          - ConnectOrg
          - Completed
      required:
      - status
    UserEmojiDto:
      type: object
      properties:
        content:
          type: string
        bgColor:
          type: string
      required:
      - content
      - bgColor
    QuestionnaireDto:
      type: object
      properties:
        status:
          type: string
          enum:
          - COMPLETED
          - NOT_COMPLETED
        data:
          $ref: '#/components/schemas/QuestionnaireDataDto'
      required:
      - status
    QuestionnaireDataDto:
      type: object
      properties:
        role:
          type: string
          enum:
          - ADMIN
          - BUSINESS_SYSTEMS
          - OPERATIONS
          - SALES
          - MARKETING
          - CUSTOMER_SUCCESS
          - CONSULTANT
          - OTHER
        interests:
          type: array
          items:
            type: string
            enum:
            - DOCUMENTATION
            - AUTOMATIONS
            - ALERTS
            - ROLLUPS
            - ROUTING
            - DEDUPE
            - VISUALIZE
            - PLAN
            - TRACK_CHANGES
            - OTHER
    UserDto:
      type: object
      properties:
        id:
          type: string
        canResetPassword:
          type: boolean
        name:
          type: string
        imageUrl:
          type: string
        jobTitle:
          type: string
        email:
          type: string
        account:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
          required:
          - id
          - name
        roles:
          type: array
          items:
            type: string
        emoji:
          $ref: '#/components/schemas/UserEmojiDto'
        preferences:
          $ref: '#/components/schemas/UserPreferencesDto'
        mcpOrgId:
          type: string
      required:
      - id
      - canResetPassword
      - name
      - imageUrl
      - jobTitle
      - email
      - account
      - emoji
      - preferences
    InvitationDto:
      type: object
      properties:
        email:
          type: string
          format: email
        roleGroupId:
          type: string
        message:
          type: string
        template:
          type: string
          enum:
          - FUNNEL
          - ACCOUNT
        entryPointId:
          type: string
        entryPointName:
          type: string
      required:
      - email
      - roleGroupId
      - template
      - entryPointId
      - entryPointName
    EditUserDto:
      type: object
      properties:
        name:
          type: string
        imageUrl:
          type: string
        jobTitle:
          type: string
        emoji:
          $ref: '#/components/schemas/UserEmojiDto'
    ImageDataDto:
      type: object
      properties:
        image:
          type: string
      required:
      - image
    GetStartedDto:
      type: object
      properties: {}
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http