---
title: "Get a Mode"
method: GET
path: "/locations/{locationId}/modes/{modeId}"
tags: ["Modes"]
---

# Get a Mode

`GET /locations/{locationId}/modes/{modeId}`

## Request

- Base URL: `https://api.smartthings.com/v1`
- URL: `https://api.smartthings.com/v1/locations/{locationId}/modes/{modeId}`
- Auth: OAuth 2
  - Implicit: `https://auth-global.api.smartthings.com`
  - Scopes: `r:locations:*`
- TypeScript: <https://skmtc.dev/smartthings/apis/smartthings-api/docs/locations/:locationId/modes/:modeId/get.ts> (a function with typed inputs; its response is checked against the schema)

Get a specific Mode from a Location, including the Mode's client-facing permissions (if any), id, label, and name.

## Headers

- `Accept-Language` string

## Response `200`

The Mode

- Mode
  - `allowed` string[]: List of client-facing action identifiers that are currently permitted for the user. If the value of this property is not null, then any action not included in the list value of the property is currently prohibited for the user. If the value of this property is null (or absent), then no permission-related information is being provided. <ul> <li> w:modes - the user can edit the Mode <li> d:modes - the user can delete the Mode </ul>
  - `id` string, ^(?:([0-9a-fA-F]{32})|([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}))$, required: Globally unique id for the Mode.
  - `label` string, required: A user-readable label used to identify the mode in the app. If the user has not set a label and the name of the mode is one of "Home", "Away", or "Night", then the returned label will be translated from the name based on the `Accept-Language` header. If the user has not set a label and the name of the mode is anything else, then the label will be the same as the name. Unique per Location.
  - `name` string, ^[a-zA-Z0-9.-_]+$, required: An internal name for the Mode. Unique per Location.

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too many requests
- `default`: Unexpected error

## Changes

- **2023-11-27** `e8dd260a33ec`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/smartthings/apis/smartthings-api/changes/locations/:locationId/modes/:modeId/get.md)

---

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