List Device Providers

List Devices

Get a list of device providers

GET https://connect.getseam.com/devices/list_device_providers

Retrieve a list of device providers, optionally filtered by provider category

Query Parameters

Name	Type	Description
provider_category	String	Category of the device provider you'd like to filter by

200: OK Successful response

{
	"device_providers": [
		{
			"device_provider_name": "akuvox",
			"display_name": "Akuvox",
			"image_url": "https://connect.getseam.com/assets/images/logos/akuvox_logo_square.png",
			"provider_categories": []
		},
		{
			"device_provider_name": "august",
			"display_name": "August",
			"image_url": "https://connect.getseam.com/assets/images/logos/august_logo_square.png",
			"provider_categories": [
				"stable"
			]
		},
		{
			"device_provider_name": "brivo",
			"display_name": "Brivo",
			"image_url": "https://connect.getseam.com/assets/images/logos/brivo_logo_square.png",
			"provider_categories": []
		},
		{
			"device_provider_name": "butterflymx",
			"display_name": "ButterflyMX",
			"image_url": "https://connect.getseam.com/assets/images/logos/butterflymx_logo_square.png",
			"provider_categories": []
		},
		{
			"device_provider_name": "doorking",
			"display_name": "Doorking",
			"image_url": "https://connect.getseam.com/assets/images/logos/doorking_logo_square.png",
			"provider_categories": []
		},
		{
			"device_provider_name": "genie",
			"display_name": "Genie",
			"image_url": "https://connect.getseam.com/assets/images/logos/genie_logo_square.png",
			"provider_categories": []
		},
		{
			"device_provider_name": "igloo",
			"display_name": "Igloohome",
			"image_url": "https://connect.getseam.com/assets/images/logos/igloohome_logo_square.png",
			"provider_categories": []
		},
		{
			"device_provider_name": "linear",
			"display_name": "Linear",
			"image_url": "https://connect.getseam.com/assets/images/logos/linear_logo_square.png",
			"provider_categories": []
		},
		{
			"device_provider_name": "lockly",
			"display_name": "Lockly",
			"image_url": "https://connect.getseam.com/assets/images/logos/lockly_logo_square.png",
			"provider_categories": []
		},
		{
			"device_provider_name": "nuki",
			"display_name": "Nuki",
			"image_url": "https://connect.getseam.com/assets/images/logos/nuki_logo_square.png",
			"provider_categories": [
				"stable"
			]
		},
		{
			"device_provider_name": "salto",
			"display_name": "Salto",
			"image_url": "https://connect.getseam.com/assets/images/logos/salto_logo_square.png",
			"provider_categories": [
				"stable"
			]
		},
		{
			"device_provider_name": "schlage",
			"display_name": "Schlage",
			"image_url": "https://connect.getseam.com/assets/images/logos/schlage_logo_square.png",
			"provider_categories": [
				"stable"
			]
		},
		{
			"device_provider_name": "seam_relay_admin",
			"display_name": "Seam",
			"image_url": "https://connect.getseam.com/assets/images/logos/seam.png",
			"provider_categories": []
		},
		{
			"device_provider_name": "smartthings",
			"display_name": "SmartThings",
			"image_url": "https://connect.getseam.com/assets/images/logos/smartthings_logo_square.png",
			"provider_categories": [
				"stable"
			]
		},
		{
			"device_provider_name": "yale_access",
			"display_name": "Yale Access",
			"image_url": "https://connect.getseam.com/assets/images/logos/yale_logo_square.png",
			"provider_categories": [
				"stable"
			]
		}
	],
	"ok": true
}

400: Bad Request Invalid provider_category

{
	"error": {
		"type": "invalid_input",
		"message": "Invalid enum value. Expected 'stable', received 'bad' for \"provider_category\"",
		"validation_errors": {
			"_errors": [],
			"provider_category": {
				"_errors": [
					"Invalid enum value. Expected 'stable', received 'bad'"
				]
			}
		},
		"request_id": "c97a717c-91fb-4cd1-a0db-94729052138b"
	},
	"ok": false
}

Code Example

Ruby

# List all device providers
seam.devices.list_device_providers
# List all stable device providers
seam.devices.list_device_providers({ provider_category: "stable" })

# Logged DeviceProvider (puts(device_provider.inspect)):
# 
# <Seam::DeviceProvider:0x001d38
#   device_provider_name="august"
#   display_name="August"
#   provider_categories=["stable"]>

Javascript

await seam.devices.listDeviceProviders();
/*
{
	device_providers: [
		{
			"device_provider_name": "akuvox",
			"display_name": "Akuvox",
			"image_url": "https://connect.getseam.com/assets/images/logos/akuvox_logo_square.png",
			"provider_categories": []
		},
		{
			"device_provider_name": "august",
			"display_name": "August",
			"image_url": "https://connect.getseam.com/assets/images/logos/august_logo_square.png",
			"provider_categories": [
				"stable"
			]
		},
		...
	]
}
*/

await seam.devices.listDeviceProviders({ provider_category: "stable" });
/*
{
	device_providers: [		
		{
			"device_provider_name": "august",
			"display_name": "August",
			"image_url": "https://connect.getseam.com/assets/images/logos/august_logo_square.png",
			"provider_categories": [
				"stable"
			]
		},
		...
	]
}

Parameters

provider_category	type: string Optional	Provider category to filter providers by. Currently supported categories: stable

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here.

JSON format

JSON

{
	"device_providers": [
		{
			"device_provider_name": "akuvox",
			"display_name": "Akuvox",
			"image_url": "https://connect.getseam.com/assets/images/logos/akuvox_logo_square.png",
			"provider_categories": []
		},
		{
			"device_provider_name": "august",
			"display_name": "August",
			"image_url": "https://connect.getseam.com/assets/images/logos/august_logo_square.png",
			"provider_categories": [
				"stable"
			]
		},
		{
			"device_provider_name": "brivo",
			"display_name": "Brivo",
			"image_url": "https://connect.getseam.com/assets/images/logos/brivo_logo_square.png",
			"provider_categories": []
		},
		{
			"device_provider_name": "butterflymx",
			"display_name": "ButterflyMX",
			"image_url": "https://connect.getseam.com/assets/images/logos/butterflymx_logo_square.png",
			"provider_categories": []
		},
		{
			"device_provider_name": "doorking",
			"display_name": "Doorking",
			"image_url": "https://connect.getseam.com/assets/images/logos/doorking_logo_square.png",
			"provider_categories": []
		},
		{
			"device_provider_name": "genie",
			"display_name": "Genie",
			"image_url": "https://connect.getseam.com/assets/images/logos/genie_logo_square.png",
			"provider_categories": []
		},
		{
			"device_provider_name": "igloo",
			"display_name": "Igloohome",
			"image_url": "https://connect.getseam.com/assets/images/logos/igloohome_logo_square.png",
			"provider_categories": []
		},
		{
			"device_provider_name": "linear",
			"display_name": "Linear",
			"image_url": "https://connect.getseam.com/assets/images/logos/linear_logo_square.png",
			"provider_categories": []
		},
		{
			"device_provider_name": "lockly",
			"display_name": "Lockly",
			"image_url": "https://connect.getseam.com/assets/images/logos/lockly_logo_square.png",
			"provider_categories": []
		},
		{
			"device_provider_name": "nuki",
			"display_name": "Nuki",
			"image_url": "https://connect.getseam.com/assets/images/logos/nuki_logo_square.png",
			"provider_categories": [
				"stable"
			]
		},
		{
			"device_provider_name": "salto",
			"display_name": "Salto",
			"image_url": "https://connect.getseam.com/assets/images/logos/salto_logo_square.png",
			"provider_categories": [
				"stable"
			]
		},
		{
			"device_provider_name": "schlage",
			"display_name": "Schlage",
			"image_url": "https://connect.getseam.com/assets/images/logos/schlage_logo_square.png",
			"provider_categories": [
				"stable"
			]
		},
		{
			"device_provider_name": "seam_relay_admin",
			"display_name": "Seam",
			"image_url": "https://connect.getseam.com/assets/images/logos/seam.png",
			"provider_categories": []
		},
		{
			"device_provider_name": "smartthings",
			"display_name": "SmartThings",
			"image_url": "https://connect.getseam.com/assets/images/logos/smartthings_logo_square.png",
			"provider_categories": [
				"stable"
			]
		},
		{
			"device_provider_name": "yale_access",
			"display_name": "Yale Access",
			"image_url": "https://connect.getseam.com/assets/images/logos/yale_logo_square.png",
			"provider_categories": [
				"stable"
			]
		}
	],
	"ok": true
}