List Device Providers

Get all device providers

Returns a list of all device providers.

/devices/list_device_providers

post

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.

Authorizations

client_sessionpat_with_workspaceconsole_session_with_workspaceapi_key

Body

provider_categorystring · enumOptional

Category for which you want to list providers.

Possible values:

Responses

200

OK

application/json

400

Bad Request

401

Unauthorized

post

HTTPcURLJavaScriptPython

POST /devices/list_device_providers HTTP/1.1
Host: connect.getseam.com
Authorization: Bearer Client Session Token
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "provider_category": "stable"
}

{
  "device_providers": [
    {
      "device_provider_name": "dormakaba_community",
      "display_name": "text",
      "image_url": "text",
      "provider_categories": [
        "stable"
      ],
      "can_remotely_unlock": true,
      "can_remotely_lock": true,
      "can_program_offline_access_codes": true,
      "can_program_online_access_codes": true,
      "can_hvac_heat": true,
      "can_hvac_cool": true,
      "can_hvac_heat_cool": true,
      "can_turn_off_hvac": true,
      "can_simulate_removal": true,
      "can_simulate_connection": true,
      "can_simulate_disconnection": true
    }
  ],
  "ok": true
}

Request

To filter the list of returned device providers by a specific device provider category, include the provider_category in the request body.

Request Body Parameters

Parameter	Type	Description
provider_category	String Optional	Provider category by which to filter device providers. Supported categories: stable consumer_smartlocks thermostats noise_sensors

Sample Request

Python

seam.devices.list_device_providers(
  provider_category="stable"
)

cURL (bash)

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/devices/list_device_providers' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${SEAM_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "provider_category": "stable"
}'

JavaScript

await seam.devices.listDeviceProviders({
  provider_category: "stable"
})

Ruby

client.devices.list_device_providers(
  provider_category: "stable"
)

C#

seam.Devices.ListDeviceProviders(
  providerCategory: Seam.Api.Devices.ListDeviceProvidersRequest.ProviderCategoryEnum.Stable
);

Java

seam.devices().listDeviceProviders(DevicesListDeviceProvidersRequest.builder()
  .providerCategory(DevicesListDeviceProvidersRequestProviderCategory.STABLE)
  .build()
);

Response

Returns an device_providers array, in which each returned device_provider contains the following properties:

Property	Description
device_provider_name	Name of the device provider.
display_name	Display name that corresponds to the device provider type.
image_url	Image URL for the device provider.
provider_categories	List of provider categories for the device provider.
can_remotely_unlock	Indicates whether at least one supported device from the provider can perform a remote unlock operation. See Capability Flags.
can_remotely_lock	Indicates whether at least one supported device from the provider can perform a remote lock operation. See Capability Flags.
can_program_online_access_codes	Indicates whether at least one supported device from the provider can program online access codes. See Capability Flags.
can_program_offline_access_codes	Indicates whether at least one supported device from the provider can program offline access codes. See Capability Flags.

Sample Response

Python

[
  DeviceProvider(    
    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
  ),
  ...
]

cURL (bash)

{
  "device_providers": [
    {
      "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
    },
    ...
  ],
  "ok": true
}

JavaScript

[
  {
    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
  },
  ...
]

Ruby

[
  <Seam::DeviceProvider:0x00438
    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
  >,
  ...
]

C#

{
  "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
}
...

Java

[
  {
    "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
  },
  ...
]