List Device Providers

Returns a list of all device providers.

The information that this endpoint returns for each provider includes a set of capability flags, such as device_provider.can_remotely_unlock. If at least one supported device from a provider has a specific capability, the corresponding capability flag is true.

When you create a Connect Webview, you can customize the providers—that is, the brands—that it displays. In the /connect_webviews/create request, include the desired set of device provider keys in the accepted_providers parameter. See also Customize the Brands to Display in Your Connect Webviews.

Returns a list of all device providers.

Code

await seam.devices.listDeviceProviders();

Output

[
  {
    "can_program_online_access_codes": true,
    "can_remotely_unlock": true,
    "device_provider_name": "akiles",
    "display_name": "Akiles",
    "image_url": "https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128",
    "provider_categories": ["stable", "consumer_smartlocks"]
  }
]

Returns a list of all device providers.

Code

curl --include --request POST "https://connect.getseam.com/devices/list_device_providers" \
  --header "Authorization: Bearer $SEAM_API_KEY"

Output

{
  "device_providers": [
    {
      "can_program_online_access_codes": true,
      "can_remotely_unlock": true,
      "device_provider_name": "akiles",
      "display_name": "Akiles",
      "image_url": "https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128",
      "provider_categories": ["stable", "consumer_smartlocks"]
    }
  ]
}

Returns a list of all device providers.

Code

seam.devices.list_device_providers()

Output

[
    DeviceProvider(
        can_program_online_access_codes=true,
        can_remotely_unlock=true,
        device_provider_name="akiles",
        display_name="Akiles",
        image_url="https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128",
        provider_categories=["stable", "consumer_smartlocks"],
    )
]

Returns a list of all device providers.

Code

seam.devices.list_device_providers()

Output

[
  {
    "can_program_online_access_codes" => true,
    "can_remotely_unlock" => true,
    "device_provider_name" => "akiles",
    "display_name" => "Akiles",
    "image_url" =>
      "https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128",
    "provider_categories" => %w[stable consumer_smartlocks],
  },
]

Returns a list of all device providers.

Code

<?php
$seam->devices->list_device_providers();

Output

<?php
[
    [
        "can_program_online_access_codes" => true,
        "can_remotely_unlock" => true,
        "device_provider_name" => "akiles",
        "display_name" => "Akiles",
        "image_url" =>
            "https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128",
        "provider_categories" => ["stable", "consumer_smartlocks"],
    ],
];

Returns a list of all device providers.

Code

seam devices list-device-providers

Output

[
  {
    "can_program_online_access_codes": true,
    "can_remotely_unlock": true,
    "device_provider_name": "akiles",
    "display_name": "Akiles",
    "image_url": "https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128",
    "provider_categories": ["stable", "consumer_smartlocks"]
  }
]

Authentication Methods

API key
Client session token
Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

provider_category String

Category for which you want to list providers.

Response

Array of device_providers

{
  "can_program_online_access_codes": true,
  "can_remotely_unlock": true,
  "device_provider_name": "akiles",
  "display_name": "Akiles",
  "image_url": "https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128",
  "provider_categories": ["stable", "consumer_smartlocks"]
}

Examples