> ## 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 locations for a project

> The project's locations: PHYSICAL venues where a service is delivered, VIRTUAL locations, and TRAVEL_ZONE areas a supplier travels within. Active locations only unless `includeInactive=true`; deleted locations are never returned. Filter by `locationType`, and within a type by `namePrefix`. Not paginated: a project holds tens of locations, read in one query and returned in one response. Display `nameI18n` in the reader's language when present, falling back to `name`. Locations are created and edited in the MarketBox dashboard.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/projects/{projectId}/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}/locations:
    get:
      tags:
        - Locations
      summary: List locations for a project
      description: >-
        The project's locations: PHYSICAL venues where a service is delivered,
        VIRTUAL locations, and TRAVEL_ZONE areas a supplier travels within.
        Active locations only unless `includeInactive=true`; deleted locations
        are never returned. Filter by `locationType`, and within a type by
        `namePrefix`. Not paginated: a project holds tens of locations, read in
        one query and returned in one response. Display `nameI18n` in the
        reader's language when present, falling back to `name`. Locations are
        created and edited in the MarketBox dashboard.
      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:
              - PHYSICAL
              - VIRTUAL
              - TRAVEL_ZONE
            description: >-
              Only locations of this type. With it, the list is sorted by name;
              without it, by id.
            example: PHYSICAL
          required: false
          description: >-
            Only locations of this type. With it, the list is sorted by name;
            without it, by id.
          name: locationType
          in: query
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
            description: >-
              Also return inactive locations (`active: false`). Deleted
              locations are never returned.
            example: 'false'
          required: false
          description: >-
            Also return inactive locations (`active: false`). Deleted locations
            are never returned.
          name: includeInactive
          in: query
        - schema:
            type: string
            minLength: 1
            description: >-
              Only locations whose name starts with this text, compared
              case-insensitively (against `nameNormalized`). Requires
              `locationType`: sent without it, the request is refused with 400
              VALIDATION_ERROR.
            example: bondi
          required: false
          description: >-
            Only locations whose name starts with this text, compared
            case-insensitively (against `nameNormalized`). Requires
            `locationType`: sent without it, the request is refused with 400
            VALIDATION_ERROR.
          name: namePrefix
          in: query
      responses:
        '200':
          description: Locations list
          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; no address. TRAVEL_ZONE: an area the
                            supplier travels within to reach the client, centred
                            on `latitude`/`longitude` and bounded by the
                            `travel*` fields.
                          example: PHYSICAL
                        name:
                          type: string
                          description: >-
                            The display name, unique within the project among
                            locations of the same type.
                          example: Bondi Pool
                        nameNormalized:
                          type: string
                          description: >-
                            `name` trimmed, lower-cased and with inner spaces
                            collapsed: the search key that `namePrefix` is
                            matched against.
                          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): a PHYSICAL venue's position or a
                            TRAVEL_ZONE's centre. Usually null for VIRTUAL.
                          example: 151.2743
                        latitude:
                          type: number
                          nullable: true
                          description: >-
                            Latitude (WGS 84): a PHYSICAL venue's position or a
                            TRAVEL_ZONE's centre. 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
                        travelZoneType:
                          type: string
                          nullable: true
                          enum:
                            - CIRCULAR
                            - DRAWN
                            - null
                          description: >-
                            TRAVEL_ZONE only (null otherwise). CIRCULAR: a
                            radius of `travelDistance` around the centre. DRAWN:
                            the polygon in `travelRegions`.
                          example: CIRCULAR
                        travelDistance:
                          type: number
                          nullable: true
                          description: >-
                            CIRCULAR travel zones only (null otherwise): the
                            radius, in `travelDistanceUnit`.
                          example: 10
                        travelDistanceUnit:
                          type: string
                          nullable: true
                          enum:
                            - KM
                            - MILES
                            - null
                          description: >-
                            CIRCULAR travel zones only (null otherwise): the
                            unit of `travelDistance`.
                          example: KM
                        travelRegions:
                          type: object
                          nullable: true
                          properties:
                            type:
                              type: string
                              enum:
                                - Polygon
                                - MultiPolygon
                            coordinates:
                              nullable: true
                          required:
                            - type
                          description: >-
                            DRAWN travel zones only (null otherwise): the zone
                            as a GeoJSON Polygon or MultiPolygon.
                        active:
                          type: boolean
                          description: >-
                            Whether the location is active. The list omits
                            inactive locations unless `includeInactive=true` is
                            passed.
                          example: true
                        deleted:
                          type: boolean
                          description: >-
                            Soft-delete flag; deleted locations are never
                            returned, so this is always false.
                          example: false
                        createdAt:
                          type: string
                          description: When the location was created (ISO 8601, UTC).
                          example: '2026-10-01T14:00:00.000Z'
                        updatedAt:
                          type: string
                          description: When the location was last changed (ISO 8601, UTC).
                          example: '2026-10-01T14:00:00.000Z'
                      required:
                        - locationId
                        - projectId
                        - locationType
                        - name
                        - nameNormalized
                        - active
                        - deleted
                        - createdAt
                        - updatedAt
                required:
                  - data
        '400':
          description: Invalid query parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: API key cannot access this project
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: Project not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
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`.

````

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