{
"partners": [
{
"partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"display_name": "<string>",
"website": "<string>",
"description_md": "<string>",
"is_live": true,
"is_featured": true,
"legacy_industry_featured": true,
"industries": [
{
"industry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"display_name": "<string>",
"short_name": "<string>"
}
],
"markets": [
"<string>"
],
"solutions": [
{
"solution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"display_name": "<string>",
"short_name": "<string>",
"type": "software"
}
],
"assets": [
{
"partner_asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "square_logo",
"url": "<string>",
"mime": "<string>",
"width": 0,
"height": 0,
"sort_order": 0
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"support": {
"supported": true,
"resolved_level": "device_category",
"declared_status": "enabled",
"observed_status": "active",
"note": "<string>",
"via_provider_slug": "<string>"
}
}
],
"ok": true
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}Get Compatible Apps
Lists the live partner apps that support a device category, manufacturer, provider or capability through Seam. A partner appears only where Seam or the partner has declared support. When you name a manufacturer and no provider, support declared for a provider also covers the manufacturers whose devices Seam connects through that provider (for example TTLock for Sifely and 33 Lock); a declaration for the manufacturer itself always takes precedence, a partner is listed when any provider serving the manufacturer lists it, and support.via_provider_slug names that provider. Browser requests from sites other than seam.co must send an embed key; server requests may send a secret key. A manufacturer key (embed or secret) defaults manufacturer_slug to its own manufacturer. With only device_category, a partner is listed when it supports any manufacturer or provider in that category through Seam.
{
"partners": [
{
"partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"display_name": "<string>",
"website": "<string>",
"description_md": "<string>",
"is_live": true,
"is_featured": true,
"legacy_industry_featured": true,
"industries": [
{
"industry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"display_name": "<string>",
"short_name": "<string>"
}
],
"markets": [
"<string>"
],
"solutions": [
{
"solution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"display_name": "<string>",
"short_name": "<string>",
"type": "software"
}
],
"assets": [
{
"partner_asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "square_logo",
"url": "<string>",
"mime": "<string>",
"width": 0,
"height": 0,
"sort_order": 0
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"support": {
"supported": true,
"resolved_level": "device_category",
"declared_status": "enabled",
"observed_status": "active",
"note": "<string>",
"via_provider_slug": "<string>"
}
}
],
"ok": true
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}Authorizations
Optional on endpoints that serve published content. A secret key (eco_sk_…), sent as Authorization: Bearer eco_sk_… from your servers only. A manufacturer secret key implies its manufacturer and can include that manufacturer's device models hidden from third parties.
Query Parameters
smartlock, thermostat, sensor, intercom, camera, acs, ...
^[a-z0-9_]+$Manufacturer slug; defaults to the manufacturer of a manufacturer key.
Provider slug, e.g. salto-ks, to narrow support to one provider.
Capability name, e.g. can_provision_mobile_keys, to narrow support to one capability.
Only partners serving this industry slug; prefer industries.
Only partners serving any of these industry slugs. Defaults to the manufacturer's saved list for a manufacturer key.
50Drops partners serving any of these industry slugs. Defaults to the manufacturer's saved list for a manufacturer key.
50Only partners selling in any of these markets: ISO 3166-1 alpha-2 country codes or region slugs (north-america, europe). Defaults to the manufacturer's saved markets for a manufacturer key.
250With markets, also keep partners whose markets are not yet known. Defaults to true, or to the manufacturer's saved setting for a manufacturer key.
Also return live partners resolved as not supported, with the reason.
Was this page helpful?