---
title: "Get Locations"
method: GET
path: "/v2/locations"
---

# Get Locations

`GET /v2/locations`

Search and filter stores, zones, tills, and concepts in your org by type, code, name, or external ID.

## Query parameters

- `type` 'STORE' | 'ZONE' | 'TILL' | 'CONCEPT'
- `entityCodes` string
- `q` string
- `isActive` boolean
- `isAdmin` boolean
- `isOrgUnit` boolean
- `limit` integer
- `offset` integer
- `sortBy` 'entityCode' | 'name' | 'lastUpdated'
- `sortOrder` 'ASC' | 'DESC'
- `includeCustomFields` boolean
- `includeChildren` boolean
- `childrenLimit` integer
- `childrenOffset` integer

## Response `200`

Locations retrieved successfully.

- LocationsSearchResponse
  - `limit` integer — Page size used for this response.
  - `offset` integer — Pagination offset used for this response.
  - `total` integer — Total number of matching locations.
  - `data` LocationResponse[]
    - `id` integer — System-assigned ID of the location.
    - `type` 'STORE' | 'ZONE' | 'TILL' | 'CONCEPT' — Type of the location.
    - `code` string — Unique code identifying the location within the org.
    - `name` string — Display name of the location.
    - `description` string, nullable — Free-text description. Absent when not set.
    - `isActive` boolean — Whether the location is active.
    - `isDefault` boolean — Whether this is the default location for the org.
    - `isAdmin` boolean — Whether the location has admin access.
    - `isOuEnabled` boolean — Whether the location is configured as an org unit.
    - `externalIds` object — Key-value map of external identifiers. Absent when none are assigned.
    - `createdBy` integer, nullable — User ID of the user who created this location. Absent when not available.
    - `createdOn` string, nullable — Creation timestamp in ISO 8601 format, in UTC. Absent when not available.
    - `lastUpdatedOn` string — Last-update timestamp in ISO 8601 format, in UTC.
    - `lastUpdatedBy` integer, nullable — User ID of the last updater. Absent when not available.
    - `timezoneId` integer — System ID of the location's timezone.
    - `languageId` integer — System ID of the location's language.
    - `currencyId` integer — System ID of the location's currency.
    - `customFields` object — Key-value map of custom field values. Present only when includeCustomFields=true.
    - `standardAttributes` object — Object containing standard attribute values for the location.
      - `currency` string — ISO 4217 currency code (for example, INR).
      - `language` string — IETF BCP 47 language tag (for example, en-IN).
      - `timezone` string — Timezone name (for example, Asia/Kolkata).
      - `latitude` string — Latitude coordinate of the store. Present for stores only.
      - `longitude` string — Longitude coordinate of the store. Present for stores only.
    - `hierarchy` object — Object containing hierarchy relationships for this location.
      - `areaParent` LocationHierarchyItem
        - `id` integer — System-assigned ID of the related location.
        - `type` 'STORE' | 'ZONE' | 'TILL' | 'CONCEPT' — Type of the related location.
        - `name` string — Display name of the related location.
        - `code` string — Code of the related location.
        - `externalIds` object — Key-value map of external identifiers for the related location. Absent when none are assigned.
        - `isOrgUnit` boolean — Whether the related location is an org unit. Present for concept hierarchy entries only.
      - `groupParent` LocationHierarchyItem
        - `id` integer — System-assigned ID of the related location.
        - `type` 'STORE' | 'ZONE' | 'TILL' | 'CONCEPT' — Type of the related location.
        - `name` string — Display name of the related location.
        - `code` string — Code of the related location.
        - `externalIds` object — Key-value map of external identifiers for the related location. Absent when none are assigned.
        - `isOrgUnit` boolean — Whether the related location is an org unit. Present for concept hierarchy entries only.
      - `parent` LocationHierarchyItem
        - `id` integer — System-assigned ID of the related location.
        - `type` 'STORE' | 'ZONE' | 'TILL' | 'CONCEPT' — Type of the related location.
        - `name` string — Display name of the related location.
        - `code` string — Code of the related location.
        - `externalIds` object — Key-value map of external identifiers for the related location. Absent when none are assigned.
        - `isOrgUnit` boolean — Whether the related location is an org unit. Present for concept hierarchy entries only.
      - `children` LocationHierarchyItem[] — List of child location objects. Present when includeChildren=true with a single entity code.
        - `id` integer — System-assigned ID of the related location.
        - `type` 'STORE' | 'ZONE' | 'TILL' | 'CONCEPT' — Type of the related location.
        - `name` string — Display name of the related location.
        - `code` string — Code of the related location.
        - `externalIds` object — Key-value map of external identifiers for the related location. Absent when none are assigned.
        - `isOrgUnit` boolean — Whether the related location is an org unit. Present for concept hierarchy entries only.
      - `totalChildCount` integer — Total count of child entities. Present when includeChildren=true.
    - `email` string, nullable — Email address of the store. Present for stores only. Absent when not set.
    - `mobile` string, nullable — Mobile number of the store. Present for stores only. Absent when not set.
    - `landline` string, nullable — Landline number of the store. Present for stores only. Absent when not set.

## Other responses

- `400` — Invalid query parameters.

---

[API](https://skmtc.net/capillarytech/apis/sample-api.md) · [All operations](https://skmtc.net/capillarytech/apis/sample-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/capillarytech/sample-api/revisions/de241f2ed9b3/schema)