Sweep

Sweep Assignment Groups API

The Assignment Groups API from Sweep — 3 operation(s) for assignment groups.

GitHub OpenAPI

Operations 8

GET /assignment_groups Assignment groups controller get assignment groups #
POST /assignment_groups Assignment groups controller insert group #
GET /assignment_groups/credit-queue Assignment groups controller get credit queue #
POST /assignment_groups/credit-queue Assignment groups controller create credit queue #
PUT /assignment_groups/credit-queue Assignment groups controller update credit queue #
GET /assignment_groups/{groupId} Assignment groups controller get assignment group #
DELETE /assignment_groups/{groupId} Assignment groups controller delete group #
PUT /assignment_groups/{groupId} Assignment groups controller update group #

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-assignment-groups-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-assignment-groups-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-assignment-groups-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sweep Assignment Groups 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: Assignment Groups
paths:
  /assignment_groups:
    get:
      operationId: AssignmentGroupsController_getAssignmentGroups
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
      - bearer: []
      tags:
      - Assignment Groups
      summary: Assignment groups controller get assignment groups
      x-summary-source: derived
    post:
      operationId: AssignmentGroupsController_insertGroup
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssignmentGroupSetterDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssignmentGroupSetterDto'
      security:
      - bearer: []
      tags:
      - Assignment Groups
      summary: Assignment groups controller insert group
      x-summary-source: derived
  /assignment_groups/credit-queue:
    get:
      operationId: AssignmentGroupsController_getCreditQueue
      parameters:
      - name: groupApiName
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
      security:
      - bearer: []
      tags:
      - Assignment Groups
      summary: Assignment groups controller get credit queue
      x-summary-source: derived
    post:
      operationId: AssignmentGroupsController_createCreditQueue
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditQueueCreateConfigDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      tags:
      - Assignment Groups
      summary: Assignment groups controller create credit queue
      x-summary-source: derived
    put:
      operationId: AssignmentGroupsController_updateCreditQueue
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditQueueUpdateConfigDto'
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - Assignment Groups
      summary: Assignment groups controller update credit queue
      x-summary-source: derived
  /assignment_groups/{groupId}:
    get:
      operationId: AssignmentGroupsController_getAssignmentGroup
      parameters:
      - name: groupId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
      - bearer: []
      tags:
      - Assignment Groups
      summary: Assignment groups controller get assignment group
      x-summary-source: derived
    delete:
      operationId: AssignmentGroupsController_deleteGroup
      parameters:
      - name: groupId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - Assignment Groups
      summary: Assignment groups controller delete group
      x-summary-source: derived
    put:
      operationId: AssignmentGroupsController_updateGroup
      parameters:
      - name: groupId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssignmentGroupSetterDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssignmentGroupSetterDto'
      security:
      - bearer: []
      tags:
      - Assignment Groups
      summary: Assignment groups controller update group
      x-summary-source: derived
components:
  schemas:
    EmojiDto:
      type: object
      properties:
        content:
          type: string
        bgColor:
          type: string
    CreditQueueUpdateConfigDto:
      type: object
      properties:
        recordsToUpdate:
          type: array
          items:
            $ref: '#/components/schemas/CreditQueueUpdateRecordDto'
        recordsToDelete:
          type: array
          items:
            type: string
    AssignmentGroupAvatarDto:
      type: object
      properties:
        emoji:
          $ref: '#/components/schemas/EmojiDto'
        imageUrl:
          type: string
        imageUploadBase64:
          type: string
    CreditQueueCreateRecordDto:
      type: object
      properties:
        userId:
          type: string
        creditsTargetAmount:
          type: number
      required:
      - userId
      - creditsTargetAmount
    CreditQueueUpdateRecordDto:
      type: object
      properties:
        sfId:
          type: string
        index:
          type: number
      required:
      - sfId
      - index
    AssignmentGroupSetterDto:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        avatar:
          $ref: '#/components/schemas/AssignmentGroupAvatarDto'
        members:
          type: array
          items:
            $ref: '#/components/schemas/AssignmentGroupMemberSetterDto'
        groupLimit:
          type: object
      required:
      - name
      - description
      - avatar
      - members
    AssignmentGroupMemberSetterDto:
      type: object
      properties:
        userId:
          type: string
        membershipActive:
          type: boolean
        weight:
          type: number
        limitValue:
          type: number
        creditCount:
          type: number
          minimum: 0
      required:
      - userId
      - membershipActive
      - weight
    CreditQueueCreateConfigDto:
      type: object
      properties:
        groupApiName:
          type: string
        creditsList:
          type: array
          items:
            $ref: '#/components/schemas/CreditQueueCreateRecordDto'
      required:
      - groupApiName
      - creditsList
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http