List Phones
Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the owner_user_identity_id or acs_credential_id, respectively, in the request body.
Returns a list of all phones, using the owner's user identity ID.
Code:
await seam.phones.list({
owner_user_identity_id: "6bc848b0-0e7f-4d4c-8ea1-004ccda0b0a4",
});Output:
[
{
"created_at": "2025-06-14T16:54:17.946540Z",
"custom_metadata": { "id": "internalId1" },
"device_id": "e452f665-a635-4c65-922b-9feab0e0f84f",
"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"
}
]Returns a list of all phones, using the owner's user identity ID.
Code:
curl --include --request POST "https://connect.getseam.com/phones/list" \
--header "Authorization: Bearer $SEAM_API_KEY" \
--json @- <<EOF
{
"owner_user_identity_id": "6bc848b0-0e7f-4d4c-8ea1-004ccda0b0a4"
}
EOFOutput:
{
"phones": [
{
"created_at": "2025-06-14T16:54:17.946540Z",
"custom_metadata": { "id": "internalId1" },
"device_id": "e452f665-a635-4c65-922b-9feab0e0f84f",
"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"
}
]
}Returns a list of all phones, using the owner's user identity ID.
Code:
seam.phones.list(owner_user_identity_id="6bc848b0-0e7f-4d4c-8ea1-004ccda0b0a4")Output:
[
Phone(
created_at="2025-06-14T16:54:17.946540Z",
custom_metadata={"id": "internalId1"},
device_id="e452f665-a635-4c65-922b-9feab0e0f84f",
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",
)
]Returns a list of all phones, using the owner's user identity ID.
Code:
seam.phones.list(owner_user_identity_id: "6bc848b0-0e7f-4d4c-8ea1-004ccda0b0a4")Output:
[
{
"created_at" => "2025-06-14T16:54:17.946540Z",
"custom_metadata" => {
id: "internalId1",
},
"device_id" => "e452f665-a635-4c65-922b-9feab0e0f84f",
"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",
},
]Returns a list of all phones, using the owner's user identity ID.
Code:
$seam->phones->list(
owner_user_identity_id: "6bc848b0-0e7f-4d4c-8ea1-004ccda0b0a4"
);Output:
[
[
"created_at" => "2025-06-14T16:54:17.946540Z",
"custom_metadata" => ["id" => "internalId1"],
"device_id" => "e452f665-a635-4c65-922b-9feab0e0f84f",
"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",
],
];Returns a list of all phones, using the owner's user identity ID.
Code:
seam phones list --owner_user_identity_id "6bc848b0-0e7f-4d4c-8ea1-004ccda0b0a4"Output:
[
{
"created_at": "2025-06-14T16:54:17.946540Z",
"custom_metadata": { "id": "internalId1" },
"device_id": "e452f665-a635-4c65-922b-9feab0e0f84f",
"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"
}
]Request Parameters
acs_credential_id String
ID of the credential by which you want to filter the list of returned phones.
owner_user_identity_id String
ID of the user identity that represents the owner by which you want to filter the list of returned phones.
Response
Array of phones
{
"created_at": "2025-06-14T16:54:17.946540Z",
"custom_metadata": { "id": "internalId1" },
"device_id": "e452f665-a635-4c65-922b-9feab0e0f84f",
"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"
}Examples
List phones for a credential
Returns a list of all phones, using the credential ID.
Code:
await seam.phones.list({
acs_credential_id: "6617f81a-d601-4e33-9052-f44bf1b4ed2b",
});Output:
[
{
"created_at": "2025-06-14T16:54:17.946540Z",
"custom_metadata": { "id": "internalId1" },
"device_id": "e452f665-a635-4c65-922b-9feab0e0f84f",
"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"
}
]Code:
curl --include --request POST "https://connect.getseam.com/phones/list" \
--header "Authorization: Bearer $SEAM_API_KEY" \
--json @- <<EOF
{
"acs_credential_id": "6617f81a-d601-4e33-9052-f44bf1b4ed2b"
}
EOFOutput:
{
"phones": [
{
"created_at": "2025-06-14T16:54:17.946540Z",
"custom_metadata": { "id": "internalId1" },
"device_id": "e452f665-a635-4c65-922b-9feab0e0f84f",
"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"
}
]
}Code:
seam.phones.list(acs_credential_id="6617f81a-d601-4e33-9052-f44bf1b4ed2b")Output:
[
Phone(
created_at="2025-06-14T16:54:17.946540Z",
custom_metadata={"id": "internalId1"},
device_id="e452f665-a635-4c65-922b-9feab0e0f84f",
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",
)
]Code:
seam.phones.list(acs_credential_id: "6617f81a-d601-4e33-9052-f44bf1b4ed2b")Output:
[
{
"created_at" => "2025-06-14T16:54:17.946540Z",
"custom_metadata" => {
id: "internalId1",
},
"device_id" => "e452f665-a635-4c65-922b-9feab0e0f84f",
"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",
},
]Code:
$seam->phones->list(acs_credential_id: "6617f81a-d601-4e33-9052-f44bf1b4ed2b");Output:
[
[
"created_at" => "2025-06-14T16:54:17.946540Z",
"custom_metadata" => ["id" => "internalId1"],
"device_id" => "e452f665-a635-4c65-922b-9feab0e0f84f",
"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",
],
];Code:
seam phones list --acs_credential_id "6617f81a-d601-4e33-9052-f44bf1b4ed2b"Output:
[
{
"created_at": "2025-06-14T16:54:17.946540Z",
"custom_metadata": { "id": "internalId1" },
"device_id": "e452f665-a635-4c65-922b-9feab0e0f84f",
"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"
}
]Last updated
Was this helpful?

