---
title: "Retrieve Locations by location ids"
method: POST
path: "/filter"
tags: ["Locations"]
---

# Retrieve Locations by location ids

`POST /filter`

## Request

- Base URL: `https://sb2api.servicechannel.com/v3`
- URL: `https://sb2api.servicechannel.com/v3/filter`
- 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/filter/post.ts> (a function with typed inputs; its response is checked against the schema)

Returns a list of locations.

## Request body

- ServiceChannelServicesMessagingLocationGetLocationsByFilterRequest
  - `Locations` ServiceChannelServicesMessagingLocationLocationFilterRequest
    - `LocationIds` integer[]

## Response `200`

The requested locations are in the response.

- ServiceChannelServicesMessagingLocationGetApiLocationResponse
  - `Locations` ServiceChannelServicesMessagingLocationApiLocationModel[]
    - `Id` integer
    - `StoreId` string
    - `Name` string
    - `City` string
    - `State` string
    - `Zip` string
    - `Address1` string
    - `Address2` string
    - `CountryCode` string
    - `IsOpened` boolean
    - `Country` string
    - `Contact` string

## Other responses

- `400`: Bad Request - the request could not be understood or was missing required parameters. <br/>Error codes: 655 — Location Ids List is empty or null.

---

[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)