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

# List locations

> API tokens are location-scoped, so this typically returns one entry.



## OpenAPI

````yaml GET /locations
openapi: 3.1.0
info:
  title: PickupBell API
  version: 1.0.0
  description: >
    Public REST surface for PickupBell — the AI receptionist for HVAC, plumbing,
    and home-services contractors.


    All requests authenticate via `Authorization: Bearer <uuid>`. Every response
    is JSON with shape `{ "data": … }` (or `{ "error": { "code", "message",
    "details" } }` on failure).


    Only endpoints an API token can successfully call are documented here.
    UI-only operations (create location, invite member, mint / revoke API key,
    billing checkout / portal) require a user session and are not part of the
    public API.
  contact:
    email: support@pickupbell.com
servers:
  - url: https://api.pickupbell.com
    description: >-
      Production (vanity domain — Vercel rewrite proxies to
      app.pickupbell.com/api/v1)
  - url: https://app.pickupbell.com/api/v1
    description: App-domain alias (works without the rewrite)
  - url: http://localhost:3000/api/v1
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Me
  - name: Locations
  - name: Members
  - name: API keys
  - name: Agent
  - name: Business hours
  - name: Call forwarding
  - name: FAQs
  - name: Pricebook
  - name: Calls
  - name: Leads
  - name: Bookings
  - name: Insights
  - name: Notifications
  - name: Integrations
  - name: Webhook endpoints
paths:
  /locations:
    get:
      tags:
        - Locations
      summary: List locations accessible to this token
      description: API tokens are location-scoped, so this typically returns one entry.
      operationId: listLocations
      responses:
        '200':
          description: Locations
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Location'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Location:
      type: object
      properties:
        id:
          type: string
          format: uuid
        slug:
          type: string
          example: premier-hvac
        name:
          type: string
        legal_name:
          type: string
          nullable: true
        license_number:
          type: string
          nullable: true
        industry:
          type: string
          enum:
            - hvac
            - plumbing
            - hvac_plumbing
            - electrical
            - roofing
            - landscaping
            - general
        website_url:
          type: string
          nullable: true
        timezone:
          type: string
          example: America/Chicago
        owner_cell:
          type: string
          nullable: true
          description: Always masked on API responses
        service_areas:
          type: array
          items:
            type: string
        zip_codes:
          type: array
          items:
            type: string
        travel_radius_miles:
          type: integer
          nullable: true
        pickupbell_phone:
          type: string
          nullable: true
          description: E.164
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - unauthorized
                - forbidden
                - not_found
                - validation
                - conflict
                - server
            message:
              type: string
            details:
              type: object
              additionalProperties: true
          required:
            - code
            - message
  responses:
    Unauthorized:
      description: Missing or invalid Bearer token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: uuid
      description: Location-scoped API token from **Settings → API & MCP**.

````