---
title: "Retrieve all locations."
method: GET
path: "/api/v2/organizations/{orgSlug}/locations"
tags: ["Locations"]
---

# Retrieve all locations.

`GET /api/v2/organizations/{orgSlug}/locations`

## Request

- Base URL: `https://app.officernd.com`
- URL: `https://app.officernd.com/api/v2/organizations/{orgSlug}/locations`
- Auth: OAuth 2
  - Authorization code: `https://identity.officernd.com/auth/authorize`
  - Client credentials
  - Token URL: `https://identity.officernd.com/auth/token` scopes: `flex.space.locations.read`

Retrieve all locations. 

 Required scopes: `flex.space.locations.read`

## Path parameters

- `orgSlug` string, required

## Query parameters

- `_id` string
- `name` string
- `isOpen` boolean
- `isPublic` boolean
- `modifiedAt` string
- `createdAt` string
- `$select` string
- `$cursorNext` string
- `$cursorPrev` string
- `$limit` number

## Response `200`

- object
  - `rangeStart` number
  - `rangeEnd` number
  - `cursorNext` string
  - `cursorPrev` string
  - `results` LocationResultDto[]
    - `properties` object: An object that contains all custom properties that can be applied to the item.
    - `_id` string: The _id of the location.
    - `name` string: The name of the location.
    - `address` AddressDto
      - `formattedAddress` string: The address of the physical address.
      - `country` string: The country of the physical address.
      - `state` string: The state of the physical address.
      - `city` string: The city of the physical address.
      - `street` string: The name of the street of the physical address.
      - `zip` string: The zip of the physical address.
      - `latitude` string: The latitude of the physical address.
      - `longitude` string: The longitude of the physical address.
    - `timezone` string: The timezone of the location.
    - `isOpen` boolean: If true, the location is operational; if false or omitted, the location is not working - either not open yet, or suspended for some other reason.
    - `isPublic` boolean: If true, the location is shown in the members portal; if false or omitted the location is not displayed in the members portal.
    - `image` string: The URL pointing to an image assigned to this location.
    - `code` string: A unique code of the location.
    - `targetRevenuePerPeriod` TargetRevenuePerPeriodDto[]: An array of target revenue amounts per period for this location. Used for tracking revenue goals over time.
      - `startDate` string, date-time: The start date of the revenue target period.
      - `endDate` string, date-time: The end date of the revenue target period. If not specified, the target applies indefinitely from the start date.
      - `target` number: The target revenue amount for this period.

---

[API](https://skmtc.dev/officernd/apis/space-api.md) - [All operations](https://skmtc.dev/officernd/apis/space-api/llms.txt) - [OpenAPI document](https://skmtc.dev/officernd/apis/space-api/revisions/f7e2e1e4ba60?raw)