Dregs Groups API

openapi: 3.2.0
info:
  title: Dregs Groups API
  description: 'Customer REST API for sending events and reading fraud scores, identities, devices, escalations, channels, datasets, and mappings.


    Authenticate with a secret key created in the dashboard under Settings > Credentials (security scheme secretKey). Send it as a Bearer token: Authorization: Bearer sk_... The key acts as an admin of that credential''s team. POST /api/events and GET /api/devices/{fingerprint} also accept the credential''s public key (security scheme publicKey, Bearer pk_...). Public keys may be embedded in a browser. Secret keys must not.


    This document is the curated public surface. Dashboard sign-in, billing, team administration, and trainer tools are not included.'
  version: '1.0'
servers:
- url: https://dregs.com
  description: Dregs API
security:
- secretKey: []
tags:
- name: Groups
  description: Groups (organizations, teams, workspaces, or whatever your app calls them) that identities belong to
paths:
  /api/groups/{type}/{id}/identities/{identityId}:
    put:
      tags:
      - Groups
      summary: Add identity to group
      description: Make an identity a member of a group. Adding an existing member is a no-op.
      operationId: addGroupIdentity
      parameters:
      - name: type
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: identityId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Identity is a member
        '401':
          description: Authentication required
        '404':
          description: Group or identity not found
      security:
      - secretKey: []
    delete:
      tags:
      - Groups
      summary: Remove identity from group
      description: Remove an identity from a group, for example when a user leaves a team
      operationId: removeGroupIdentity
      parameters:
      - name: type
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: identityId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Identity removed
        '401':
          description: Authentication required
        '404':
          description: Identity is not a member of the group
      security:
      - secretKey: []
  /api/groups:
    get:
      tags:
      - Groups
      summary: Group list
      description: List groups of every type, or of one type, optionally only those an identity belongs to
      operationId: listGroups
      parameters:
      - name: request
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/V1ListGroupsRequest'
      responses:
        '200':
          description: Groups retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1PageV1Group'
        '400':
          description: Invalid group type
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1PageV1Group'
        '401':
          description: Authentication required
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1PageV1Group'
      security:
      - secretKey: []
    post:
      tags:
      - Groups
      summary: Create group
      description: Create a group, or merge attributes into it if one with the same type and id already exists. attributes is required; send an empty object when there are none. The type defaults to organization.
      operationId: createGroup
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1CreateGroupRequest'
        required: true
      responses:
        '201':
          description: Group created
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1Group'
        '400':
          description: Invalid request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1Group'
        '401':
          description: Authentication required
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1Group'
      security:
      - secretKey: []
  /api/groups/{type}/{id}:
    get:
      tags:
      - Groups
      summary: Get group
      description: Get a single group by type and ID, with its attributes and member count
      operationId: getGroup
      parameters:
      - name: type
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Group found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1Group'
        '401':
          description: Authentication required
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1Group'
        '404':
          description: Group not found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1Group'
      security:
      - secretKey: []
    patch:
      tags:
      - Groups
      summary: Update group
      description: Merge attributes into an existing group
      operationId: updateGroup
      parameters:
      - name: type
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1UpdateGroupRequest'
        required: true
      responses:
        '200':
          description: Group updated
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1Group'
        '400':
          description: Invalid request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1Group'
        '401':
          description: Authentication required
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1Group'
        '404':
          description: Group not found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/V1Group'
      security:
      - secretKey: []
components:
  schemas:
    V1UpdateGroupRequest:
      type: object
      properties:
        attributes:
          type: object
          additionalProperties: {}
      required:
      - attributes
    V1PageV1Group:
      type: object
      description: Paginated response wrapper
      properties:
        pageNumber:
          type: integer
          format: int32
          description: Current page number (0-based)
        pageSize:
          type: integer
          format: int32
          description: Number of items per page
        totalPages:
          type: integer
          format: int64
          description: Total number of pages
        totalElements:
          type: integer
          format: int64
          description: Total number of items across all pages
        content:
          type: array
          description: List of items on this page
          items:
            $ref: '#/components/schemas/V1Group'
        first:
          type: boolean
          description: Whether this is the first page
        last:
          type: boolean
          description: Whether this is the last page
        numberOfElements:
          type: integer
          format: int32
          description: Number of items on this page
    V1Group:
      type: object
      properties:
        type:
          type: string
        id:
          type: string
        displayName:
          type: string
        identityCount:
          type: integer
          format: int64
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        lastTrackedAt:
          type: string
          format: date-time
        data:
          type: object
          additionalProperties: {}
    V1ListGroupsRequest:
      type: object
      properties:
        pageNumber:
          type: integer
          format: int32
          minimum: 0
        pageSize:
          type: integer
          format: int32
          maximum: 100
          minimum: 1
        order:
          type: string
          enum:
          - ASC
          - DESC
        sort:
          type: string
        type:
          type: string
        identity:
          type: string
        term:
          type: string
    V1CreateGroupRequest:
      type: object
      description: Create a group, or merge attributes into the existing group with the same type and id. attributes is required; send an empty object when there are none.
      properties:
        type:
          type: string
          description: The group's type, such as organization or team. Defaults to organization.
          example: organization
        id:
          type: string
          description: The group's ID in your system.
          example: org_678
          maxLength: 64
          minLength: 0
        attributes:
          type: object
          additionalProperties: {}
          description: Attributes merged into the group. Required; send an empty object when there are none.
      required:
      - attributes
      - id
  securitySchemes:
    secretKey:
      type: http
      description: Customer secret key from Settings > Credentials, sent as a Bearer token. The token value starts with sk_. It acts as an admin of that credential's team for every operation in this document. MCP tokens (dmcp_) are refused. Prefer the publicKey scheme on operations that accept a pk_ key.
      scheme: bearer
      bearerFormat: sk_
    publicKey:
      type: http
      description: Customer public key from Settings > Credentials, sent as a Bearer token. The token value starts with pk_. Accepted only by POST /api/events and GET /api/devices/{fingerprint}. It may be embedded in a browser. It cannot call the other operations in this document.
      scheme: bearer
      bearerFormat: pk_