Providers

Learn how to find out information about the providers that Seam supports.

Seam maintains a list of supported providers that you can access using the List Device Providers endpoint. For a provider, this endpoint returns a subset of the following information, depending on the capabilities of the provider's devices:

Property
Type
Description

device_provider_name

String

Name of the device provider.

For example: august

display_name

String

Formatted version of the device_provider_name.

For example: August

image_url

String

Image URL for the provider logo.

provider_categories

Array

Array of associated categories for the provider.

Supported categories:

  • stable

  • consumer_smartlocks

  • thermostats

  • noise_sensors

can_remotely_unlock

Boolean

Indicates whether at least one supported device from the provider can perform a remote unlock operation. See Capability Flags.

can_remotely_lock

Boolean

Indicates whether at least one supported device from the provider can perform a remote lock operation. See Capability Flags.

can_program_online_access_codes

Boolean

Indicates whether at least one supported device from the provider can program online access codes. See Capability Flags.

can_program_offline_access_codes

Boolean

Indicates whether at least one supported device from the provider can program offline access codes. See Capability Flags.

can_simulate_connection

Boolean

Indicates whether at least one supported device from the provider can simulate device connection. See Capability Flags.

can_simulate_disconnection

Boolean

Indicates whether at least one supported device from the provider can simulate device disconnection. See Capability Flags.

can_simulate_removal

Boolean

Indicates whether at least one supported device from the provider can simulate device removal. See Capability Flags.

can_hvac_cool

Boolean

Indicates whether at least one supported device from the provider can be set to cool mode. See Capability Flags.

can_hvac_heat

Boolean

Indicates whether at least one supported device from the provider can be set to heat mode. See Capability Flags.

can_hvac_heat_cool

Boolean

Indicates whether at least one supported device from the provider can be set to heat-cool mode. See Capability Flags.

can_turn_off_hvac

Boolean

Indicates whether at least one supported device from the provider can be set to off mode. See Capability Flags.

The following example shows a device_provider:

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

Last updated

Was this helpful?

Revision created

ci: Generate docs