Skip to main content
POST
/
phones
/
get
await seam.phones.get({ device_id: "2c39adb7-ba99-4b60-927d-9b796952c8e8" });

/*
{
  "created_at": "2025-06-14T16:54:17.946540Z",
  "custom_metadata": {
    "id": "internalId1"
  },
  "device_id": "2c39adb7-ba99-4b60-927d-9b796952c8e8",
  "device_type": "ios_phone",
  "display_name": "My Phone",
  "errors": [],
  "nickname": "My Phone",
  "properties": {
    "assa_abloy_credential_service_metadata": {
      "endpoints": [
        {
          "endpoint_id": "c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f",
          "is_active": true
        }
      ],
      "has_active_endpoint": true
    }
  },
  "warnings": [],
  "workspace_id": "da8639a4-28a2-4884-a4f9-b7691f4cf336"
}
*/
{
  "ok": true,
  "phone": {
    "created_at": "2023-11-07T05:31:56Z",
    "custom_metadata": {},
    "device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "display_name": "<string>",
    "errors": [
      {
        "error_code": "<string>",
        "message": "<string>"
      }
    ],
    "properties": {
      "assa_abloy_credential_service_metadata": {
        "endpoints": [
          {
            "endpoint_id": "<string>",
            "is_active": true
          }
        ],
        "has_active_endpoint": true
      },
      "salto_space_credential_service_metadata": {
        "has_active_phone": true
      }
    },
    "warnings": [
      {
        "message": "<string>",
        "warning_code": "<string>"
      }
    ],
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "nickname": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
device_id
string<uuid>
required

Device ID of the phone that you want to get.

Response

OK

​
ok
boolean
required
​
phone
object
required

Represents an app user's mobile phone.