---
title: "Get Locations"
method: GET
path: "/GetLocationsMobile"
tags: ["Locations"]
---

# Get Locations

`GET /GetLocationsMobile`

## Request

- Base URL: `https://sb2api.servicechannel.com/v3`
- URL: `https://sb2api.servicechannel.com/v3/GetLocationsMobile`
- Auth: OAuth 2
  - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize`
  - Token URL: `https://sb2login.servicechannel.com/oauth/token`
- TypeScript: <https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/docs/GetLocationsMobile/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `page` integer, required
- `pageSize` integer, required
- `latitude` number, double
- `longitude` number, double
- `searchExpression` string
- `onlyOpened` boolean
- `locationIds` string

## Response `200`

The requested locations are in the response.

- ServiceChannelServicesMessagingLocationGetLocationsMobileResponse: Response details object.
  - `Locations` ServiceChannelServicesMessagingLocationLocationForMobile[]: Location details.
    - `Id` integer: Unique location identifier.
    - `SubscriberId` integer: Unique subscriber identifier.
    - `StoreId` string: Alphanumeric identifier of the store in the client's system. Assigned by and unique per subscriber.
    - `Name` string: Location name.
    - `Latitude` number, double: Global position. Latitude.
    - `Longitude` number, double: Global position. Longitude.
    - `Address1` string: Additional location address.
    - `Address2` string: Main location address.
    - `City` string: Location city.
    - `State` string: State where the location is situated.
    - `Region` string: Part of the country where the location is situated.
    - `District` string: Abbreviation of the town or country area where the location is situated.
    - `Zip` string: Location ZIP or postal code.
    - `Country` string: Abbreviation of the country name where the location is situated.
    - `Phone` string: Contact phone number of the location.
    - `Contact` string: Name of the main person to contact at the location.
    - `OpenDate` string, date-time: First day when the location is open for business
    - `CloseDate` string, date-time: Last day when the location is open for business.
    - `Distance` number, double: Distance between user and location
    - `Email` string: Email of the location.
    - `FaxNumber` string: Fax number of the location.
    - `Radius` number, double: GPS radius for the location.
    - `Notes` ServiceChannelServicesMessagingLocationNoteLocationNote[]: Notes
      - `Id` integer: Location note numeric identifier.
      - `HeaderId` integer: Unique location note header identifier.
      - `Value` string: Location note content.
      - `Header` string: Name of the note.
  - `TotalElements` integer: Total number of items on all pages;
  - `Page` integer: Current page
  - `TotalPages` integer: Total number of pages available

## Other responses

- `401`: The request is not authorized. <br/>Error codes: 401 — User has no permissions to perform this action
- `500`: The server was unable to complete the request due to an internal error. <br/>Error codes: 501 — Value of pageSize or page is less than 1

---

[API](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3.md) - [All operations](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/llms.txt) - [OpenAPI document](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/revisions/d490d6596809?raw)