search
Sign UpSupported Devices
githubEdit

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"]
  }
]
chevron-rightAuthentication Methodshashtag

  • API key

  • Client session token

  • Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authenticationarrow-up-right.

hashtag
Request Parameters

provider_category String

Category for which you want to list providers.

hashtag
Response

circle-check

Returns: Array of device_providers

hashtag
Examples

hashtag
List device providers for a specific provider category

Returns a list of all device providers for a specified provider category.

Code:

Output:

PreviousGet a DeviceNextList Devices

Last updated

Was this helpful?