> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gomarketbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# The signed-in supplier’s unread count and open conditions

> What a bell badge needs, in one cheap call: the unread alert count (capped at 100, `unreadCapped` when there may be more) and the open conditions — states computed on every read, such as `MY_REPORTS_OVERDUE` ("N bookings need your report"). Conditions have no read state and leave when resolved; their counts may lag up to 5 minutes. Poll it no more often than every 60 seconds; the response is `Cache-Control: no-store`. Requires the API key and the supplier’s user token.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/projects/{projectId}/suppliers/me/alerts/summary
openapi: 3.0.0
info:
  title: MarketBox 2.0 Open API
  version: 1.0.0
  description: >-
    The MarketBox public API for building booking experiences. Core model:
    create an order, then draw its order items down into bookings. Single
    bookings reference an order item per service line; package bookings draw one
    PACKAGE item down across N sessions. To schedule a package, build a slate
    (POST /availability/package-slate) and book it by slateId (POST
    /orders/{orderId}/package-bookings). See the guides for end-to-end
    walkthroughs.
  contact:
    name: MarketBox support
servers:
  - url: https://apiv2.gomarketbox.com
    description: MarketBox Open API
security:
  - ApiKeyAuth: []
paths:
  /v1/projects/{projectId}/suppliers/me/alerts/summary:
    get:
      tags:
        - Supplier plane
      summary: The signed-in supplier’s unread count and open conditions
      description: >-
        What a bell badge needs, in one cheap call: the unread alert count
        (capped at 100, `unreadCapped` when there may be more) and the open
        conditions — states computed on every read, such as `MY_REPORTS_OVERDUE`
        ("N bookings need your report"). Conditions have no read state and leave
        when resolved; their counts may lag up to 5 minutes. Poll it no more
        often than every 60 seconds; the response is `Cache-Control: no-store`.
        Requires the API key and the supplier’s user token.
      parameters:
        - schema:
            type: string
            minLength: 1
            description: >-
              The project (tenant) that owns the resource. Every resource in
              this API is scoped to a project, and your API key is restricted to
              the projects it was issued for — a project outside that scope
              returns 403.
            example: prj_01kv60qgnef2kt3pvqgwmkbzfr
          required: true
          description: >-
            The project (tenant) that owns the resource. Every resource in this
            API is scoped to a project, and your API key is restricted to the
            projects it was issued for — a project outside that scope returns
            403.
          name: projectId
          in: path
      responses:
        '200':
          description: The unread count and conditions
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      unreadCount:
                        type: integer
                        minimum: 0
                        description: Unread alerts for the acting audience, capped at 100.
                        example: 4
                      unreadCapped:
                        type: boolean
                        description: True when the count hit the cap and there may be more.
                        example: false
                      conditions:
                        type: array
                        items:
                          type: object
                          properties:
                            kind:
                              type: string
                              enum:
                                - REPORTS_OVERDUE
                                - DISPUTED
                                - PAYMENTS_SETUP_INCOMPLETE
                                - MY_REPORTS_OVERDUE
                              description: >-
                                Which open condition this is. A supplier sees
                                `MY_REPORTS_OVERDUE` (their bookings awaiting
                                their report). Staff see `REPORTS_OVERDUE`
                                (bookings awaiting a report), `DISPUTED`
                                (disputed bookings) and
                                `PAYMENTS_SETUP_INCOMPLETE`.
                              example: REPORTS_OVERDUE
                            count:
                              type: integer
                              minimum: 0
                              description: >-
                                How many, for the counted conditions. Capped at
                                100.
                              example: 3
                            target:
                              oneOf:
                                - type: object
                                  properties:
                                    kind:
                                      type: string
                                      enum:
                                        - booking
                                    bookingId:
                                      type: string
                                      minLength: 1
                                  required:
                                    - kind
                                    - bookingId
                                  description: 'One booking: its detail page.'
                                - type: object
                                  properties:
                                    kind:
                                      type: string
                                      enum:
                                        - order
                                    orderId:
                                      type: string
                                      minLength: 1
                                  required:
                                    - kind
                                    - orderId
                                  description: 'One order: its detail page.'
                                - type: object
                                  properties:
                                    kind:
                                      type: string
                                      enum:
                                        - email
                                    emailId:
                                      type: string
                                      minLength: 1
                                    bookingId:
                                      type: string
                                      minLength: 1
                                  required:
                                    - kind
                                    - emailId
                                  description: >-
                                    One sent email, and the booking it was about
                                    when known.
                                - type: object
                                  properties:
                                    kind:
                                      type: string
                                      enum:
                                        - review
                                    supplierId:
                                      type: string
                                      minLength: 1
                                  required:
                                    - kind
                                  description: >-
                                    The review list, filtered to one supplier
                                    when known.
                                - type: object
                                  properties:
                                    kind:
                                      type: string
                                      enum:
                                        - team
                                  required:
                                    - kind
                                  description: 'The team: the project’s suppliers and staff.'
                                - type: object
                                  properties:
                                    kind:
                                      type: string
                                      enum:
                                        - settings
                                    area:
                                      type: string
                                      enum:
                                        - payments
                                  required:
                                    - kind
                                    - area
                                  description: The project’s payment settings.
                                - type: object
                                  properties:
                                    kind:
                                      type: string
                                      enum:
                                        - bookings
                                    filter:
                                      type: string
                                      enum:
                                        - awaiting
                                        - disputed
                                  required:
                                    - kind
                                    - filter
                                  description: >-
                                    The project’s bookings list, filtered to
                                    those awaiting a report or disputed.
                                - type: object
                                  properties:
                                    kind:
                                      type: string
                                      enum:
                                        - myAppointments
                                    filter:
                                      type: string
                                      enum:
                                        - awaiting
                                  required:
                                    - kind
                                    - filter
                                  description: >-
                                    The supplier’s own bookings list, filtered
                                    to those awaiting their report.
                              description: >-
                                What the alert links to, as data rather than a
                                URL: map it to your own page. `kind` names the
                                page.
                              example:
                                kind: booking
                                bookingId: bk_01kv60qge5eh59ap0gw0pqrrys
                          required:
                            - kind
                            - target
                    required:
                      - unreadCount
                      - unreadCapped
                      - conditions
                required:
                  - data
        '401':
          description: Missing or invalid API key or user token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: >-
            The API key cannot access this project (FORBIDDEN) or lacks standard
            API access (CAPABILITY_NOT_GRANTED); or the signed-in user has no
            MarketBox account record (FORBIDDEN, "User account not found.
            Complete registration first."); or the signed-in user is not a
            member of the project (NOT_A_MEMBER), their membership has ended
            (MEMBERSHIP_INACTIVE), or the roles they act under lack the route’s
            permission (NO_SUPPLIER_ROLE); or X-MB-Acting-Role names a role they
            do not hold (ACTING_ROLE_NOT_HELD)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: >-
            The signed-in user has no supplier record here: no SUPPLIER among
            the roles they act under (NO_SUPPLIER_ROLE), or no single supplier
            record linked to them (SUPPLIER_NOT_LINKED)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
        - ApiKeyAuth: []
          EndUserBearer: []
components:
  schemas:
    ErrorMessage:
      type: object
      properties:
        code:
          type: string
          description: Stable machine-readable error code, e.g. NOT_FOUND.
        message:
          type: string
          description: Human-readable description of what went wrong.
        statusCode:
          type: integer
          description: The HTTP status code of this response.
        requestId:
          type: string
          description: >-
            The id of this request, also returned as the X-Request-Id header.
            Quote it in a support ticket.
      required:
        - code
        - message
        - statusCode
        - requestId
      example:
        code: NOT_FOUND
        message: Booking not found
        statusCode: 404
        requestId: a3f1c2de-9b64-4a2f-8f0e-5c9d1b7a2e10
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key minted in the MarketBox dashboard. Scope is restricted to the
        projects you select at creation time. Every route needs the key's
        standard API access (`*`) except `POST /v1/projects/{projectId}/events`,
        which needs `events:write`; a key without `*` is refused with 403
        `CAPABILITY_NOT_GRANTED`.
    EndUserBearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        The signed-in person's Cognito access token, issued to this
        application's app client. Sent with the API key on the /clients/me and
        /suppliers/me routes.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.