> ## 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 venues the signed-in supplier may be scheduled at

> The project's active PHYSICAL and VIRTUAL locations (deleted ones never appear), sorted by name: the venues a supplier can name in a schedule, as the MarketBox dashboard lists them, built by the same code. Each is the supplier view of a location, with no travel settings and no status or audit fields. The list is the whole set, not paginated. To list every location, inactive ones and travel zones included, call `GET /locations?includeInactive=true` with the API key alone. Requires the API key and the supplier’s user token.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/projects/{projectId}/suppliers/me/locations
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/locations:
    get:
      tags:
        - Supplier plane
      summary: List the venues the signed-in supplier may be scheduled at
      description: >-
        The project's active PHYSICAL and VIRTUAL locations (deleted ones never
        appear), sorted by name: the venues a supplier can name in a schedule,
        as the MarketBox dashboard lists them, built by the same code. Each is
        the supplier view of a location, with no travel settings and no status
        or audit fields. The list is the whole set, not paginated. To list every
        location, inactive ones and travel zones included, call `GET
        /locations?includeInactive=true` with the API key alone. 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 venues
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        locationId:
                          type: string
                          description: The location id.
                          example: loc_01kv60qh7rf3d9mn2ptxwa5zbc
                        projectId:
                          type: string
                          description: The project the location belongs to.
                          example: prj_01kv60qgnef2kt3pvqgwmkbzfr
                        locationType:
                          type: string
                          enum:
                            - PHYSICAL
                            - VIRTUAL
                            - TRAVEL_ZONE
                          description: >-
                            PHYSICAL: a venue with an address and coordinates,
                            where the service is delivered. VIRTUAL: delivered
                            online; usually no address. A venue is always one of
                            the two.
                          example: PHYSICAL
                        name:
                          type: string
                          description: >-
                            The display name, unique within the project among
                            locations of the same type.
                          example: Bondi Pool
                        defaultLanguage:
                          type: string
                          description: >-
                            The language of `name`. Absent unless the location
                            carries translations in `nameI18n`.
                          example: en
                        nameI18n:
                          type: object
                          additionalProperties:
                            type: string
                          description: >-
                            The name by language code, when translations are
                            set. Absent otherwise: display `name`.
                          example:
                            en: Bondi Pool
                            fr: Piscine de Bondi
                        addressOneLine:
                          type: string
                          nullable: true
                          description: >-
                            The full address on one line. Usually null for a
                            VIRTUAL location.
                          example: 1 Beach Rd, Bondi NSW 2026, AU
                        street:
                          type: string
                          nullable: true
                          description: Street line of the address.
                          example: 1 Beach Rd
                        city:
                          type: string
                          nullable: true
                          description: City.
                          example: Bondi
                        state:
                          type: string
                          nullable: true
                          description: State, province or region.
                          example: NSW
                        country:
                          type: string
                          nullable: true
                          description: Country.
                          example: AU
                        postalCode:
                          type: string
                          nullable: true
                          description: Postal or ZIP code.
                          example: '2026'
                        longitude:
                          type: number
                          nullable: true
                          description: >-
                            Longitude (WGS 84) of a PHYSICAL venue's position.
                            Usually null for VIRTUAL.
                          example: 151.2743
                        latitude:
                          type: number
                          nullable: true
                          description: >-
                            Latitude (WGS 84) of a PHYSICAL venue's position.
                            Usually null for VIRTUAL.
                          example: -33.8915
                        timezone:
                          type: string
                          nullable: true
                          description: >-
                            The location's IANA time zone; a booking at this
                            location is shown in it. Null when not set, in which
                            case the supplier's or the project's zone applies.
                          example: Australia/Sydney
                      required:
                        - locationId
                        - projectId
                        - locationType
                        - name
                      description: >-
                        A venue as a supplier sees it: where it is and when it
                        is. No travel settings, no audit fields.
                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.