> ## 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.

# List the signed-in supplier’s schedules

> The supplier’s schedules as the dashboard lists them: ACTIVE ones by default, INACTIVE and soft-deleted ones on request. Requires the API key and the supplier’s user token.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/projects/{projectId}/suppliers/me/schedules
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/schedules:
    get:
      tags:
        - Supplier plane
      summary: List the signed-in supplier’s schedules
      description: >-
        The supplier’s schedules as the dashboard lists them: ACTIVE ones by
        default, INACTIVE and soft-deleted ones on request. 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
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
            description: Also return INACTIVE schedules (kept but offering nothing).
            example: 'false'
          required: false
          description: Also return INACTIVE schedules (kept but offering nothing).
          name: includeInactive
          in: query
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
            description: Also return soft-deleted schedules.
            example: 'false'
          required: false
          description: Also return soft-deleted schedules.
          name: includeDeleted
          in: query
      responses:
        '200':
          description: Schedules list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        scheduleId:
                          type: string
                        projectId:
                          type: string
                        supplierId:
                          type: string
                        status:
                          type: string
                          enum:
                            - ACTIVE
                            - INACTIVE
                        deleted:
                          type: boolean
                        timezone:
                          type: string
                        startDate:
                          type: string
                        endDate:
                          type: string
                        rrule:
                          type: string
                        exdates:
                          type: array
                          items:
                            type: string
                        weeklyTimeRanges:
                          type: array
                          items:
                            type: object
                            properties:
                              dayOfWeek:
                                type: string
                                enum:
                                  - MO
                                  - TU
                                  - WE
                                  - TH
                                  - FR
                                  - SA
                                  - SU
                                description: >-
                                  The weekday this range falls on, in the row’s
                                  zone.
                                example: MO
                              startTime:
                                type: string
                                pattern: ^([01]\d|2[0-3]):[0-5]\d$
                                description: Wall-clock start, HH:MM in the row’s zone.
                                example: '09:00'
                              endTime:
                                type: string
                                pattern: ^([01]\d|2[0-3]):[0-5]\d$
                                description: >-
                                  Wall-clock end, HH:MM in the row’s zone; must
                                  differ from startTime.
                                example: '17:00'
                              crossesMidnight:
                                type: boolean
                                description: >-
                                  True exactly when endTime is earlier than
                                  startTime (the range ends next day).
                                example: false
                              sortOrder:
                                type: integer
                                minimum: 0
                                description: >-
                                  Display order among the ranges of one day,
                                  from 0.
                                example: 0
                            required:
                              - dayOfWeek
                              - startTime
                              - endTime
                              - crossesMidnight
                              - sortOrder
                        appliesToAllOfferings:
                          type: boolean
                        serviceOfferingIds:
                          type: array
                          items:
                            type: string
                        locationRefs:
                          type: array
                          items:
                            type: object
                            properties:
                              locationId:
                                type: string
                                minLength: 1
                                description: >-
                                  A location of the project the supplier works
                                  at under this schedule.
                                example: loc_01kv60qgnef2kt3pvqgwmkbzfr
                              locationType:
                                type: string
                                enum:
                                  - PHYSICAL
                                  - VIRTUAL
                                description: >-
                                  PHYSICAL (an address) or VIRTUAL (online);
                                  must match the location’s own type.
                                example: PHYSICAL
                            required:
                              - locationId
                              - locationType
                        travelZoneRef:
                          oneOf:
                            - type: object
                              properties:
                                travelZoneSource:
                                  type: string
                                  enum:
                                    - PROJECT_LOCATION
                                  description: >-
                                    The zone is a TRAVEL_ZONE location defined
                                    by the project.
                                  example: PROJECT_LOCATION
                                travelZoneLocationId:
                                  type: string
                                  minLength: 1
                                  description: The project’s TRAVEL_ZONE location.
                                  example: loc_01kv60qgnef2kt3pvqgwmkbzfr
                              required:
                                - travelZoneSource
                                - travelZoneLocationId
                            - type: object
                              properties:
                                travelZoneSource:
                                  type: string
                                  enum:
                                    - SUPPLIER_TRAVEL_ZONE
                                  description: >-
                                    The zone is one the supplier drew or set
                                    themselves.
                                  example: SUPPLIER_TRAVEL_ZONE
                                supplierTravelZoneId:
                                  type: string
                                  minLength: 1
                                  description: The supplier’s own travel zone.
                                  example: stz_01kv60qgnef2kt3pvqgwmkbzfr
                              required:
                                - travelZoneSource
                                - supplierTravelZoneId
                        startLocation:
                          type: object
                          nullable: true
                          properties:
                            address:
                              $ref: '#/components/schemas/Address'
                            latitude:
                              type: number
                              minimum: -90
                              maximum: 90
                              description: Latitude of the address, in decimal degrees.
                              example: 43.6426
                            longitude:
                              type: number
                              minimum: -180
                              maximum: 180
                              description: Longitude of the address, in decimal degrees.
                              example: -79.3871
                          required:
                            - address
                            - latitude
                            - longitude
                        endLocation:
                          type: object
                          nullable: true
                          properties:
                            address:
                              $ref: '#/components/schemas/Address'
                            latitude:
                              type: number
                              minimum: -90
                              maximum: 90
                              description: Latitude of the address, in decimal degrees.
                              example: 43.6426
                            longitude:
                              type: number
                              minimum: -180
                              maximum: 180
                              description: Longitude of the address, in decimal degrees.
                              example: -79.3871
                          required:
                            - address
                            - latitude
                            - longitude
                        driveTiming:
                          type: string
                          nullable: true
                          enum:
                            - INSIDE_HOURS
                            - OUTSIDE_HOURS
                            - null
                        maxTravelOnStartDrive:
                          type: boolean
                          nullable: true
                        maxTravelOnEndDrive:
                          type: boolean
                          nullable: true
                        physicalLocationIdsInsideTravelZone:
                          type: array
                          items:
                            type: string
                        dateRangeLabel:
                          type: string
                        timeRangeSummary:
                          type: string
                        daysSummary:
                          type: string
                        coverageAreaSummary:
                          type: string
                        offeringsSummary:
                          type: string
                        version:
                          type: integer
                          minimum: 0
                          exclusiveMinimum: true
                        createdAt:
                          type: string
                        updatedAt:
                          type: string
                        deletedAt:
                          type: string
                        createdBy:
                          type: string
                        updatedBy:
                          type: string
                        deletedBy:
                          type: string
                      required:
                        - scheduleId
                        - projectId
                        - supplierId
                        - status
                        - deleted
                        - timezone
                        - startDate
                        - endDate
                        - rrule
                        - exdates
                        - weeklyTimeRanges
                        - appliesToAllOfferings
                        - serviceOfferingIds
                        - locationRefs
                        - dateRangeLabel
                        - timeRangeSummary
                        - daysSummary
                        - coverageAreaSummary
                        - offeringsSummary
                        - version
                        - createdAt
                        - updatedAt
                        - createdBy
                        - updatedBy
                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); or no such schedule of
            theirs (NOT_FOUND)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
        - ApiKeyAuth: []
          EndUserBearer: []
components:
  schemas:
    Address:
      type: object
      nullable: true
      properties:
        addressOneLine:
          type: string
          minLength: 1
          description: The whole address on one line, as a person would write it.
          example: 10 Main St, Toronto, ON M5V 1A1, Canada
        streetNumber:
          type: string
          minLength: 1
          description: The street number.
          example: '10'
        streetName:
          type: string
          minLength: 1
          description: The street name.
          example: Main St
        city:
          type: string
          minLength: 1
          description: The city or town.
          example: Toronto
        state:
          type: string
          minLength: 1
          description: The state, province or region; an ISO 3166-2 code when one matches.
          example: 'ON'
        country:
          type: string
          minLength: 1
          description: The country; ISO 3166-1 alpha-2, alpha-3 or the English name.
          example: CA
        zipCode:
          type: string
          minLength: 1
          description: The postal or ZIP code, in any national format.
          example: M5V 1A1
        unitNumber:
          type: string
          nullable: true
          description: The unit, suite or apartment, if any.
          example: 4B
      required:
        - addressOneLine
        - streetNumber
        - streetName
        - city
        - state
        - country
        - zipCode
    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.