---
title: "Get a Phone"
method: POST
path: "/phones/get"
tags: ["/phones"]
---

# Get a Phone

`POST /phones/get`

Returns a specified [phone](/capability-guides/mobile-access/managing-phones-for-a-user-identity).

## Request body

- object
  - `device_id` string, uuid, required — Device ID of the phone that you want to get.

## Response `200`

OK

- object
  - `phone` Phone, required — Represents an app user's mobile phone. See the [phone object](/api/phones/object).
    - `created_at` string, date-time, required — Date and time at which the phone was created.
    - `custom_metadata` object, required — Optional [custom metadata](/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone.
    - `device_id` string, uuid, required — ID of the phone.
    - `device_type` 'ios_phone' | 'android_phone', required — Type of the phone device, such as `ios_phone` or `android_phone`.
    - `display_name` string, required — Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones.
    - `errors` object[], required — Errors associated with the phone.
      - `error_code` string, required — Unique identifier of the type of error.
      - `message` string, required — Detailed description of the error.
    - `nickname` string — Optional nickname to describe the phone, settable through Seam.
    - `properties` object, required — Properties of the phone.
      - `assa_abloy_credential_service_metadata` object — ASSA ABLOY Credential Service metadata for the phone.
        - `endpoints` object[] — Endpoints associated with the phone.
          - `endpoint_id` string — ID of the associated endpoint.
          - `is_active` boolean — Indicated whether the endpoint is active.
        - `has_active_endpoint` boolean — Indicates whether the credential service has active endpoints associated with the phone.
      - `salto_space_credential_service_metadata` object — Salto Space credential service metadata for the phone.
        - `has_active_phone` boolean — Indicates whether the credential service has an active associated phone.
    - `warnings` object[], required — Warnings associated with the phone.
      - `message` string, required — Detailed description of the warning.
      - `warning_code` string, required — Unique identifier of the type of warning.
    - `workspace_id` string, uuid, required — ID of the workspace that contains the phone.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized

---

[API](https://skmtc.net/seam/apis/seam-connect.md) · [All operations](https://skmtc.net/seam/apis/seam-connect/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/seam/seam-connect/versions/00c35395ce12/schema)