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

# List Locations

> List all locations for the authenticated business with pagination



## OpenAPI

````yaml get /v1/locations
openapi: 3.1.1
info:
  title: HitPay API
  description: >-
    Accept PayNow, FPX, QRIS, GrabPay, cards, and 40+ payment methods with a
    single API. Production base URL: https://api.hit-pay.com, Sandbox:
    https://api.sandbox.hit-pay.com
  version: '1.0'
servers:
  - url: https://api.hit-pay.com
    description: Production
  - url: https://api.sandbox.hit-pay.com
    description: Sandbox
security: []
paths:
  /v1/locations:
    get:
      tags:
        - Location
      summary: List locations
      description: >
        Returns a paginated list of locations for the authenticated business.


        The business is resolved from the API key (`X-BUSINESS-API-KEY`) or
        OAuth bearer token.

        Cashiers and managers only see locations assigned to them.
      operationId: PublicGetLocations
      parameters:
        - name: X-BUSINESS-API-KEY
          in: header
          required: true
          style: simple
          explode: false
          schema:
            type: string
            example: b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d
        - name: keywords
          in: query
          schema:
            type: string
          description: Filter by location name (space-separated keywords) or exact UUID
          example: Main Store
        - name: perPage
          in: query
          schema:
            type: integer
            default: 500
            minimum: 1
          description: Number of results per page
      responses:
        '200':
          description: Paginated list of locations
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: Location ID
                          example: 9c484458-b2a3-4f49-87ed-ad9ea71b0df3
                        business_id:
                          type: string
                          format: uuid
                          description: Business that owns this location
                          example: 8a1f2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d
                        name:
                          type: string
                          description: Name of the location
                          example: Main Store
                        street:
                          type: string
                          description: Street address
                          example: 123 Main St
                        city:
                          type: string
                          description: City
                          example: Singapore
                        state:
                          type: string
                          description: State or region
                          example: Singapore
                        country:
                          type: string
                          description: Country code or name
                          example: SG
                        postal_code:
                          type: string
                          description: Postal code
                          example: '123456'
                        active:
                          type: boolean
                          description: Whether the location is active
                          example: true
                        pickups:
                          type: array
                          description: >-
                            Pickup configurations linked to this location (empty
                            when not loaded)
                          items:
                            type: object
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                      required:
                        - id
                        - business_id
                        - name
                        - street
                        - city
                        - state
                        - country
                        - postal_code
                        - active
                  links:
                    type: object
                    description: >-
                      pagination links according to current page and per_page
                      value
                    properties:
                      first:
                        type: string
                        description: >-
                          the url of the first page according to current base
                          url
                      last:
                        type: string
                        description: >-
                          the url of the last page according to current
                          `per_page` value
                      prev:
                        type: string
                        description: >-
                          the url of the previous page of the current `page`,
                          NULL if not exists
                      next:
                        type: string
                        description: >-
                          the url of the next page of the current `page`, NULL
                          if not exists
                  meta:
                    type: object
                    description: meta values for listing operations
                    properties:
                      current_page:
                        type: number
                        description: the current page number
                        example: 5
                      per_page:
                        type: number
                        description: >-
                          the number of items for show for the current listing
                          response
                        example: 10
                      from:
                        type: number
                        description: the index that current listing page starts
                        example: 1
                      to:
                        type: number
                        description: the index that current listing page ends
                        example: 10
                      total:
                        type: number
                        description: >-
                          the total of items found that match current listing
                          filter
                        example: 100
                      last_page:
                        type: number
                        description: >-
                          the number that represents the last page of the
                          listing according to the current `per_page` and filter
                        example: 10
                      path:
                        type: string
                        description: the base listing url that doesn't contain params
                      links:
                        type: array
                        description: the array of pagination link
                        items:
                          type: object
                          properties:
                            url:
                              type: string
                              description: the url of the paginated link
                            label:
                              type: string
                              description: label for this link
                            active:
                              type: boolean
                              description: is the current link the active page or not
        '401':
          description: Missing or invalid API key / OAuth token
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: Error message
                  errors:
                    type: array

````