# List locations

Retrieve a paginated list of active locations for the account. Supports filtering by name and storeId. Use storeId filter to find a location by partner's external identifier.

Endpoint: GET /partner/v2/account/{accountId}/location
Version: 2.0
Security: PartnerOAuth

## Query parameters:

  - `name` (string)
    Filter locations by name (case-insensitive contains match)
    Example: "Main Street"

  - `storeId` (string)
    Filter by exact storeId (partner's external identifier)
    Example: "STORE123"

  - `sortBy` (string)
    Sort by field
    Enum: "NAME", "CREATED_DATE"

  - `sortDir` (string)
    Sort direction
    Enum: "ASC", "DESC"

  - `cursor` (string)
    Pagination cursor from previous response

  - `limit` (integer)
    Number of results per page (max 100)
    Example: 20

  - `active` (boolean)
    Filter by active status. If not specified, returns both active and inactive locations.
    Enum: true, false

## Path parameters:

  - `accountId` (integer, required)
    Account identifier

## Response 200 fields (application/json):

  - `locations` (array)
    List of locations in this page

  - `locations.active` (boolean)
    Whether the location is active
    Example: true

  - `locations.address` (object)
    Address information

  - `locations.address.address1` (string)
    Street address line 1
    Example: "123 Main Street"

  - `locations.address.address2` (string)
    Street address line 2
    Example: "Suite 100"

  - `locations.address.city` (string)
    City
    Example: "Baltimore"

  - `locations.address.postalCode` (string)
    Postal/ZIP code
    Example: "21202"

  - `locations.address.state` (string)
    State/Province abbreviation
    Example: "MD"

  - `locations.createdAt` (string)
    Creation timestamp
    Example: "2025-01-15T10:00:00Z"

  - `locations.id` (integer)
    Unique location identifier
    Example: 12345

  - `locations.name` (string)
    Location name
    Example: "Main Street Clinic"

  - `locations.phoneNumber` (string)
    Location phone number (digits only)
    Example: "5551234567"

  - `locations.storeId` (string)
    Partner's external store identifier
    Example: "STORE123"

  - `locations.timeZone` (string)
    Location timezone (IANA format)
    Example: "America/New_York"

  - `nextCursor` (string)
    Opaque cursor for fetching the next page. Null if no more results.
    Example: "eyJ2Ijp7Im5hbWUiOiJNYWluIFN0cmVldCJ9LCJpZCI6MTIzNDV9"


## Response 400 fields

## Response 401 fields

## Response 403 fields