---
title: "List Locations"
method: GET
path: "/v2/tms-api/locations"
tags: ["TMS API", "TMS API - Locations"]
---

# List Locations

`GET /v2/tms-api/locations`

## Request

- Base URL: `https://api.mentium.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.mentium.io/v2/tms-api/locations`
- Auth: none declared

List all locations with optional filtering and pagination.

## Query parameters

- `name_contains` string, nullable: Filter by name
- `city` string, nullable: Filter by city
- `state` string, nullable: Filter by state/province (ISO 3166-2). Examples: `US-IL`, `CA-ON`, `MX-CMX`
- `country` string, nullable: Filter by country (ISO 3166-1 alpha-2). Examples: `US`, `CA`, `MX`
- `limit` integer: Number of items
- `offset` integer: Offset for pagination
- `sort_by` string, nullable: Sort field
- `sort_order` 'asc' | 'desc': Sort order options.

## Headers

- `X-API-Key` string, nullable: API key for authentication

## Response `200`

Successful Response

- PaginatedResponseLocationResponse
  - `data` LocationResponse[], required: List of items
    - `id` string, required: Internal Mentium ID
    - `external_reference_id` string, required: External reference ID from your system
    - `name` string, nullable: Location name
    - `address_line1` string, nullable: Street address line 1
    - `address_line2` string, nullable: Street address line 2
    - `city` string, nullable: City
    - `state` string, nullable: State/Province
    - `postal_code` string, nullable: Postal/ZIP code
    - `country` string, nullable: Country
    - `latitude` number, nullable: Latitude
    - `longitude` number, nullable: Longitude
    - `iana_timezone` string, nullable: IANA timezone for the facility (e.g., 'America/Chicago'). Used to render stop times in the facility's local TZ.
    - `email` string, nullable: Contact email
    - `phone_number` string, nullable: Contact phone number
    - `weekday_open_hours` string, nullable: Weekday opening hours
    - `weekday_close_hours` string, nullable: Weekday closing hours
    - `weekend_open_hours` string, nullable: Weekend opening hours
    - `weekend_close_hours` string, nullable: Weekend closing hours
    - `internal_notes` string, nullable: Internal notes
    - `created_at` string, date-time, required: Creation timestamp
    - `updated_at` string, date-time, required: Last update timestamp
  - `total_count` integer, required: Total number of items matching the query
  - `has_more` boolean, required: Whether there are more items available
  - `limit` integer, required: Number of items requested
  - `offset` integer, required: Number of items skipped

## Other responses

- `422`: Validation Error

---

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