Certifyos Anchor Group API

openapi: 3.2.0
info:
  description: API for Certify application
  title: Certify API Layer Anchor Group API
  version: 1.0.0
servers:
- url: http://localhost:9000
  description: Local Development Server
- url: https://api-service.staging.certifyos.com
  description: Staging Server
- url: https://api-service.internal.certifyos.com
  description: Internal Server
- url: https://api-service.test.certifyos.com
  description: Test Server
- url: https://api-service.demo.certifyos.com
  description: Demo Server
- url: https://api-service.certifyos.com
  description: Production Server
tags:
- name: AnchorGroup
  description: Anchor Groups behind the Anchor Date Operations screen (read-only).
paths:
  /api/v1/anchor-groups:
    get:
      summary: List Anchor Groups
      description: Options for the Anchor Ops group selector, ordered by name — the order is applied by the DAL across the whole result set, so paging is stable. Returns every Anchor Group in v1; once per-group permissions land (CP-37167 era, model CP-38511) it returns only the caller's viewable set, behind the same contract.
      operationId: anchorOperationsListGroups
      tags:
      - AnchorGroup
      parameters:
      - description: Page number (0-based)
        name: page
        in: query
        schema:
          type: integer
          format: int32
          default: '0'
      - description: Page size (max 100)
        name: size
        in: query
        schema:
          type: integer
          format: int32
          default: '100'
      - name: tenant-id
        in: header
        required: true
        description: Tenant ID
        schema:
          type: string
      responses:
        '200':
          description: Anchor Groups
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnchorGroupPagedResponse'
        '400':
          description: Invalid pagination
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
      - jwt: []
components:
  schemas:
    ApiError:
      type: object
      description: Standard API error response containing a list of error objects
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorObject'
          description: List of error objects describing validation or processing failures
    AnchorGroupPagedResponse:
      type: object
      required:
      - data
      description: Paginated list of Anchor Groups.
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AnchorGroup'
          description: Anchor Groups on this page.
        totalCount:
          type: integer
          format: int64
          description: Total Anchor Groups across all pages.
    AnchorGroup:
      type: object
      required:
      - id
      description: An Anchor Group the caller can view.
      properties:
        id:
          type: string
          description: Anchor Group id.
        name:
          type: string
          description: Anchor Group display name.
    ErrorObject:
      type: object
      description: Individual error object containing details about a specific validation or processing error
      properties:
        httpStatus:
          type: integer
          format: int32
          examples:
          - 400
          description: HTTP status code for this error
        reason:
          type: string
          examples:
          - VALIDATION_ERROR
          description: Error reason/code
        title:
          type: string
          examples:
          - 'Validation failed for field: eventTypes'
          description: Error title/summary
        detail:
          type: string
          examples:
          - eventTypes is required and cannot be empty or null
          description: Detailed error message
        rejectedValue:
          type: string
          description: The value that was rejected, omitted for sensitive fields such as SSN
  securitySchemes:
    jwt:
      type: http
      description: JWT Authentication - Provide only the raw token without Bearer prefix
      scheme: bearer
      bearerFormat: JWT
x-provenance:
  method: harvested
  publisher: Certifyos
  source: https://api-service.internal.certifyos.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)