{ "openapi": "3.1.0", "info": { "title": "Seam Ecosystem API", "version": "1.0.0", "description": "Read what Seam publishes about the devices it supports: manufacturers, device models with their images, variants and capabilities, the providers that integrate them, and the partner apps that support them through Seam.\n\nEvery endpoint accepts `GET` with query parameters, or `POST` with the same parameters as a JSON body. Successful responses include `\"ok\": true`. Published content is public, so you can call most endpoints without a key. Send an embed key from a browser, or a secret key from your servers, to identify yourself." }, "servers": [ { "url": "https://ecosystem.seam.co/v1" } ], "externalDocs": { "description": "Manufacturer API guide", "url": "https://www.seam.co/docs/device-manufacturer-guidance/manufacturer-api" }, "components": { "securitySchemes": { "secret_key": { "type": "http", "scheme": "bearer", "bearerFormat": "eco_sk_…", "description": "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." }, "embed_key": { "type": "apiKey", "in": "header", "name": "X-Embed-Key", "description": "An embed key (`eco_live_…`) for browser requests; the request's `Origin` must match one of the key's allowed origins. Optional on most endpoints, but `embed/resolve` always needs one, and so does `compatibility` from a browser on a site other than seam.co. A manufacturer embed key implies its manufacturer." }, "embed_key_param": { "type": "apiKey", "in": "query", "name": "embed_key", "description": "An embed key sent as the `embed_key` query parameter instead of the `X-Embed-Key` header." } } }, "paths": { "/capabilities/list": { "get": { "summary": "List capabilities", "description": "Lists computed capabilities for one device model or across models, ordered by device model, provider and capability name. Capability reports are resolved per `locale`, with the raw translation keys in `report_raw`. Device models hidden from third parties are excluded; with a manufacturer secret key, `include_forbidden` adds that manufacturer's own hidden models.", "tags": [ "capabilities" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "capabilities": { "type": "array", "items": { "type": "object", "properties": { "capability_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the computed capability row." }, "name": { "type": "string", "enum": [ "device_connectivity", "can_program_online_access_codes", "can_program_offline_access_codes", "can_remotely_unlock", "can_remotely_lock", "can_encode_plastic_cards", "can_assign_plastic_cards", "can_provision_mobile_keys", "can_provision_wallet_keys", "can_hvac_cool", "can_hvac_heat", "can_hvac_auto", "can_hvac_fan", "can_program_thermostat_weekly_programs", "can_monitor" ], "description": "Capability name." }, "supported": { "type": "string", "enum": [ "yes", "no", "conditionally" ], "description": "Computed support: `yes`, `no`, or `conditionally`." }, "integration_support_level": { "anyOf": [ { "type": "string", "enum": [ "inquire", "unavailable", "planned", "in-progress", "beta", "stable" ] }, { "type": "null" } ], "description": "Support level of the provider integration behind this capability; null where the source has none." }, "report": { "anyOf": [ { "type": "object", "properties": { "details": { "type": "string", "description": "Report detail text, or a translation dictionary key in `report_raw`." }, "requirements": { "description": "Requirements keyed by requirement name.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "message": { "type": "string", "description": "Requirement message, or a translation dictionary key in `report_raw`." }, "device_slugs": { "description": "Device model slugs satisfying this requirement.", "type": "array", "items": { "type": "string" } } }, "required": [ "message" ], "additionalProperties": {} } }, "dependencies": { "description": "Capability names this report depends on.", "type": "array", "items": { "type": "string" } } }, "required": [ "details" ], "additionalProperties": {} }, { "type": "null" } ], "description": "Report with `details` and requirement messages resolved to display text for `locale`, falling back to the default locale and then to a placeholder for a message with no translation. Null when no report is stored." }, "report_raw": { "anyOf": [ { "type": "object", "properties": { "details": { "type": "string", "description": "Report detail text, or a translation dictionary key in `report_raw`." }, "requirements": { "description": "Requirements keyed by requirement name.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "message": { "type": "string", "description": "Requirement message, or a translation dictionary key in `report_raw`." }, "device_slugs": { "description": "Device model slugs satisfying this requirement.", "type": "array", "items": { "type": "string" } } }, "required": [ "message" ], "additionalProperties": {} } }, "dependencies": { "description": "Capability names this report depends on.", "type": "array", "items": { "type": "string" } } }, "required": [ "details" ], "additionalProperties": {} }, { "type": "null" } ], "description": "The stored report verbatim: `details` and requirement messages are translation dictionary keys, never localized in storage." }, "locale": { "type": "string", "description": "The locale `report` was resolved in, after fallback." }, "computed_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "When this capability was computed (ISO 8601)." }, "device_model": { "type": "object", "properties": { "device_model_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device model." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `encodeplus`." } }, "required": [ "device_model_id", "slug" ], "additionalProperties": false, "description": "Device model this capability is for." }, "provider": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name" ], "additionalProperties": false, "description": "Provider this capability is for." } }, "required": [ "capability_id", "name", "supported", "integration_support_level", "report", "report_raw", "locale", "computed_at", "device_model", "provider" ], "additionalProperties": false }, "description": "Computed capabilities." }, "pagination": { "type": "object", "properties": { "has_next_page": { "type": "boolean", "description": "Whether another page follows this one." }, "next_page_cursor": { "description": "Cursor for the next page; null on the last page.", "type": [ "string", "null" ] } }, "required": [ "has_next_page", "next_page_cursor" ], "additionalProperties": false, "description": "Pagination for this page." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "capabilities", "pagination", "ok" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "parameters": [ { "name": "device_model", "in": "query", "required": false, "schema": { "description": "Device model slug; omit to read across models.", "type": "string" } }, { "name": "device_model_id", "in": "query", "required": false, "schema": { "description": "Device model UUID.", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "device_model_slugs", "in": "query", "required": false, "schema": { "description": "Only capabilities for device models with these slugs.", "type": "array", "items": { "type": "string" } } }, { "name": "provider", "in": "query", "required": false, "schema": { "description": "Provider slug.", "type": "string" } }, { "name": "names", "in": "query", "required": false, "schema": { "description": "Capability names to include.", "type": "array", "items": { "type": "string", "enum": [ "device_connectivity", "can_program_online_access_codes", "can_program_offline_access_codes", "can_remotely_unlock", "can_remotely_lock", "can_encode_plastic_cards", "can_assign_plastic_cards", "can_provision_mobile_keys", "can_provision_wallet_keys", "can_hvac_cool", "can_hvac_heat", "can_hvac_auto", "can_hvac_fan", "can_program_thermostat_weekly_programs", "can_monitor" ] } } }, { "name": "supported", "in": "query", "required": false, "schema": { "description": "Only capabilities with this support value.", "type": "string", "enum": [ "yes", "no", "conditionally" ] } }, { "name": "include_forbidden", "in": "query", "required": false, "schema": { "description": "Include models forbidden to third parties (`is_forbidden_to_3dparty`): all of them for Seam callers, its own for a manufacturer secret key, none otherwise. Defaults to false.", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] } }, { "name": "locale", "in": "query", "required": false, "schema": { "description": "Locale for resolved capability report text; unknown locales fall back to the default locale.", "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 100, "description": "Maximum number of capabilities to return (1-500).", "type": "integer", "minimum": 1, "maximum": 500 } }, { "name": "page_cursor", "in": "query", "required": false, "schema": { "description": "The `next_page_cursor` from the previous page.", "type": "string" } } ] }, "post": { "summary": "List capabilities", "description": "Lists computed capabilities for one device model or across models, ordered by device model, provider and capability name. Capability reports are resolved per `locale`, with the raw translation keys in `report_raw`. Device models hidden from third parties are excluded; with a manufacturer secret key, `include_forbidden` adds that manufacturer's own hidden models.", "tags": [ "capabilities" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "capabilities": { "type": "array", "items": { "type": "object", "properties": { "capability_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the computed capability row." }, "name": { "type": "string", "enum": [ "device_connectivity", "can_program_online_access_codes", "can_program_offline_access_codes", "can_remotely_unlock", "can_remotely_lock", "can_encode_plastic_cards", "can_assign_plastic_cards", "can_provision_mobile_keys", "can_provision_wallet_keys", "can_hvac_cool", "can_hvac_heat", "can_hvac_auto", "can_hvac_fan", "can_program_thermostat_weekly_programs", "can_monitor" ], "description": "Capability name." }, "supported": { "type": "string", "enum": [ "yes", "no", "conditionally" ], "description": "Computed support: `yes`, `no`, or `conditionally`." }, "integration_support_level": { "anyOf": [ { "type": "string", "enum": [ "inquire", "unavailable", "planned", "in-progress", "beta", "stable" ] }, { "type": "null" } ], "description": "Support level of the provider integration behind this capability; null where the source has none." }, "report": { "anyOf": [ { "type": "object", "properties": { "details": { "type": "string", "description": "Report detail text, or a translation dictionary key in `report_raw`." }, "requirements": { "description": "Requirements keyed by requirement name.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "message": { "type": "string", "description": "Requirement message, or a translation dictionary key in `report_raw`." }, "device_slugs": { "description": "Device model slugs satisfying this requirement.", "type": "array", "items": { "type": "string" } } }, "required": [ "message" ], "additionalProperties": {} } }, "dependencies": { "description": "Capability names this report depends on.", "type": "array", "items": { "type": "string" } } }, "required": [ "details" ], "additionalProperties": {} }, { "type": "null" } ], "description": "Report with `details` and requirement messages resolved to display text for `locale`, falling back to the default locale and then to a placeholder for a message with no translation. Null when no report is stored." }, "report_raw": { "anyOf": [ { "type": "object", "properties": { "details": { "type": "string", "description": "Report detail text, or a translation dictionary key in `report_raw`." }, "requirements": { "description": "Requirements keyed by requirement name.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "message": { "type": "string", "description": "Requirement message, or a translation dictionary key in `report_raw`." }, "device_slugs": { "description": "Device model slugs satisfying this requirement.", "type": "array", "items": { "type": "string" } } }, "required": [ "message" ], "additionalProperties": {} } }, "dependencies": { "description": "Capability names this report depends on.", "type": "array", "items": { "type": "string" } } }, "required": [ "details" ], "additionalProperties": {} }, { "type": "null" } ], "description": "The stored report verbatim: `details` and requirement messages are translation dictionary keys, never localized in storage." }, "locale": { "type": "string", "description": "The locale `report` was resolved in, after fallback." }, "computed_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "When this capability was computed (ISO 8601)." }, "device_model": { "type": "object", "properties": { "device_model_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device model." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `encodeplus`." } }, "required": [ "device_model_id", "slug" ], "additionalProperties": false, "description": "Device model this capability is for." }, "provider": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name" ], "additionalProperties": false, "description": "Provider this capability is for." } }, "required": [ "capability_id", "name", "supported", "integration_support_level", "report", "report_raw", "locale", "computed_at", "device_model", "provider" ], "additionalProperties": false }, "description": "Computed capabilities." }, "pagination": { "type": "object", "properties": { "has_next_page": { "type": "boolean", "description": "Whether another page follows this one." }, "next_page_cursor": { "description": "Cursor for the next page; null on the last page.", "type": [ "string", "null" ] } }, "required": [ "has_next_page", "next_page_cursor" ], "additionalProperties": false, "description": "Pagination for this page." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "capabilities", "pagination", "ok" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "device_model": { "description": "Device model slug; omit to read across models.", "type": "string" }, "device_model_id": { "description": "Device model UUID.", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "device_model_slugs": { "description": "Only capabilities for device models with these slugs.", "type": "array", "items": { "type": "string" } }, "provider": { "description": "Provider slug.", "type": "string" }, "names": { "description": "Capability names to include.", "type": "array", "items": { "type": "string", "enum": [ "device_connectivity", "can_program_online_access_codes", "can_program_offline_access_codes", "can_remotely_unlock", "can_remotely_lock", "can_encode_plastic_cards", "can_assign_plastic_cards", "can_provision_mobile_keys", "can_provision_wallet_keys", "can_hvac_cool", "can_hvac_heat", "can_hvac_auto", "can_hvac_fan", "can_program_thermostat_weekly_programs", "can_monitor" ] } }, "supported": { "description": "Only capabilities with this support value.", "type": "string", "enum": [ "yes", "no", "conditionally" ] }, "include_forbidden": { "description": "Include models forbidden to third parties (`is_forbidden_to_3dparty`): all of them for Seam callers, its own for a manufacturer secret key, none otherwise. Defaults to false.", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] }, "locale": { "description": "Locale for resolved capability report text; unknown locales fall back to the default locale.", "type": "string" }, "limit": { "default": 100, "description": "Maximum number of capabilities to return (1-500).", "type": "integer", "minimum": 1, "maximum": 500 }, "page_cursor": { "description": "The `next_page_cursor` from the previous page.", "type": "string" } } } } } } } }, "/compatibility": { "get": { "summary": "Compatibility", "description": "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.", "tags": [ "compatibility" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "partners": { "type": "array", "items": { "type": "object", "properties": { "partner_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the partner." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `hospitable`." }, "display_name": { "type": "string", "description": "Display name." }, "website": { "description": "Website URL, when recorded.", "type": [ "string", "null" ] }, "description_md": { "description": "Markdown description written by Seam or the partner.", "type": [ "string", "null" ] }, "is_live": { "type": "boolean", "description": "The partner's Seam integration is live for its customers." }, "is_featured": { "type": "boolean", "description": "Featured by Seam in partner listings." }, "legacy_industry_featured": { "type": "boolean", "description": "Legacy per-industry featured flag; use `is_featured`." }, "industries": { "type": "array", "items": { "type": "object", "properties": { "industry_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the industry." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `short-term-rental`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] } }, "required": [ "industry_id", "slug", "display_name", "short_name" ], "additionalProperties": false }, "description": "Industries the partner serves." }, "markets": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Countries the partner sells in, as ISO 3166-1 alpha-2 codes; null when unknown." }, "solutions": { "type": "array", "items": { "type": "object", "properties": { "solution_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the solution." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `property-management-system`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "software", "service" ], "description": "`software` or `service`." } }, "required": [ "solution_id", "slug", "display_name", "short_name", "type" ], "additionalProperties": false }, "description": "Kinds of software or service the partner offers." }, "assets": { "type": "array", "items": { "type": "object", "properties": { "partner_asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "product_image" ], "description": "Logo kind or `product_image`." }, "url": { "type": "string", "format": "uri", "description": "Public URL of the asset." }, "mime": { "type": "string", "description": "Media type." }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Display order within the partner." } }, "required": [ "partner_asset_id", "kind", "url", "mime", "width", "height", "sort_order" ], "additionalProperties": false }, "description": "Logos and product images in display order." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." }, "support": { "type": "object", "properties": { "supported": { "type": "boolean", "description": "Whether the partner is listed for the requested scope." }, "resolved_level": { "anyOf": [ { "type": "string", "enum": [ "device_category", "manufacturer", "provider", "capability" ] }, { "type": "null" } ], "description": "The most specific level with a declaration that decided the outcome; null when nothing is declared. `provider` with `via_provider_slug` when a manufacturer was resolved through a provider that serves it." }, "declared_status": { "anyOf": [ { "type": "string", "enum": [ "enabled", "disabled", "not_via_seam" ] }, { "type": "null" } ], "description": "The deciding declaration: `enabled`, `disabled` or `not_via_seam`." }, "observed_status": { "anyOf": [ { "type": "string", "enum": [ "active", "trace", "none", "unknown" ] }, { "type": "null" } ], "description": "What the nightly usage sync observed at that scope; informational only." }, "note": { "description": "Note recorded with the deciding declaration, when any.", "type": [ "string", "null" ] }, "via_provider_slug": { "description": "Present when the deciding declaration was made for a provider the query did not name: a provider serving the requested manufacturer's devices (e.g. `tt-lock` for Sifely), or the provider backing the requested one (e.g. `tt-lock` for `33-lock`).", "type": "string" } }, "required": [ "supported", "resolved_level", "declared_status", "observed_status", "note" ], "additionalProperties": false, "description": "How the support matrix resolved for the requested scope, with the partner's note." } }, "required": [ "partner_id", "slug", "display_name", "website", "description_md", "is_live", "is_featured", "legacy_industry_featured", "industries", "markets", "solutions", "assets", "created_at", "updated_at", "support" ], "additionalProperties": false }, "description": "Live partners that support the requested scope." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "partners", "ok" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "parameters": [ { "name": "device_category", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-z0-9_]+$", "description": "smartlock, thermostat, sensor, intercom, camera, acs, ..." } }, { "name": "manufacturer_slug", "in": "query", "required": false, "schema": { "default": "", "description": "Manufacturer slug; defaults to the manufacturer of a manufacturer key.", "type": "string" } }, { "name": "provider_slug", "in": "query", "required": false, "schema": { "default": "", "description": "Provider slug, e.g. `salto-ks`, to narrow support to one provider.", "type": "string" } }, { "name": "capability", "in": "query", "required": false, "schema": { "default": "", "description": "Capability name, e.g. `can_provision_mobile_keys`, to narrow support to one capability.", "type": "string" } }, { "name": "industry", "in": "query", "required": false, "schema": { "description": "Only partners serving this industry slug; prefer `industries`.", "type": "string" } }, { "name": "industries", "in": "query", "required": false, "schema": { "description": "Only partners serving any of these industry slugs. Defaults to the manufacturer's saved list for a manufacturer key.", "maxItems": 50, "type": "array", "items": { "type": "string" } } }, { "name": "exclude_industries", "in": "query", "required": false, "schema": { "description": "Drops partners serving any of these industry slugs. Defaults to the manufacturer's saved list for a manufacturer key.", "maxItems": 50, "type": "array", "items": { "type": "string" } } }, { "name": "markets", "in": "query", "required": false, "schema": { "description": "Only 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.", "maxItems": 250, "type": "array", "items": { "type": "string" } } }, { "name": "include_unknown_markets", "in": "query", "required": false, "schema": { "description": "With `markets`, also keep partners whose markets are not yet known. Defaults to true, or to the manufacturer's saved setting for a manufacturer key.", "type": "boolean" } }, { "name": "include_unsupported", "in": "query", "required": false, "schema": { "default": false, "description": "Also return live partners resolved as not supported, with the reason.", "type": "boolean" } } ] }, "post": { "summary": "Compatibility", "description": "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.", "tags": [ "compatibility" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "partners": { "type": "array", "items": { "type": "object", "properties": { "partner_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the partner." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `hospitable`." }, "display_name": { "type": "string", "description": "Display name." }, "website": { "description": "Website URL, when recorded.", "type": [ "string", "null" ] }, "description_md": { "description": "Markdown description written by Seam or the partner.", "type": [ "string", "null" ] }, "is_live": { "type": "boolean", "description": "The partner's Seam integration is live for its customers." }, "is_featured": { "type": "boolean", "description": "Featured by Seam in partner listings." }, "legacy_industry_featured": { "type": "boolean", "description": "Legacy per-industry featured flag; use `is_featured`." }, "industries": { "type": "array", "items": { "type": "object", "properties": { "industry_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the industry." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `short-term-rental`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] } }, "required": [ "industry_id", "slug", "display_name", "short_name" ], "additionalProperties": false }, "description": "Industries the partner serves." }, "markets": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Countries the partner sells in, as ISO 3166-1 alpha-2 codes; null when unknown." }, "solutions": { "type": "array", "items": { "type": "object", "properties": { "solution_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the solution." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `property-management-system`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "software", "service" ], "description": "`software` or `service`." } }, "required": [ "solution_id", "slug", "display_name", "short_name", "type" ], "additionalProperties": false }, "description": "Kinds of software or service the partner offers." }, "assets": { "type": "array", "items": { "type": "object", "properties": { "partner_asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "product_image" ], "description": "Logo kind or `product_image`." }, "url": { "type": "string", "format": "uri", "description": "Public URL of the asset." }, "mime": { "type": "string", "description": "Media type." }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Display order within the partner." } }, "required": [ "partner_asset_id", "kind", "url", "mime", "width", "height", "sort_order" ], "additionalProperties": false }, "description": "Logos and product images in display order." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." }, "support": { "type": "object", "properties": { "supported": { "type": "boolean", "description": "Whether the partner is listed for the requested scope." }, "resolved_level": { "anyOf": [ { "type": "string", "enum": [ "device_category", "manufacturer", "provider", "capability" ] }, { "type": "null" } ], "description": "The most specific level with a declaration that decided the outcome; null when nothing is declared. `provider` with `via_provider_slug` when a manufacturer was resolved through a provider that serves it." }, "declared_status": { "anyOf": [ { "type": "string", "enum": [ "enabled", "disabled", "not_via_seam" ] }, { "type": "null" } ], "description": "The deciding declaration: `enabled`, `disabled` or `not_via_seam`." }, "observed_status": { "anyOf": [ { "type": "string", "enum": [ "active", "trace", "none", "unknown" ] }, { "type": "null" } ], "description": "What the nightly usage sync observed at that scope; informational only." }, "note": { "description": "Note recorded with the deciding declaration, when any.", "type": [ "string", "null" ] }, "via_provider_slug": { "description": "Present when the deciding declaration was made for a provider the query did not name: a provider serving the requested manufacturer's devices (e.g. `tt-lock` for Sifely), or the provider backing the requested one (e.g. `tt-lock` for `33-lock`).", "type": "string" } }, "required": [ "supported", "resolved_level", "declared_status", "observed_status", "note" ], "additionalProperties": false, "description": "How the support matrix resolved for the requested scope, with the partner's note." } }, "required": [ "partner_id", "slug", "display_name", "website", "description_md", "is_live", "is_featured", "legacy_industry_featured", "industries", "markets", "solutions", "assets", "created_at", "updated_at", "support" ], "additionalProperties": false }, "description": "Live partners that support the requested scope." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "partners", "ok" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "device_category": { "type": "string", "pattern": "^[a-z0-9_]+$", "description": "smartlock, thermostat, sensor, intercom, camera, acs, ..." }, "manufacturer_slug": { "default": "", "description": "Manufacturer slug; defaults to the manufacturer of a manufacturer key.", "type": "string" }, "provider_slug": { "default": "", "description": "Provider slug, e.g. `salto-ks`, to narrow support to one provider.", "type": "string" }, "capability": { "default": "", "description": "Capability name, e.g. `can_provision_mobile_keys`, to narrow support to one capability.", "type": "string" }, "industry": { "description": "Only partners serving this industry slug; prefer `industries`.", "type": "string" }, "industries": { "description": "Only partners serving any of these industry slugs. Defaults to the manufacturer's saved list for a manufacturer key.", "maxItems": 50, "type": "array", "items": { "type": "string" } }, "exclude_industries": { "description": "Drops partners serving any of these industry slugs. Defaults to the manufacturer's saved list for a manufacturer key.", "maxItems": 50, "type": "array", "items": { "type": "string" } }, "markets": { "description": "Only 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.", "maxItems": 250, "type": "array", "items": { "type": "string" } }, "include_unknown_markets": { "description": "With `markets`, also keep partners whose markets are not yet known. Defaults to true, or to the manufacturer's saved setting for a manufacturer key.", "type": "boolean" }, "embed_key": { "description": "Embed key, as an alternative to the `X-Embed-Key` header or the `embed_key` query parameter.", "type": "string" }, "include_unsupported": { "default": false, "description": "Also return live partners resolved as not supported, with the reason.", "type": "boolean" } }, "required": [ "device_category" ] } } } } } }, "/device_models/get": { "get": { "summary": "Get a device model", "description": "Returns one published device model by `slug` or `device_model_id`, with variants, properties, featured image, providers and capabilities grouped by provider. A model hidden from third parties is not found unless the request uses its manufacturer's secret key and sets `include_forbidden`. Capability reports are resolved per `locale`, with the raw translation keys in `report_raw`.", "tags": [ "device_models" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "device_model": { "type": "object", "properties": { "device_model_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device model." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `encodeplus`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] }, "description_md": { "description": "Description in markdown, when recorded.", "type": [ "string", "null" ] }, "product_url": { "description": "Manufacturer product page URL, when recorded.", "type": [ "string", "null" ] }, "is_forbidden_to_3dparty": { "description": "Forbidden to third-party consumers; such models are excluded from public reads unless a Seam caller sets `include_forbidden`.", "type": [ "boolean", "null" ] }, "no_longer_sold": { "description": "Whether the model is no longer sold; null where not established.", "type": [ "boolean", "null" ] }, "shop_listings": { "anyOf": [ { "$ref": "#/paths/~1device_models~1get/get/responses/200/content/application~1json/schema/$defs/__schema0" }, { "type": "null" } ], "description": "Commerce listing data verbatim from the source." }, "last_commerce_search_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ], "description": "When commerce listings were last searched; null is a recorded fact, not an omission." }, "manufacturer": { "anyOf": [ { "type": "object", "properties": { "manufacturer_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the manufacturer." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `schlage`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "manufacturer_id", "slug", "display_name" ], "additionalProperties": false }, { "type": "null" } ], "description": "Pinned published manufacturer, when set." }, "device_type": { "anyOf": [ { "type": "object", "properties": { "device_type_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device type." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `smartlock`." }, "display_name": { "type": "string", "description": "Display name." }, "is_accessory": { "type": "boolean", "description": "Accessory types (bridges, keypads) rather than primary devices." } }, "required": [ "device_type_id", "slug", "display_name", "is_accessory" ], "additionalProperties": false }, { "type": "null" } ], "description": "Pinned published device type, when set." }, "device_type_properties": { "anyOf": [ { "$ref": "#/paths/~1device_models~1get/get/responses/200/content/application~1json/schema/$defs/__schema1" }, { "type": "null" } ], "description": "Per-device-type properties verbatim, including the source component discriminator; null for accessory types." }, "variants": { "type": "array", "items": { "type": "object", "properties": { "device_model_variant_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the variant." }, "color_name": { "description": "Variant color axis; the only axes are color and style.", "type": [ "string", "null" ] }, "style_name": { "description": "Variant style axis; the only axes are color and style.", "type": [ "string", "null" ] }, "primary_color_hex": { "description": "Primary color as a hex value, when recorded.", "type": [ "string", "null" ] }, "manufacturer_model_id": { "description": "Manufacturer's own model identifier, when recorded.", "type": [ "string", "null" ] }, "asin": { "description": "Amazon ASIN, when recorded.", "type": [ "string", "null" ] }, "gtins": { "anyOf": [ { "$ref": "#/paths/~1device_models~1get/get/responses/200/content/application~1json/schema/$defs/__schema2" }, { "type": "null" } ], "description": "GTIN values verbatim from the source." }, "marketplace_listings": { "anyOf": [ { "$ref": "#/paths/~1device_models~1get/get/responses/200/content/application~1json/schema/$defs/__schema3" }, { "type": "null" } ], "description": "Marketplace listing data verbatim from the source." }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Variant ordering as in the source." }, "images": { "type": "array", "items": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Images of this variant." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "device_model_variant_id", "color_name", "style_name", "primary_color_hex", "manufacturer_model_id", "asin", "gtins", "marketplace_listings", "sort_order", "images", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Variants in source order, each with its images." }, "featured_image": { "anyOf": [ { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false }, { "type": "null" } ], "description": "Featured image with its derived formats, when present." }, "providers": { "type": "array", "items": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name" ], "additionalProperties": false }, "description": "Providers that can create accesses on this model." }, "capabilities_by_provider": { "type": "array", "items": { "type": "object", "properties": { "provider": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name" ], "additionalProperties": false, "description": "Provider the capabilities belong to." }, "capabilities": { "type": "array", "items": { "type": "object", "properties": { "capability_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the computed capability row." }, "name": { "type": "string", "enum": [ "device_connectivity", "can_program_online_access_codes", "can_program_offline_access_codes", "can_remotely_unlock", "can_remotely_lock", "can_encode_plastic_cards", "can_assign_plastic_cards", "can_provision_mobile_keys", "can_provision_wallet_keys", "can_hvac_cool", "can_hvac_heat", "can_hvac_auto", "can_hvac_fan", "can_program_thermostat_weekly_programs", "can_monitor" ], "description": "Capability name." }, "supported": { "type": "string", "enum": [ "yes", "no", "conditionally" ], "description": "Computed support: `yes`, `no`, or `conditionally`." }, "integration_support_level": { "anyOf": [ { "type": "string", "enum": [ "inquire", "unavailable", "planned", "in-progress", "beta", "stable" ] }, { "type": "null" } ], "description": "Support level of the provider integration behind this capability; null where the source has none." }, "report": { "anyOf": [ { "type": "object", "properties": { "details": { "type": "string", "description": "Report detail text, or a translation dictionary key in `report_raw`." }, "requirements": { "description": "Requirements keyed by requirement name.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "message": { "type": "string", "description": "Requirement message, or a translation dictionary key in `report_raw`." }, "device_slugs": { "description": "Device model slugs satisfying this requirement.", "type": "array", "items": { "type": "string" } } }, "required": [ "message" ], "additionalProperties": {} } }, "dependencies": { "description": "Capability names this report depends on.", "type": "array", "items": { "type": "string" } } }, "required": [ "details" ], "additionalProperties": {} }, { "type": "null" } ], "description": "Report with `details` and requirement messages resolved to display text for `locale`, falling back to the default locale and then to a placeholder for a message with no translation. Null when no report is stored." }, "report_raw": { "anyOf": [ { "type": "object", "properties": { "details": { "type": "string", "description": "Report detail text, or a translation dictionary key in `report_raw`." }, "requirements": { "description": "Requirements keyed by requirement name.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "message": { "type": "string", "description": "Requirement message, or a translation dictionary key in `report_raw`." }, "device_slugs": { "description": "Device model slugs satisfying this requirement.", "type": "array", "items": { "type": "string" } } }, "required": [ "message" ], "additionalProperties": {} } }, "dependencies": { "description": "Capability names this report depends on.", "type": "array", "items": { "type": "string" } } }, "required": [ "details" ], "additionalProperties": {} }, { "type": "null" } ], "description": "The stored report verbatim: `details` and requirement messages are translation dictionary keys, never localized in storage." }, "locale": { "type": "string", "description": "The locale `report` was resolved in, after fallback." }, "computed_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "When this capability was computed (ISO 8601)." } }, "required": [ "capability_id", "name", "supported", "integration_support_level", "report", "report_raw", "locale", "computed_at" ], "additionalProperties": false }, "description": "Computed capabilities for that provider." } }, "required": [ "provider", "capabilities" ], "additionalProperties": false }, "description": "Currently published computed capabilities grouped by provider; stale scopes are omitted." }, "capabilities_stale": { "type": "boolean", "description": "True when some linked providers' capabilities are out of date after a change to the model, its providers or the capability engine, so they are omitted from `capabilities_by_provider` until Seam recomputes them. A provider whose correct result is no capabilities is not stale." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "device_model_id", "slug", "display_name", "description_md", "product_url", "is_forbidden_to_3dparty", "no_longer_sold", "shop_listings", "last_commerce_search_at", "manufacturer", "device_type", "device_type_properties", "variants", "featured_image", "providers", "capabilities_by_provider", "capabilities_stale", "created_at", "updated_at" ], "additionalProperties": false, "description": "The published device model." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "device_model", "ok" ], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1device_models~1get/get/responses/200/content/application~1json/schema/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1device_models~1get/get/responses/200/content/application~1json/schema/$defs/__schema0" } } ] }, "__schema1": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1device_models~1get/get/responses/200/content/application~1json/schema/$defs/__schema1" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1device_models~1get/get/responses/200/content/application~1json/schema/$defs/__schema1" } } ] }, "__schema2": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1device_models~1get/get/responses/200/content/application~1json/schema/$defs/__schema2" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1device_models~1get/get/responses/200/content/application~1json/schema/$defs/__schema2" } } ] }, "__schema3": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1device_models~1get/get/responses/200/content/application~1json/schema/$defs/__schema3" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1device_models~1get/get/responses/200/content/application~1json/schema/$defs/__schema3" } } ] } } } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "parameters": [ { "name": "slug", "in": "query", "required": false, "schema": { "description": "Device model slug; provide this or `device_model_id`.", "type": "string" } }, { "name": "device_model_id", "in": "query", "required": false, "schema": { "description": "Device model UUID; provide this or `slug`.", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "include_forbidden", "in": "query", "required": false, "schema": { "description": "Include models forbidden to third parties (`is_forbidden_to_3dparty`): all of them for Seam callers, its own for a manufacturer secret key, none otherwise. Defaults to false.", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] } }, { "name": "locale", "in": "query", "required": false, "schema": { "description": "Locale for resolved capability report text; unknown locales fall back to the default locale.", "type": "string" } } ] }, "post": { "summary": "Get a device model", "description": "Returns one published device model by `slug` or `device_model_id`, with variants, properties, featured image, providers and capabilities grouped by provider. A model hidden from third parties is not found unless the request uses its manufacturer's secret key and sets `include_forbidden`. Capability reports are resolved per `locale`, with the raw translation keys in `report_raw`.", "tags": [ "device_models" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "device_model": { "type": "object", "properties": { "device_model_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device model." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `encodeplus`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] }, "description_md": { "description": "Description in markdown, when recorded.", "type": [ "string", "null" ] }, "product_url": { "description": "Manufacturer product page URL, when recorded.", "type": [ "string", "null" ] }, "is_forbidden_to_3dparty": { "description": "Forbidden to third-party consumers; such models are excluded from public reads unless a Seam caller sets `include_forbidden`.", "type": [ "boolean", "null" ] }, "no_longer_sold": { "description": "Whether the model is no longer sold; null where not established.", "type": [ "boolean", "null" ] }, "shop_listings": { "anyOf": [ { "$ref": "#/paths/~1device_models~1get/post/responses/200/content/application~1json/schema/$defs/__schema0" }, { "type": "null" } ], "description": "Commerce listing data verbatim from the source." }, "last_commerce_search_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ], "description": "When commerce listings were last searched; null is a recorded fact, not an omission." }, "manufacturer": { "anyOf": [ { "type": "object", "properties": { "manufacturer_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the manufacturer." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `schlage`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "manufacturer_id", "slug", "display_name" ], "additionalProperties": false }, { "type": "null" } ], "description": "Pinned published manufacturer, when set." }, "device_type": { "anyOf": [ { "type": "object", "properties": { "device_type_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device type." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `smartlock`." }, "display_name": { "type": "string", "description": "Display name." }, "is_accessory": { "type": "boolean", "description": "Accessory types (bridges, keypads) rather than primary devices." } }, "required": [ "device_type_id", "slug", "display_name", "is_accessory" ], "additionalProperties": false }, { "type": "null" } ], "description": "Pinned published device type, when set." }, "device_type_properties": { "anyOf": [ { "$ref": "#/paths/~1device_models~1get/post/responses/200/content/application~1json/schema/$defs/__schema1" }, { "type": "null" } ], "description": "Per-device-type properties verbatim, including the source component discriminator; null for accessory types." }, "variants": { "type": "array", "items": { "type": "object", "properties": { "device_model_variant_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the variant." }, "color_name": { "description": "Variant color axis; the only axes are color and style.", "type": [ "string", "null" ] }, "style_name": { "description": "Variant style axis; the only axes are color and style.", "type": [ "string", "null" ] }, "primary_color_hex": { "description": "Primary color as a hex value, when recorded.", "type": [ "string", "null" ] }, "manufacturer_model_id": { "description": "Manufacturer's own model identifier, when recorded.", "type": [ "string", "null" ] }, "asin": { "description": "Amazon ASIN, when recorded.", "type": [ "string", "null" ] }, "gtins": { "anyOf": [ { "$ref": "#/paths/~1device_models~1get/post/responses/200/content/application~1json/schema/$defs/__schema2" }, { "type": "null" } ], "description": "GTIN values verbatim from the source." }, "marketplace_listings": { "anyOf": [ { "$ref": "#/paths/~1device_models~1get/post/responses/200/content/application~1json/schema/$defs/__schema3" }, { "type": "null" } ], "description": "Marketplace listing data verbatim from the source." }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Variant ordering as in the source." }, "images": { "type": "array", "items": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Images of this variant." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "device_model_variant_id", "color_name", "style_name", "primary_color_hex", "manufacturer_model_id", "asin", "gtins", "marketplace_listings", "sort_order", "images", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Variants in source order, each with its images." }, "featured_image": { "anyOf": [ { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false }, { "type": "null" } ], "description": "Featured image with its derived formats, when present." }, "providers": { "type": "array", "items": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name" ], "additionalProperties": false }, "description": "Providers that can create accesses on this model." }, "capabilities_by_provider": { "type": "array", "items": { "type": "object", "properties": { "provider": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name" ], "additionalProperties": false, "description": "Provider the capabilities belong to." }, "capabilities": { "type": "array", "items": { "type": "object", "properties": { "capability_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the computed capability row." }, "name": { "type": "string", "enum": [ "device_connectivity", "can_program_online_access_codes", "can_program_offline_access_codes", "can_remotely_unlock", "can_remotely_lock", "can_encode_plastic_cards", "can_assign_plastic_cards", "can_provision_mobile_keys", "can_provision_wallet_keys", "can_hvac_cool", "can_hvac_heat", "can_hvac_auto", "can_hvac_fan", "can_program_thermostat_weekly_programs", "can_monitor" ], "description": "Capability name." }, "supported": { "type": "string", "enum": [ "yes", "no", "conditionally" ], "description": "Computed support: `yes`, `no`, or `conditionally`." }, "integration_support_level": { "anyOf": [ { "type": "string", "enum": [ "inquire", "unavailable", "planned", "in-progress", "beta", "stable" ] }, { "type": "null" } ], "description": "Support level of the provider integration behind this capability; null where the source has none." }, "report": { "anyOf": [ { "type": "object", "properties": { "details": { "type": "string", "description": "Report detail text, or a translation dictionary key in `report_raw`." }, "requirements": { "description": "Requirements keyed by requirement name.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "message": { "type": "string", "description": "Requirement message, or a translation dictionary key in `report_raw`." }, "device_slugs": { "description": "Device model slugs satisfying this requirement.", "type": "array", "items": { "type": "string" } } }, "required": [ "message" ], "additionalProperties": {} } }, "dependencies": { "description": "Capability names this report depends on.", "type": "array", "items": { "type": "string" } } }, "required": [ "details" ], "additionalProperties": {} }, { "type": "null" } ], "description": "Report with `details` and requirement messages resolved to display text for `locale`, falling back to the default locale and then to a placeholder for a message with no translation. Null when no report is stored." }, "report_raw": { "anyOf": [ { "type": "object", "properties": { "details": { "type": "string", "description": "Report detail text, or a translation dictionary key in `report_raw`." }, "requirements": { "description": "Requirements keyed by requirement name.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "message": { "type": "string", "description": "Requirement message, or a translation dictionary key in `report_raw`." }, "device_slugs": { "description": "Device model slugs satisfying this requirement.", "type": "array", "items": { "type": "string" } } }, "required": [ "message" ], "additionalProperties": {} } }, "dependencies": { "description": "Capability names this report depends on.", "type": "array", "items": { "type": "string" } } }, "required": [ "details" ], "additionalProperties": {} }, { "type": "null" } ], "description": "The stored report verbatim: `details` and requirement messages are translation dictionary keys, never localized in storage." }, "locale": { "type": "string", "description": "The locale `report` was resolved in, after fallback." }, "computed_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "When this capability was computed (ISO 8601)." } }, "required": [ "capability_id", "name", "supported", "integration_support_level", "report", "report_raw", "locale", "computed_at" ], "additionalProperties": false }, "description": "Computed capabilities for that provider." } }, "required": [ "provider", "capabilities" ], "additionalProperties": false }, "description": "Currently published computed capabilities grouped by provider; stale scopes are omitted." }, "capabilities_stale": { "type": "boolean", "description": "True when some linked providers' capabilities are out of date after a change to the model, its providers or the capability engine, so they are omitted from `capabilities_by_provider` until Seam recomputes them. A provider whose correct result is no capabilities is not stale." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "device_model_id", "slug", "display_name", "description_md", "product_url", "is_forbidden_to_3dparty", "no_longer_sold", "shop_listings", "last_commerce_search_at", "manufacturer", "device_type", "device_type_properties", "variants", "featured_image", "providers", "capabilities_by_provider", "capabilities_stale", "created_at", "updated_at" ], "additionalProperties": false, "description": "The published device model." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "device_model", "ok" ], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1device_models~1get/post/responses/200/content/application~1json/schema/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1device_models~1get/post/responses/200/content/application~1json/schema/$defs/__schema0" } } ] }, "__schema1": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1device_models~1get/post/responses/200/content/application~1json/schema/$defs/__schema1" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1device_models~1get/post/responses/200/content/application~1json/schema/$defs/__schema1" } } ] }, "__schema2": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1device_models~1get/post/responses/200/content/application~1json/schema/$defs/__schema2" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1device_models~1get/post/responses/200/content/application~1json/schema/$defs/__schema2" } } ] }, "__schema3": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1device_models~1get/post/responses/200/content/application~1json/schema/$defs/__schema3" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1device_models~1get/post/responses/200/content/application~1json/schema/$defs/__schema3" } } ] } } } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "slug": { "description": "Device model slug; provide this or `device_model_id`.", "type": "string" }, "device_model_id": { "description": "Device model UUID; provide this or `slug`.", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "include_forbidden": { "description": "Include models forbidden to third parties (`is_forbidden_to_3dparty`): all of them for Seam callers, its own for a manufacturer secret key, none otherwise. Defaults to false.", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] }, "locale": { "description": "Locale for resolved capability report text; unknown locales fall back to the default locale.", "type": "string" } } } } } } } }, "/device_models/list": { "get": { "summary": "List device models", "description": "Lists published device models with variants, properties, featured image, providers and capabilities grouped by provider, ordered by slug. Filters combine with AND. A manufacturer key (embed or secret) defaults `manufacturer` to its own manufacturer; pass another slug to list that manufacturer's models. Device models hidden from third parties are excluded; with a manufacturer secret key, `include_forbidden` adds that manufacturer's own hidden models. Capability reports are resolved per `locale`, with the raw translation keys in `report_raw`.", "tags": [ "device_models" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "device_models": { "type": "array", "items": { "type": "object", "properties": { "device_model_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device model." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `encodeplus`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] }, "description_md": { "description": "Description in markdown, when recorded.", "type": [ "string", "null" ] }, "product_url": { "description": "Manufacturer product page URL, when recorded.", "type": [ "string", "null" ] }, "is_forbidden_to_3dparty": { "description": "Forbidden to third-party consumers; such models are excluded from public reads unless a Seam caller sets `include_forbidden`.", "type": [ "boolean", "null" ] }, "no_longer_sold": { "description": "Whether the model is no longer sold; null where not established.", "type": [ "boolean", "null" ] }, "shop_listings": { "anyOf": [ { "$ref": "#/paths/~1device_models~1list/get/responses/200/content/application~1json/schema/$defs/__schema0" }, { "type": "null" } ], "description": "Commerce listing data verbatim from the source." }, "last_commerce_search_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ], "description": "When commerce listings were last searched; null is a recorded fact, not an omission." }, "manufacturer": { "anyOf": [ { "type": "object", "properties": { "manufacturer_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the manufacturer." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `schlage`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "manufacturer_id", "slug", "display_name" ], "additionalProperties": false }, { "type": "null" } ], "description": "Pinned published manufacturer, when set." }, "device_type": { "anyOf": [ { "type": "object", "properties": { "device_type_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device type." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `smartlock`." }, "display_name": { "type": "string", "description": "Display name." }, "is_accessory": { "type": "boolean", "description": "Accessory types (bridges, keypads) rather than primary devices." } }, "required": [ "device_type_id", "slug", "display_name", "is_accessory" ], "additionalProperties": false }, { "type": "null" } ], "description": "Pinned published device type, when set." }, "device_type_properties": { "anyOf": [ { "$ref": "#/paths/~1device_models~1list/get/responses/200/content/application~1json/schema/$defs/__schema1" }, { "type": "null" } ], "description": "Per-device-type properties verbatim, including the source component discriminator; null for accessory types." }, "variants": { "type": "array", "items": { "type": "object", "properties": { "device_model_variant_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the variant." }, "color_name": { "description": "Variant color axis; the only axes are color and style.", "type": [ "string", "null" ] }, "style_name": { "description": "Variant style axis; the only axes are color and style.", "type": [ "string", "null" ] }, "primary_color_hex": { "description": "Primary color as a hex value, when recorded.", "type": [ "string", "null" ] }, "manufacturer_model_id": { "description": "Manufacturer's own model identifier, when recorded.", "type": [ "string", "null" ] }, "asin": { "description": "Amazon ASIN, when recorded.", "type": [ "string", "null" ] }, "gtins": { "anyOf": [ { "$ref": "#/paths/~1device_models~1list/get/responses/200/content/application~1json/schema/$defs/__schema2" }, { "type": "null" } ], "description": "GTIN values verbatim from the source." }, "marketplace_listings": { "anyOf": [ { "$ref": "#/paths/~1device_models~1list/get/responses/200/content/application~1json/schema/$defs/__schema3" }, { "type": "null" } ], "description": "Marketplace listing data verbatim from the source." }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Variant ordering as in the source." }, "images": { "type": "array", "items": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Images of this variant." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "device_model_variant_id", "color_name", "style_name", "primary_color_hex", "manufacturer_model_id", "asin", "gtins", "marketplace_listings", "sort_order", "images", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Variants in source order, each with its images." }, "featured_image": { "anyOf": [ { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false }, { "type": "null" } ], "description": "Featured image with its derived formats, when present." }, "providers": { "type": "array", "items": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name" ], "additionalProperties": false }, "description": "Providers that can create accesses on this model." }, "capabilities_by_provider": { "type": "array", "items": { "type": "object", "properties": { "provider": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name" ], "additionalProperties": false, "description": "Provider the capabilities belong to." }, "capabilities": { "type": "array", "items": { "type": "object", "properties": { "capability_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the computed capability row." }, "name": { "type": "string", "enum": [ "device_connectivity", "can_program_online_access_codes", "can_program_offline_access_codes", "can_remotely_unlock", "can_remotely_lock", "can_encode_plastic_cards", "can_assign_plastic_cards", "can_provision_mobile_keys", "can_provision_wallet_keys", "can_hvac_cool", "can_hvac_heat", "can_hvac_auto", "can_hvac_fan", "can_program_thermostat_weekly_programs", "can_monitor" ], "description": "Capability name." }, "supported": { "type": "string", "enum": [ "yes", "no", "conditionally" ], "description": "Computed support: `yes`, `no`, or `conditionally`." }, "integration_support_level": { "anyOf": [ { "type": "string", "enum": [ "inquire", "unavailable", "planned", "in-progress", "beta", "stable" ] }, { "type": "null" } ], "description": "Support level of the provider integration behind this capability; null where the source has none." }, "report": { "anyOf": [ { "type": "object", "properties": { "details": { "type": "string", "description": "Report detail text, or a translation dictionary key in `report_raw`." }, "requirements": { "description": "Requirements keyed by requirement name.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "message": { "type": "string", "description": "Requirement message, or a translation dictionary key in `report_raw`." }, "device_slugs": { "description": "Device model slugs satisfying this requirement.", "type": "array", "items": { "type": "string" } } }, "required": [ "message" ], "additionalProperties": {} } }, "dependencies": { "description": "Capability names this report depends on.", "type": "array", "items": { "type": "string" } } }, "required": [ "details" ], "additionalProperties": {} }, { "type": "null" } ], "description": "Report with `details` and requirement messages resolved to display text for `locale`, falling back to the default locale and then to a placeholder for a message with no translation. Null when no report is stored." }, "report_raw": { "anyOf": [ { "type": "object", "properties": { "details": { "type": "string", "description": "Report detail text, or a translation dictionary key in `report_raw`." }, "requirements": { "description": "Requirements keyed by requirement name.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "message": { "type": "string", "description": "Requirement message, or a translation dictionary key in `report_raw`." }, "device_slugs": { "description": "Device model slugs satisfying this requirement.", "type": "array", "items": { "type": "string" } } }, "required": [ "message" ], "additionalProperties": {} } }, "dependencies": { "description": "Capability names this report depends on.", "type": "array", "items": { "type": "string" } } }, "required": [ "details" ], "additionalProperties": {} }, { "type": "null" } ], "description": "The stored report verbatim: `details` and requirement messages are translation dictionary keys, never localized in storage." }, "locale": { "type": "string", "description": "The locale `report` was resolved in, after fallback." }, "computed_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "When this capability was computed (ISO 8601)." } }, "required": [ "capability_id", "name", "supported", "integration_support_level", "report", "report_raw", "locale", "computed_at" ], "additionalProperties": false }, "description": "Computed capabilities for that provider." } }, "required": [ "provider", "capabilities" ], "additionalProperties": false }, "description": "Currently published computed capabilities grouped by provider; stale scopes are omitted." }, "capabilities_stale": { "type": "boolean", "description": "True when some linked providers' capabilities are out of date after a change to the model, its providers or the capability engine, so they are omitted from `capabilities_by_provider` until Seam recomputes them. A provider whose correct result is no capabilities is not stale." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "device_model_id", "slug", "display_name", "description_md", "product_url", "is_forbidden_to_3dparty", "no_longer_sold", "shop_listings", "last_commerce_search_at", "manufacturer", "device_type", "device_type_properties", "variants", "featured_image", "providers", "capabilities_by_provider", "capabilities_stale", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Published device models." }, "pagination": { "type": "object", "properties": { "has_next_page": { "type": "boolean", "description": "Whether another page follows this one." }, "next_page_cursor": { "description": "Cursor for the next page; null on the last page.", "type": [ "string", "null" ] } }, "required": [ "has_next_page", "next_page_cursor" ], "additionalProperties": false, "description": "Pagination for this page." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "device_models", "pagination", "ok" ], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1device_models~1list/get/responses/200/content/application~1json/schema/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1device_models~1list/get/responses/200/content/application~1json/schema/$defs/__schema0" } } ] }, "__schema1": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1device_models~1list/get/responses/200/content/application~1json/schema/$defs/__schema1" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1device_models~1list/get/responses/200/content/application~1json/schema/$defs/__schema1" } } ] }, "__schema2": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1device_models~1list/get/responses/200/content/application~1json/schema/$defs/__schema2" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1device_models~1list/get/responses/200/content/application~1json/schema/$defs/__schema2" } } ] }, "__schema3": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1device_models~1list/get/responses/200/content/application~1json/schema/$defs/__schema3" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1device_models~1list/get/responses/200/content/application~1json/schema/$defs/__schema3" } } ] } } } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "parameters": [ { "name": "slugs", "in": "query", "required": false, "schema": { "description": "Only device models with these slugs.", "type": "array", "items": { "type": "string" } } }, { "name": "manufacturer", "in": "query", "required": false, "schema": { "description": "Manufacturer slug. Defaults to the manufacturer of a manufacturer key.", "type": "string" } }, { "name": "device_type", "in": "query", "required": false, "schema": { "description": "Device type slug.", "type": "string" } }, { "name": "provider", "in": "query", "required": false, "schema": { "description": "Provider slug.", "type": "string" } }, { "name": "capability", "in": "query", "required": false, "schema": { "description": "Only models with a computed capability of this name.", "type": "string", "enum": [ "device_connectivity", "can_program_online_access_codes", "can_program_offline_access_codes", "can_remotely_unlock", "can_remotely_lock", "can_encode_plastic_cards", "can_assign_plastic_cards", "can_provision_mobile_keys", "can_provision_wallet_keys", "can_hvac_cool", "can_hvac_heat", "can_hvac_auto", "can_hvac_fan", "can_program_thermostat_weekly_programs", "can_monitor" ] } }, { "name": "supported", "in": "query", "required": false, "schema": { "description": "With `capability`, the required support value.", "type": "string", "enum": [ "yes", "no", "conditionally" ] } }, { "name": "is_accessory", "in": "query", "required": false, "schema": { "description": "Filter by the pinned device type's accessory flag.", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] } }, { "name": "include_forbidden", "in": "query", "required": false, "schema": { "description": "Include models forbidden to third parties (`is_forbidden_to_3dparty`): all of them for Seam callers, its own for a manufacturer secret key, none otherwise. Defaults to false.", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] } }, { "name": "locale", "in": "query", "required": false, "schema": { "description": "Locale for resolved capability report text; unknown locales fall back to the default locale.", "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 100, "description": "Maximum number of device models to return (1-500).", "type": "integer", "minimum": 1, "maximum": 500 } }, { "name": "page_cursor", "in": "query", "required": false, "schema": { "description": "The `next_page_cursor` from the previous page.", "type": "string" } } ] }, "post": { "summary": "List device models", "description": "Lists published device models with variants, properties, featured image, providers and capabilities grouped by provider, ordered by slug. Filters combine with AND. A manufacturer key (embed or secret) defaults `manufacturer` to its own manufacturer; pass another slug to list that manufacturer's models. Device models hidden from third parties are excluded; with a manufacturer secret key, `include_forbidden` adds that manufacturer's own hidden models. Capability reports are resolved per `locale`, with the raw translation keys in `report_raw`.", "tags": [ "device_models" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "device_models": { "type": "array", "items": { "type": "object", "properties": { "device_model_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device model." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `encodeplus`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] }, "description_md": { "description": "Description in markdown, when recorded.", "type": [ "string", "null" ] }, "product_url": { "description": "Manufacturer product page URL, when recorded.", "type": [ "string", "null" ] }, "is_forbidden_to_3dparty": { "description": "Forbidden to third-party consumers; such models are excluded from public reads unless a Seam caller sets `include_forbidden`.", "type": [ "boolean", "null" ] }, "no_longer_sold": { "description": "Whether the model is no longer sold; null where not established.", "type": [ "boolean", "null" ] }, "shop_listings": { "anyOf": [ { "$ref": "#/paths/~1device_models~1list/post/responses/200/content/application~1json/schema/$defs/__schema0" }, { "type": "null" } ], "description": "Commerce listing data verbatim from the source." }, "last_commerce_search_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ], "description": "When commerce listings were last searched; null is a recorded fact, not an omission." }, "manufacturer": { "anyOf": [ { "type": "object", "properties": { "manufacturer_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the manufacturer." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `schlage`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "manufacturer_id", "slug", "display_name" ], "additionalProperties": false }, { "type": "null" } ], "description": "Pinned published manufacturer, when set." }, "device_type": { "anyOf": [ { "type": "object", "properties": { "device_type_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device type." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `smartlock`." }, "display_name": { "type": "string", "description": "Display name." }, "is_accessory": { "type": "boolean", "description": "Accessory types (bridges, keypads) rather than primary devices." } }, "required": [ "device_type_id", "slug", "display_name", "is_accessory" ], "additionalProperties": false }, { "type": "null" } ], "description": "Pinned published device type, when set." }, "device_type_properties": { "anyOf": [ { "$ref": "#/paths/~1device_models~1list/post/responses/200/content/application~1json/schema/$defs/__schema1" }, { "type": "null" } ], "description": "Per-device-type properties verbatim, including the source component discriminator; null for accessory types." }, "variants": { "type": "array", "items": { "type": "object", "properties": { "device_model_variant_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the variant." }, "color_name": { "description": "Variant color axis; the only axes are color and style.", "type": [ "string", "null" ] }, "style_name": { "description": "Variant style axis; the only axes are color and style.", "type": [ "string", "null" ] }, "primary_color_hex": { "description": "Primary color as a hex value, when recorded.", "type": [ "string", "null" ] }, "manufacturer_model_id": { "description": "Manufacturer's own model identifier, when recorded.", "type": [ "string", "null" ] }, "asin": { "description": "Amazon ASIN, when recorded.", "type": [ "string", "null" ] }, "gtins": { "anyOf": [ { "$ref": "#/paths/~1device_models~1list/post/responses/200/content/application~1json/schema/$defs/__schema2" }, { "type": "null" } ], "description": "GTIN values verbatim from the source." }, "marketplace_listings": { "anyOf": [ { "$ref": "#/paths/~1device_models~1list/post/responses/200/content/application~1json/schema/$defs/__schema3" }, { "type": "null" } ], "description": "Marketplace listing data verbatim from the source." }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Variant ordering as in the source." }, "images": { "type": "array", "items": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Images of this variant." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "device_model_variant_id", "color_name", "style_name", "primary_color_hex", "manufacturer_model_id", "asin", "gtins", "marketplace_listings", "sort_order", "images", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Variants in source order, each with its images." }, "featured_image": { "anyOf": [ { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false }, { "type": "null" } ], "description": "Featured image with its derived formats, when present." }, "providers": { "type": "array", "items": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name" ], "additionalProperties": false }, "description": "Providers that can create accesses on this model." }, "capabilities_by_provider": { "type": "array", "items": { "type": "object", "properties": { "provider": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name" ], "additionalProperties": false, "description": "Provider the capabilities belong to." }, "capabilities": { "type": "array", "items": { "type": "object", "properties": { "capability_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the computed capability row." }, "name": { "type": "string", "enum": [ "device_connectivity", "can_program_online_access_codes", "can_program_offline_access_codes", "can_remotely_unlock", "can_remotely_lock", "can_encode_plastic_cards", "can_assign_plastic_cards", "can_provision_mobile_keys", "can_provision_wallet_keys", "can_hvac_cool", "can_hvac_heat", "can_hvac_auto", "can_hvac_fan", "can_program_thermostat_weekly_programs", "can_monitor" ], "description": "Capability name." }, "supported": { "type": "string", "enum": [ "yes", "no", "conditionally" ], "description": "Computed support: `yes`, `no`, or `conditionally`." }, "integration_support_level": { "anyOf": [ { "type": "string", "enum": [ "inquire", "unavailable", "planned", "in-progress", "beta", "stable" ] }, { "type": "null" } ], "description": "Support level of the provider integration behind this capability; null where the source has none." }, "report": { "anyOf": [ { "type": "object", "properties": { "details": { "type": "string", "description": "Report detail text, or a translation dictionary key in `report_raw`." }, "requirements": { "description": "Requirements keyed by requirement name.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "message": { "type": "string", "description": "Requirement message, or a translation dictionary key in `report_raw`." }, "device_slugs": { "description": "Device model slugs satisfying this requirement.", "type": "array", "items": { "type": "string" } } }, "required": [ "message" ], "additionalProperties": {} } }, "dependencies": { "description": "Capability names this report depends on.", "type": "array", "items": { "type": "string" } } }, "required": [ "details" ], "additionalProperties": {} }, { "type": "null" } ], "description": "Report with `details` and requirement messages resolved to display text for `locale`, falling back to the default locale and then to a placeholder for a message with no translation. Null when no report is stored." }, "report_raw": { "anyOf": [ { "type": "object", "properties": { "details": { "type": "string", "description": "Report detail text, or a translation dictionary key in `report_raw`." }, "requirements": { "description": "Requirements keyed by requirement name.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "message": { "type": "string", "description": "Requirement message, or a translation dictionary key in `report_raw`." }, "device_slugs": { "description": "Device model slugs satisfying this requirement.", "type": "array", "items": { "type": "string" } } }, "required": [ "message" ], "additionalProperties": {} } }, "dependencies": { "description": "Capability names this report depends on.", "type": "array", "items": { "type": "string" } } }, "required": [ "details" ], "additionalProperties": {} }, { "type": "null" } ], "description": "The stored report verbatim: `details` and requirement messages are translation dictionary keys, never localized in storage." }, "locale": { "type": "string", "description": "The locale `report` was resolved in, after fallback." }, "computed_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "When this capability was computed (ISO 8601)." } }, "required": [ "capability_id", "name", "supported", "integration_support_level", "report", "report_raw", "locale", "computed_at" ], "additionalProperties": false }, "description": "Computed capabilities for that provider." } }, "required": [ "provider", "capabilities" ], "additionalProperties": false }, "description": "Currently published computed capabilities grouped by provider; stale scopes are omitted." }, "capabilities_stale": { "type": "boolean", "description": "True when some linked providers' capabilities are out of date after a change to the model, its providers or the capability engine, so they are omitted from `capabilities_by_provider` until Seam recomputes them. A provider whose correct result is no capabilities is not stale." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "device_model_id", "slug", "display_name", "description_md", "product_url", "is_forbidden_to_3dparty", "no_longer_sold", "shop_listings", "last_commerce_search_at", "manufacturer", "device_type", "device_type_properties", "variants", "featured_image", "providers", "capabilities_by_provider", "capabilities_stale", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Published device models." }, "pagination": { "type": "object", "properties": { "has_next_page": { "type": "boolean", "description": "Whether another page follows this one." }, "next_page_cursor": { "description": "Cursor for the next page; null on the last page.", "type": [ "string", "null" ] } }, "required": [ "has_next_page", "next_page_cursor" ], "additionalProperties": false, "description": "Pagination for this page." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "device_models", "pagination", "ok" ], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1device_models~1list/post/responses/200/content/application~1json/schema/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1device_models~1list/post/responses/200/content/application~1json/schema/$defs/__schema0" } } ] }, "__schema1": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1device_models~1list/post/responses/200/content/application~1json/schema/$defs/__schema1" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1device_models~1list/post/responses/200/content/application~1json/schema/$defs/__schema1" } } ] }, "__schema2": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1device_models~1list/post/responses/200/content/application~1json/schema/$defs/__schema2" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1device_models~1list/post/responses/200/content/application~1json/schema/$defs/__schema2" } } ] }, "__schema3": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1device_models~1list/post/responses/200/content/application~1json/schema/$defs/__schema3" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1device_models~1list/post/responses/200/content/application~1json/schema/$defs/__schema3" } } ] } } } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "slugs": { "description": "Only device models with these slugs.", "type": "array", "items": { "type": "string" } }, "manufacturer": { "description": "Manufacturer slug. Defaults to the manufacturer of a manufacturer key.", "type": "string" }, "device_type": { "description": "Device type slug.", "type": "string" }, "provider": { "description": "Provider slug.", "type": "string" }, "capability": { "description": "Only models with a computed capability of this name.", "type": "string", "enum": [ "device_connectivity", "can_program_online_access_codes", "can_program_offline_access_codes", "can_remotely_unlock", "can_remotely_lock", "can_encode_plastic_cards", "can_assign_plastic_cards", "can_provision_mobile_keys", "can_provision_wallet_keys", "can_hvac_cool", "can_hvac_heat", "can_hvac_auto", "can_hvac_fan", "can_program_thermostat_weekly_programs", "can_monitor" ] }, "supported": { "description": "With `capability`, the required support value.", "type": "string", "enum": [ "yes", "no", "conditionally" ] }, "is_accessory": { "description": "Filter by the pinned device type's accessory flag.", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] }, "include_forbidden": { "description": "Include models forbidden to third parties (`is_forbidden_to_3dparty`): all of them for Seam callers, its own for a manufacturer secret key, none otherwise. Defaults to false.", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] }, "locale": { "description": "Locale for resolved capability report text; unknown locales fall back to the default locale.", "type": "string" }, "limit": { "default": 100, "description": "Maximum number of device models to return (1-500).", "type": "integer", "minimum": 1, "maximum": 500 }, "page_cursor": { "description": "The `next_page_cursor` from the previous page.", "type": "string" } } } } } } } }, "/device_models/route_params": { "get": { "summary": "List device model route params", "description": "Lists published device model slugs with their manufacturer and device type slugs and `updated_at`, ordered by slug, without variants, images or capabilities. Use it to generate one page per device model. Device models hidden from third parties are excluded; with a manufacturer secret key, `include_forbidden` adds that manufacturer's own hidden models.", "tags": [ "device_models" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "device_model_route_params": { "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string", "description": "Published device model slug." }, "manufacturer_slug": { "description": "Slug of the pinned manufacturer, when set.", "type": [ "string", "null" ] }, "device_type_slug": { "description": "Slug of the pinned device type, when set.", "type": [ "string", "null" ] }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "slug", "manufacturer_slug", "device_type_slug", "updated_at" ], "additionalProperties": false }, "description": "Published device model route params." }, "pagination": { "type": "object", "properties": { "has_next_page": { "type": "boolean", "description": "Whether another page follows this one." }, "next_page_cursor": { "description": "Cursor for the next page; null on the last page.", "type": [ "string", "null" ] } }, "required": [ "has_next_page", "next_page_cursor" ], "additionalProperties": false, "description": "Pagination for this page." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "device_model_route_params", "pagination", "ok" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "parameters": [ { "name": "include_forbidden", "in": "query", "required": false, "schema": { "description": "Include models forbidden to third parties (`is_forbidden_to_3dparty`): all of them for Seam callers, its own for a manufacturer secret key, none otherwise. Defaults to false.", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 100, "description": "Maximum number of route params to return (1-500).", "type": "integer", "minimum": 1, "maximum": 500 } }, { "name": "page_cursor", "in": "query", "required": false, "schema": { "description": "The `next_page_cursor` from the previous page.", "type": "string" } } ] }, "post": { "summary": "List device model route params", "description": "Lists published device model slugs with their manufacturer and device type slugs and `updated_at`, ordered by slug, without variants, images or capabilities. Use it to generate one page per device model. Device models hidden from third parties are excluded; with a manufacturer secret key, `include_forbidden` adds that manufacturer's own hidden models.", "tags": [ "device_models" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "device_model_route_params": { "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string", "description": "Published device model slug." }, "manufacturer_slug": { "description": "Slug of the pinned manufacturer, when set.", "type": [ "string", "null" ] }, "device_type_slug": { "description": "Slug of the pinned device type, when set.", "type": [ "string", "null" ] }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "slug", "manufacturer_slug", "device_type_slug", "updated_at" ], "additionalProperties": false }, "description": "Published device model route params." }, "pagination": { "type": "object", "properties": { "has_next_page": { "type": "boolean", "description": "Whether another page follows this one." }, "next_page_cursor": { "description": "Cursor for the next page; null on the last page.", "type": [ "string", "null" ] } }, "required": [ "has_next_page", "next_page_cursor" ], "additionalProperties": false, "description": "Pagination for this page." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "device_model_route_params", "pagination", "ok" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "include_forbidden": { "description": "Include models forbidden to third parties (`is_forbidden_to_3dparty`): all of them for Seam callers, its own for a manufacturer secret key, none otherwise. Defaults to false.", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] }, "limit": { "default": 100, "description": "Maximum number of route params to return (1-500).", "type": "integer", "minimum": 1, "maximum": 500 }, "page_cursor": { "description": "The `next_page_cursor` from the previous page.", "type": "string" } } } } } } } }, "/device_models/summaries/list": { "get": { "summary": "List device model summaries", "description": "Lists published device models in the slim summary shape built for product pages and widgets, with the same filters, pagination and key rules as `device_models/list`, ordered by slug. Images keep their URLs and renditions, capabilities keep their resolved reports, and commerce data (marketplace and shop listings, ASINs, GTINs) is added only with `include=commerce`.", "tags": [ "device_models" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "device_models": { "type": "array", "items": { "type": "object", "properties": { "device_model_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device model." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `encodeplus`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] }, "description_md": { "description": "Description in markdown, when recorded.", "type": [ "string", "null" ] }, "product_url": { "description": "Manufacturer product page URL, when recorded.", "type": [ "string", "null" ] }, "no_longer_sold": { "description": "Whether the model is no longer sold; null where not established.", "type": [ "boolean", "null" ] }, "is_forbidden_to_3dparty": { "description": "Forbidden to third-party consumers; such models appear only for callers allowed to set `include_forbidden`.", "type": [ "boolean", "null" ] }, "manufacturer": { "anyOf": [ { "type": "object", "properties": { "manufacturer_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the manufacturer." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `schlage`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "manufacturer_id", "slug", "display_name" ], "additionalProperties": false }, { "type": "null" } ], "description": "Pinned published manufacturer, when set." }, "device_type": { "anyOf": [ { "type": "object", "properties": { "device_type_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device type." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `smartlock`." }, "display_name": { "type": "string", "description": "Display name." }, "is_accessory": { "type": "boolean", "description": "Accessory types (bridges, keypads) rather than primary devices." } }, "required": [ "device_type_id", "slug", "display_name", "is_accessory" ], "additionalProperties": false }, { "type": "null" } ], "description": "Pinned published device type, when set." }, "device_type_properties": { "anyOf": [ { "$ref": "#/paths/~1device_models~1summaries~1list/get/responses/200/content/application~1json/schema/$defs/__schema0" }, { "type": "null" } ], "description": "Per-device-type properties verbatim, including the source component discriminator; null for accessory types." }, "featured_image": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "url": { "type": "string", "description": "Public URL of this rendition." }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." } }, "required": [ "url", "width", "height" ], "additionalProperties": false }, "description": "Smaller renditions present for this image, keyed `thumbnail`, `small`, `medium`, `large`; empty when there are none (e.g. SVG)." } }, "required": [ "url", "mime", "width", "height", "formats" ], "additionalProperties": false }, { "type": "null" } ], "description": "Featured image with its renditions, when present." }, "variants": { "type": "array", "items": { "type": "object", "properties": { "device_model_variant_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the variant." }, "color_name": { "description": "Variant color axis.", "type": [ "string", "null" ] }, "style_name": { "description": "Variant style axis.", "type": [ "string", "null" ] }, "primary_color_hex": { "description": "Primary color as a hex value, when recorded.", "type": [ "string", "null" ] }, "manufacturer_model_id": { "description": "Manufacturer's own model identifier, when recorded.", "type": [ "string", "null" ] }, "images": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "url": { "type": "string", "description": "Public URL of this rendition." }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." } }, "required": [ "url", "width", "height" ], "additionalProperties": false }, "description": "Smaller renditions present for this image, keyed `thumbnail`, `small`, `medium`, `large`; empty when there are none (e.g. SVG)." } }, "required": [ "url", "mime", "width", "height", "formats" ], "additionalProperties": false }, "description": "Images of this variant." }, "asin": { "description": "Amazon ASIN, when recorded. Only with `include=commerce`.", "type": [ "string", "null" ] }, "gtins": { "description": "GTIN values verbatim from the source. Only with `include=commerce`.", "anyOf": [ { "$ref": "#/paths/~1device_models~1summaries~1list/get/responses/200/content/application~1json/schema/$defs/__schema1" }, { "type": "null" } ] }, "marketplace_listings": { "description": "Marketplace listing data verbatim from the source. Only with `include=commerce`.", "anyOf": [ { "$ref": "#/paths/~1device_models~1summaries~1list/get/responses/200/content/application~1json/schema/$defs/__schema2" }, { "type": "null" } ] } }, "required": [ "device_model_variant_id", "color_name", "style_name", "primary_color_hex", "manufacturer_model_id", "images" ], "additionalProperties": false }, "description": "Variants in source order, each with its images." }, "providers": { "type": "array", "items": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name" ], "additionalProperties": false }, "description": "Providers that can create accesses on this model." }, "capabilities_by_provider": { "type": "array", "items": { "type": "object", "properties": { "provider": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name" ], "additionalProperties": false, "description": "Provider the capabilities belong to." }, "capabilities": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "device_connectivity", "can_program_online_access_codes", "can_program_offline_access_codes", "can_remotely_unlock", "can_remotely_lock", "can_encode_plastic_cards", "can_assign_plastic_cards", "can_provision_mobile_keys", "can_provision_wallet_keys", "can_hvac_cool", "can_hvac_heat", "can_hvac_auto", "can_hvac_fan", "can_program_thermostat_weekly_programs", "can_monitor" ], "description": "Capability name." }, "supported": { "type": "string", "enum": [ "yes", "no", "conditionally" ], "description": "Computed support: `yes`, `no`, or `conditionally`." }, "integration_support_level": { "anyOf": [ { "type": "string", "enum": [ "inquire", "unavailable", "planned", "in-progress", "beta", "stable" ] }, { "type": "null" } ], "description": "Support level of the provider integration behind this capability; null where the source has none." }, "report": { "anyOf": [ { "type": "object", "properties": { "details": { "type": "string", "description": "Report detail text, or a translation dictionary key in `report_raw`." }, "requirements": { "description": "Requirements keyed by requirement name.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "message": { "type": "string", "description": "Requirement message, or a translation dictionary key in `report_raw`." }, "device_slugs": { "description": "Device model slugs satisfying this requirement.", "type": "array", "items": { "type": "string" } } }, "required": [ "message" ], "additionalProperties": {} } }, "dependencies": { "description": "Capability names this report depends on.", "type": "array", "items": { "type": "string" } } }, "required": [ "details" ], "additionalProperties": {} }, { "type": "null" } ], "description": "Report with `details` and requirement messages resolved for the requested `locale`; null when none is stored." } }, "required": [ "name", "supported", "integration_support_level", "report" ], "additionalProperties": false }, "description": "Computed capabilities for that provider." } }, "required": [ "provider", "capabilities" ], "additionalProperties": false }, "description": "Currently published computed capabilities grouped by provider; stale scopes are omitted." }, "capabilities_stale": { "type": "boolean", "description": "True when some provider scope's capabilities are omitted until they are recomputed." }, "shop_listings": { "description": "Commerce listing data verbatim from the source. Only with `include=commerce`.", "anyOf": [ { "$ref": "#/paths/~1device_models~1summaries~1list/get/responses/200/content/application~1json/schema/$defs/__schema3" }, { "type": "null" } ] }, "last_commerce_search_at": { "description": "When commerce listings were last searched. Only with `include=commerce`.", "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "device_model_id", "slug", "display_name", "description_md", "product_url", "no_longer_sold", "is_forbidden_to_3dparty", "manufacturer", "device_type", "device_type_properties", "featured_image", "variants", "providers", "capabilities_by_provider", "capabilities_stale", "updated_at" ], "additionalProperties": false }, "description": "Published device models in the summary shape." }, "pagination": { "type": "object", "properties": { "has_next_page": { "type": "boolean", "description": "Whether another page follows this one." }, "next_page_cursor": { "description": "Cursor for the next page; null on the last page.", "type": [ "string", "null" ] } }, "required": [ "has_next_page", "next_page_cursor" ], "additionalProperties": false, "description": "Pagination for this page." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "device_models", "pagination", "ok" ], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1device_models~1summaries~1list/get/responses/200/content/application~1json/schema/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1device_models~1summaries~1list/get/responses/200/content/application~1json/schema/$defs/__schema0" } } ] }, "__schema1": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1device_models~1summaries~1list/get/responses/200/content/application~1json/schema/$defs/__schema1" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1device_models~1summaries~1list/get/responses/200/content/application~1json/schema/$defs/__schema1" } } ] }, "__schema2": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1device_models~1summaries~1list/get/responses/200/content/application~1json/schema/$defs/__schema2" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1device_models~1summaries~1list/get/responses/200/content/application~1json/schema/$defs/__schema2" } } ] }, "__schema3": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1device_models~1summaries~1list/get/responses/200/content/application~1json/schema/$defs/__schema3" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1device_models~1summaries~1list/get/responses/200/content/application~1json/schema/$defs/__schema3" } } ] } } } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "parameters": [ { "name": "slugs", "in": "query", "required": false, "schema": { "description": "Only device models with these slugs.", "type": "array", "items": { "type": "string" } } }, { "name": "manufacturer", "in": "query", "required": false, "schema": { "description": "Manufacturer slug. Defaults to the manufacturer of a manufacturer key.", "type": "string" } }, { "name": "device_type", "in": "query", "required": false, "schema": { "description": "Device type slug.", "type": "string" } }, { "name": "provider", "in": "query", "required": false, "schema": { "description": "Provider slug.", "type": "string" } }, { "name": "capability", "in": "query", "required": false, "schema": { "description": "Only models with a computed capability of this name.", "type": "string", "enum": [ "device_connectivity", "can_program_online_access_codes", "can_program_offline_access_codes", "can_remotely_unlock", "can_remotely_lock", "can_encode_plastic_cards", "can_assign_plastic_cards", "can_provision_mobile_keys", "can_provision_wallet_keys", "can_hvac_cool", "can_hvac_heat", "can_hvac_auto", "can_hvac_fan", "can_program_thermostat_weekly_programs", "can_monitor" ] } }, { "name": "supported", "in": "query", "required": false, "schema": { "description": "With `capability`, the required support value.", "type": "string", "enum": [ "yes", "no", "conditionally" ] } }, { "name": "is_accessory", "in": "query", "required": false, "schema": { "description": "Filter by the pinned device type's accessory flag.", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] } }, { "name": "include_forbidden", "in": "query", "required": false, "schema": { "description": "Include models forbidden to third parties (`is_forbidden_to_3dparty`): all of them for Seam callers, its own for a manufacturer secret key, none otherwise. Defaults to false.", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] } }, { "name": "locale", "in": "query", "required": false, "schema": { "description": "Locale for resolved capability report text; unknown locales fall back to the default locale.", "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 100, "description": "Maximum number of device models to return (1-500).", "type": "integer", "minimum": 1, "maximum": 500 } }, { "name": "page_cursor", "in": "query", "required": false, "schema": { "description": "The `next_page_cursor` from the previous page.", "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "description": "Optional data to add: `commerce` adds marketplace and shop listings, ASINs and GTINs.", "type": "array", "items": { "type": "string", "enum": [ "commerce" ] } } } ] }, "post": { "summary": "List device model summaries", "description": "Lists published device models in the slim summary shape built for product pages and widgets, with the same filters, pagination and key rules as `device_models/list`, ordered by slug. Images keep their URLs and renditions, capabilities keep their resolved reports, and commerce data (marketplace and shop listings, ASINs, GTINs) is added only with `include=commerce`.", "tags": [ "device_models" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "device_models": { "type": "array", "items": { "type": "object", "properties": { "device_model_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device model." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `encodeplus`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] }, "description_md": { "description": "Description in markdown, when recorded.", "type": [ "string", "null" ] }, "product_url": { "description": "Manufacturer product page URL, when recorded.", "type": [ "string", "null" ] }, "no_longer_sold": { "description": "Whether the model is no longer sold; null where not established.", "type": [ "boolean", "null" ] }, "is_forbidden_to_3dparty": { "description": "Forbidden to third-party consumers; such models appear only for callers allowed to set `include_forbidden`.", "type": [ "boolean", "null" ] }, "manufacturer": { "anyOf": [ { "type": "object", "properties": { "manufacturer_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the manufacturer." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `schlage`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "manufacturer_id", "slug", "display_name" ], "additionalProperties": false }, { "type": "null" } ], "description": "Pinned published manufacturer, when set." }, "device_type": { "anyOf": [ { "type": "object", "properties": { "device_type_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device type." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `smartlock`." }, "display_name": { "type": "string", "description": "Display name." }, "is_accessory": { "type": "boolean", "description": "Accessory types (bridges, keypads) rather than primary devices." } }, "required": [ "device_type_id", "slug", "display_name", "is_accessory" ], "additionalProperties": false }, { "type": "null" } ], "description": "Pinned published device type, when set." }, "device_type_properties": { "anyOf": [ { "$ref": "#/paths/~1device_models~1summaries~1list/post/responses/200/content/application~1json/schema/$defs/__schema0" }, { "type": "null" } ], "description": "Per-device-type properties verbatim, including the source component discriminator; null for accessory types." }, "featured_image": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "url": { "type": "string", "description": "Public URL of this rendition." }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." } }, "required": [ "url", "width", "height" ], "additionalProperties": false }, "description": "Smaller renditions present for this image, keyed `thumbnail`, `small`, `medium`, `large`; empty when there are none (e.g. SVG)." } }, "required": [ "url", "mime", "width", "height", "formats" ], "additionalProperties": false }, { "type": "null" } ], "description": "Featured image with its renditions, when present." }, "variants": { "type": "array", "items": { "type": "object", "properties": { "device_model_variant_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the variant." }, "color_name": { "description": "Variant color axis.", "type": [ "string", "null" ] }, "style_name": { "description": "Variant style axis.", "type": [ "string", "null" ] }, "primary_color_hex": { "description": "Primary color as a hex value, when recorded.", "type": [ "string", "null" ] }, "manufacturer_model_id": { "description": "Manufacturer's own model identifier, when recorded.", "type": [ "string", "null" ] }, "images": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "url": { "type": "string", "description": "Public URL of this rendition." }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." } }, "required": [ "url", "width", "height" ], "additionalProperties": false }, "description": "Smaller renditions present for this image, keyed `thumbnail`, `small`, `medium`, `large`; empty when there are none (e.g. SVG)." } }, "required": [ "url", "mime", "width", "height", "formats" ], "additionalProperties": false }, "description": "Images of this variant." }, "asin": { "description": "Amazon ASIN, when recorded. Only with `include=commerce`.", "type": [ "string", "null" ] }, "gtins": { "description": "GTIN values verbatim from the source. Only with `include=commerce`.", "anyOf": [ { "$ref": "#/paths/~1device_models~1summaries~1list/post/responses/200/content/application~1json/schema/$defs/__schema1" }, { "type": "null" } ] }, "marketplace_listings": { "description": "Marketplace listing data verbatim from the source. Only with `include=commerce`.", "anyOf": [ { "$ref": "#/paths/~1device_models~1summaries~1list/post/responses/200/content/application~1json/schema/$defs/__schema2" }, { "type": "null" } ] } }, "required": [ "device_model_variant_id", "color_name", "style_name", "primary_color_hex", "manufacturer_model_id", "images" ], "additionalProperties": false }, "description": "Variants in source order, each with its images." }, "providers": { "type": "array", "items": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name" ], "additionalProperties": false }, "description": "Providers that can create accesses on this model." }, "capabilities_by_provider": { "type": "array", "items": { "type": "object", "properties": { "provider": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name" ], "additionalProperties": false, "description": "Provider the capabilities belong to." }, "capabilities": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "device_connectivity", "can_program_online_access_codes", "can_program_offline_access_codes", "can_remotely_unlock", "can_remotely_lock", "can_encode_plastic_cards", "can_assign_plastic_cards", "can_provision_mobile_keys", "can_provision_wallet_keys", "can_hvac_cool", "can_hvac_heat", "can_hvac_auto", "can_hvac_fan", "can_program_thermostat_weekly_programs", "can_monitor" ], "description": "Capability name." }, "supported": { "type": "string", "enum": [ "yes", "no", "conditionally" ], "description": "Computed support: `yes`, `no`, or `conditionally`." }, "integration_support_level": { "anyOf": [ { "type": "string", "enum": [ "inquire", "unavailable", "planned", "in-progress", "beta", "stable" ] }, { "type": "null" } ], "description": "Support level of the provider integration behind this capability; null where the source has none." }, "report": { "anyOf": [ { "type": "object", "properties": { "details": { "type": "string", "description": "Report detail text, or a translation dictionary key in `report_raw`." }, "requirements": { "description": "Requirements keyed by requirement name.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "message": { "type": "string", "description": "Requirement message, or a translation dictionary key in `report_raw`." }, "device_slugs": { "description": "Device model slugs satisfying this requirement.", "type": "array", "items": { "type": "string" } } }, "required": [ "message" ], "additionalProperties": {} } }, "dependencies": { "description": "Capability names this report depends on.", "type": "array", "items": { "type": "string" } } }, "required": [ "details" ], "additionalProperties": {} }, { "type": "null" } ], "description": "Report with `details` and requirement messages resolved for the requested `locale`; null when none is stored." } }, "required": [ "name", "supported", "integration_support_level", "report" ], "additionalProperties": false }, "description": "Computed capabilities for that provider." } }, "required": [ "provider", "capabilities" ], "additionalProperties": false }, "description": "Currently published computed capabilities grouped by provider; stale scopes are omitted." }, "capabilities_stale": { "type": "boolean", "description": "True when some provider scope's capabilities are omitted until they are recomputed." }, "shop_listings": { "description": "Commerce listing data verbatim from the source. Only with `include=commerce`.", "anyOf": [ { "$ref": "#/paths/~1device_models~1summaries~1list/post/responses/200/content/application~1json/schema/$defs/__schema3" }, { "type": "null" } ] }, "last_commerce_search_at": { "description": "When commerce listings were last searched. Only with `include=commerce`.", "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "device_model_id", "slug", "display_name", "description_md", "product_url", "no_longer_sold", "is_forbidden_to_3dparty", "manufacturer", "device_type", "device_type_properties", "featured_image", "variants", "providers", "capabilities_by_provider", "capabilities_stale", "updated_at" ], "additionalProperties": false }, "description": "Published device models in the summary shape." }, "pagination": { "type": "object", "properties": { "has_next_page": { "type": "boolean", "description": "Whether another page follows this one." }, "next_page_cursor": { "description": "Cursor for the next page; null on the last page.", "type": [ "string", "null" ] } }, "required": [ "has_next_page", "next_page_cursor" ], "additionalProperties": false, "description": "Pagination for this page." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "device_models", "pagination", "ok" ], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1device_models~1summaries~1list/post/responses/200/content/application~1json/schema/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1device_models~1summaries~1list/post/responses/200/content/application~1json/schema/$defs/__schema0" } } ] }, "__schema1": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1device_models~1summaries~1list/post/responses/200/content/application~1json/schema/$defs/__schema1" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1device_models~1summaries~1list/post/responses/200/content/application~1json/schema/$defs/__schema1" } } ] }, "__schema2": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1device_models~1summaries~1list/post/responses/200/content/application~1json/schema/$defs/__schema2" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1device_models~1summaries~1list/post/responses/200/content/application~1json/schema/$defs/__schema2" } } ] }, "__schema3": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1device_models~1summaries~1list/post/responses/200/content/application~1json/schema/$defs/__schema3" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1device_models~1summaries~1list/post/responses/200/content/application~1json/schema/$defs/__schema3" } } ] } } } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "slugs": { "description": "Only device models with these slugs.", "type": "array", "items": { "type": "string" } }, "manufacturer": { "description": "Manufacturer slug. Defaults to the manufacturer of a manufacturer key.", "type": "string" }, "device_type": { "description": "Device type slug.", "type": "string" }, "provider": { "description": "Provider slug.", "type": "string" }, "capability": { "description": "Only models with a computed capability of this name.", "type": "string", "enum": [ "device_connectivity", "can_program_online_access_codes", "can_program_offline_access_codes", "can_remotely_unlock", "can_remotely_lock", "can_encode_plastic_cards", "can_assign_plastic_cards", "can_provision_mobile_keys", "can_provision_wallet_keys", "can_hvac_cool", "can_hvac_heat", "can_hvac_auto", "can_hvac_fan", "can_program_thermostat_weekly_programs", "can_monitor" ] }, "supported": { "description": "With `capability`, the required support value.", "type": "string", "enum": [ "yes", "no", "conditionally" ] }, "is_accessory": { "description": "Filter by the pinned device type's accessory flag.", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] }, "include_forbidden": { "description": "Include models forbidden to third parties (`is_forbidden_to_3dparty`): all of them for Seam callers, its own for a manufacturer secret key, none otherwise. Defaults to false.", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] }, "locale": { "description": "Locale for resolved capability report text; unknown locales fall back to the default locale.", "type": "string" }, "limit": { "default": 100, "description": "Maximum number of device models to return (1-500).", "type": "integer", "minimum": 1, "maximum": 500 }, "page_cursor": { "description": "The `next_page_cursor` from the previous page.", "type": "string" }, "include": { "description": "Optional data to add: `commerce` adds marketplace and shop listings, ASINs and GTINs.", "type": "array", "items": { "type": "string", "enum": [ "commerce" ] } } } } } } } } }, "/device_types/list": { "get": { "summary": "List device types", "description": "Lists published device types, such as `smartlock` and `thermostat`, ordered for display.", "tags": [ "device_types" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "device_types": { "type": "array", "items": { "type": "object", "properties": { "device_type_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device type." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `smartlock`." }, "display_name": { "type": "string", "description": "Display name." }, "is_accessory": { "type": "boolean", "description": "Accessory types (bridges, keypads) rather than primary devices." }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Display ordering; lower values come first." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "device_type_id", "slug", "display_name", "is_accessory", "sort_order", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Published device types." }, "pagination": { "type": "object", "properties": { "has_next_page": { "type": "boolean", "description": "Whether another page follows this one." }, "next_page_cursor": { "description": "Cursor for the next page; null on the last page.", "type": [ "string", "null" ] } }, "required": [ "has_next_page", "next_page_cursor" ], "additionalProperties": false, "description": "Pagination for this page." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "device_types", "pagination", "ok" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "parameters": [ { "name": "slugs", "in": "query", "required": false, "schema": { "description": "Only device types with these slugs.", "type": "array", "items": { "type": "string" } } }, { "name": "is_accessory", "in": "query", "required": false, "schema": { "description": "Filter by the accessory flag.", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 100, "description": "Maximum number of device types to return (1-500).", "type": "integer", "minimum": 1, "maximum": 500 } }, { "name": "page_cursor", "in": "query", "required": false, "schema": { "description": "The `next_page_cursor` from the previous page.", "type": "string" } } ] }, "post": { "summary": "List device types", "description": "Lists published device types, such as `smartlock` and `thermostat`, ordered for display.", "tags": [ "device_types" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "device_types": { "type": "array", "items": { "type": "object", "properties": { "device_type_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device type." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `smartlock`." }, "display_name": { "type": "string", "description": "Display name." }, "is_accessory": { "type": "boolean", "description": "Accessory types (bridges, keypads) rather than primary devices." }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Display ordering; lower values come first." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "device_type_id", "slug", "display_name", "is_accessory", "sort_order", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Published device types." }, "pagination": { "type": "object", "properties": { "has_next_page": { "type": "boolean", "description": "Whether another page follows this one." }, "next_page_cursor": { "description": "Cursor for the next page; null on the last page.", "type": [ "string", "null" ] } }, "required": [ "has_next_page", "next_page_cursor" ], "additionalProperties": false, "description": "Pagination for this page." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "device_types", "pagination", "ok" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "slugs": { "description": "Only device types with these slugs.", "type": "array", "items": { "type": "string" } }, "is_accessory": { "description": "Filter by the accessory flag.", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] }, "limit": { "default": 100, "description": "Maximum number of device types to return (1-500).", "type": "integer", "minimum": 1, "maximum": 500 }, "page_cursor": { "description": "The `next_page_cursor` from the previous page.", "type": "string" } } } } } } } }, "/embed/resolve": { "get": { "summary": "Resolve an embed key", "description": "Validates an embed key against the request's `Origin` and returns the key's public record and the manufacturer a manufacturer key scopes widgets to (`manufacturer_context`, null for other keys). For a partner key, it also returns what the partner's widgets must not show: the manufacturers, device types and providers the partner declared disabled or not supported through Seam and, given `capability`, the manufacturer and provider combinations excluded for that capability. Seam's device database widgets call this endpoint.", "tags": [ "compatibility", "embed-keys" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "embed_key": { "type": "object", "properties": { "embed_key_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the key." }, "display_name": { "type": "string", "description": "Display name." }, "owner_kind": { "type": "string", "enum": [ "partner", "manufacturer", "seam" ], "description": "Who owns the key: `partner`, `manufacturer` or `seam`." }, "partner_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ], "description": "The owning partner's UUID; null for other owners." }, "manufacturer_slug": { "description": "The owning manufacturer's slug; null for other owners.", "type": [ "string", "null" ] }, "allowed_origins": { "type": "array", "items": { "type": "string" }, "description": "Origins allowed to use the key, as globs; localhost is always allowed." }, "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {}, "description": "Widget configuration stored with the key." }, "revoked_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ], "description": "When the key was revoked (ISO 8601); null while active." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." } }, "required": [ "embed_key_id", "display_name", "owner_kind", "partner_id", "manufacturer_slug", "allowed_origins", "config", "revoked_at", "created_at" ], "additionalProperties": false, "description": "The key's public record, without the key value." }, "manufacturer_context": { "anyOf": [ { "type": "object", "properties": { "manufacturer_slug": { "type": "string", "description": "The manufacturer widgets default their filter to." } }, "required": [ "manufacturer_slug" ], "additionalProperties": false }, { "type": "null" } ], "description": "Set for manufacturer-owned keys; null for partner and Seam keys." }, "exclusions": { "type": "object", "properties": { "excluded_manufacturers": { "type": "array", "items": { "type": "string" }, "description": "DeviceDB manufacturer slugs declared disabled or not via Seam." }, "excluded_device_types": { "type": "array", "items": { "type": "string" }, "description": "DeviceDB device_type slugs (device categories) declared disabled." }, "unsupported_providers": { "type": "array", "items": { "type": "string" }, "description": "DeviceDB provider slugs declared disabled or not via Seam, plus providers that run on one of them (e.g. `33-lock` on `tt-lock`) without a declaration of their own." }, "capability": { "type": "string", "description": "The capability the exclusions below were resolved for; empty when none was requested." }, "capability_exclusions": { "type": "array", "items": { "type": "object", "properties": { "device_category": { "type": "string", "description": "Device category, e.g. `smartlock`." }, "manufacturer_slug": { "type": "string", "description": "Empty means every manufacturer in the category." }, "provider_slug": { "type": "string", "description": "Empty means every provider in the category." } }, "required": [ "device_category", "manufacturer_slug", "provider_slug" ], "additionalProperties": false }, "description": "Combinations the partner must not show for that capability because of a capability-level declaration (e.g. mobile keys disabled on Salto KS)." } }, "required": [ "excluded_manufacturers", "excluded_device_types", "unsupported_providers", "capability", "capability_exclusions" ], "additionalProperties": false, "description": "What a partner key's widgets must not show; empty for other keys." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "embed_key", "manufacturer_context", "exclusions", "ok" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ { "embed_key": [] }, { "embed_key_param": [] } ], "parameters": [ { "name": "capability", "in": "query", "required": false, "schema": { "default": "", "description": "DeviceDB capability the widget is rendering (capability_name); adds capability_exclusions.", "type": "string", "pattern": "^[a-z0-9_]*$" } } ] }, "post": { "summary": "Resolve an embed key", "description": "Validates an embed key against the request's `Origin` and returns the key's public record and the manufacturer a manufacturer key scopes widgets to (`manufacturer_context`, null for other keys). For a partner key, it also returns what the partner's widgets must not show: the manufacturers, device types and providers the partner declared disabled or not supported through Seam and, given `capability`, the manufacturer and provider combinations excluded for that capability. Seam's device database widgets call this endpoint.", "tags": [ "compatibility", "embed-keys" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "embed_key": { "type": "object", "properties": { "embed_key_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the key." }, "display_name": { "type": "string", "description": "Display name." }, "owner_kind": { "type": "string", "enum": [ "partner", "manufacturer", "seam" ], "description": "Who owns the key: `partner`, `manufacturer` or `seam`." }, "partner_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ], "description": "The owning partner's UUID; null for other owners." }, "manufacturer_slug": { "description": "The owning manufacturer's slug; null for other owners.", "type": [ "string", "null" ] }, "allowed_origins": { "type": "array", "items": { "type": "string" }, "description": "Origins allowed to use the key, as globs; localhost is always allowed." }, "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {}, "description": "Widget configuration stored with the key." }, "revoked_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ], "description": "When the key was revoked (ISO 8601); null while active." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." } }, "required": [ "embed_key_id", "display_name", "owner_kind", "partner_id", "manufacturer_slug", "allowed_origins", "config", "revoked_at", "created_at" ], "additionalProperties": false, "description": "The key's public record, without the key value." }, "manufacturer_context": { "anyOf": [ { "type": "object", "properties": { "manufacturer_slug": { "type": "string", "description": "The manufacturer widgets default their filter to." } }, "required": [ "manufacturer_slug" ], "additionalProperties": false }, { "type": "null" } ], "description": "Set for manufacturer-owned keys; null for partner and Seam keys." }, "exclusions": { "type": "object", "properties": { "excluded_manufacturers": { "type": "array", "items": { "type": "string" }, "description": "DeviceDB manufacturer slugs declared disabled or not via Seam." }, "excluded_device_types": { "type": "array", "items": { "type": "string" }, "description": "DeviceDB device_type slugs (device categories) declared disabled." }, "unsupported_providers": { "type": "array", "items": { "type": "string" }, "description": "DeviceDB provider slugs declared disabled or not via Seam, plus providers that run on one of them (e.g. `33-lock` on `tt-lock`) without a declaration of their own." }, "capability": { "type": "string", "description": "The capability the exclusions below were resolved for; empty when none was requested." }, "capability_exclusions": { "type": "array", "items": { "type": "object", "properties": { "device_category": { "type": "string", "description": "Device category, e.g. `smartlock`." }, "manufacturer_slug": { "type": "string", "description": "Empty means every manufacturer in the category." }, "provider_slug": { "type": "string", "description": "Empty means every provider in the category." } }, "required": [ "device_category", "manufacturer_slug", "provider_slug" ], "additionalProperties": false }, "description": "Combinations the partner must not show for that capability because of a capability-level declaration (e.g. mobile keys disabled on Salto KS)." } }, "required": [ "excluded_manufacturers", "excluded_device_types", "unsupported_providers", "capability", "capability_exclusions" ], "additionalProperties": false, "description": "What a partner key's widgets must not show; empty for other keys." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "embed_key", "manufacturer_context", "exclusions", "ok" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ { "embed_key": [] }, { "embed_key_param": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "embed_key": { "description": "Embed key, as an alternative to the `X-Embed-Key` header or the `embed_key` query parameter.", "type": "string" }, "capability": { "default": "", "description": "DeviceDB capability the widget is rendering (capability_name); adds capability_exclusions.", "type": "string", "pattern": "^[a-z0-9_]*$" } } } } } } } }, "/health": { "get": { "summary": "Health", "description": "Returns ok when the service and its database are reachable.", "tags": [ "health" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "service": { "type": "string", "const": "seam-ecosystem", "description": "Service name." }, "database": { "type": "string", "enum": [ "ok", "error" ], "description": "Whether the service reached its database." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "service", "database", "ok" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [], "parameters": [] } }, "/industries/list": { "get": { "summary": "List industries", "description": "Lists every industry in the ecosystem taxonomy.", "tags": [ "industries" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "industries": { "type": "array", "items": { "type": "object", "properties": { "industry_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the industry." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `short-term-rental`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] } }, "required": [ "industry_id", "slug", "display_name", "short_name" ], "additionalProperties": false }, "description": "Industries, ordered by name." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "industries", "ok" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [], "parameters": [] }, "post": { "summary": "List industries", "description": "Lists every industry in the ecosystem taxonomy.", "tags": [ "industries" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "industries": { "type": "array", "items": { "type": "object", "properties": { "industry_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the industry." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `short-term-rental`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] } }, "required": [ "industry_id", "slug", "display_name", "short_name" ], "additionalProperties": false }, "description": "Industries, ordered by name." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "industries", "ok" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [] } }, "/installers/get": { "get": { "summary": "Get a published installer", "description": "Returns one published installer profile by slug, with recorded expertise, stated service coverage and public offices.", "tags": [ "installers" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "installer": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique URL-friendly company name." }, "display_name": { "type": "string", "description": "Installer company name." }, "website": { "description": "Company website, when known.", "type": [ "string", "null" ] }, "logo_url": { "description": "Hosted company logo URL, when collected.", "type": [ "string", "null" ] }, "phone": { "description": "Public business phone, including country code when known.", "type": [ "string", "null" ] }, "email": { "description": "Public business email address.", "type": [ "string", "null" ] }, "contact_url": { "description": "Public contact form or inquiry page.", "type": [ "string", "null" ] }, "description_md": { "description": "Company description in Markdown.", "type": [ "string", "null" ] }, "founded_year": { "description": "Confirmed public founding year, when known.", "type": [ "number", "null" ] }, "technician_count_min": { "description": "Optional lower bound on installation staff.", "type": [ "number", "null" ] }, "technician_count_max": { "description": "Optional upper bound on installation staff.", "type": [ "number", "null" ] }, "expertise": { "type": "array", "items": { "type": "object", "properties": { "manufacturer": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Logical UUID of the published record." }, "slug": { "type": "string", "description": "Published target slug." }, "display_name": { "type": "string", "description": "Published target name." } }, "required": [ "id", "slug", "display_name" ], "additionalProperties": false }, { "type": "null" } ], "description": "Published manufacturer for this expertise, when selected." }, "provider": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Logical UUID of the published record." }, "slug": { "type": "string", "description": "Published target slug." }, "display_name": { "type": "string", "description": "Published target name." } }, "required": [ "id", "slug", "display_name" ], "additionalProperties": false }, { "type": "null" } ], "description": "Published provider for this expertise, when selected." }, "services": { "type": "array", "items": { "type": "string", "enum": [ "install", "service", "repair", "retrofit", "takeover" ], "description": "Work offered for the selected brand or system." }, "description": "Services offered for this exact target." }, "experience_since_year": { "description": "Year the installer says it began working with this target.", "type": [ "number", "null" ] } }, "required": [ "manufacturer", "provider", "services", "experience_since_year" ], "additionalProperties": false }, "description": "Explicit expertise in published manufacturers or providers." }, "service_areas": { "type": "array", "items": { "type": "object", "properties": { "coverage_kind": { "type": "string", "enum": [ "locality", "county", "region", "country", "zone" ], "description": "Scope of this stated coverage claim." }, "country_code": { "description": "Two-letter country code; null only for a named broad zone.", "type": [ "string", "null" ] }, "region_code": { "description": "State or province code, when the claim names one.", "type": [ "string", "null" ] }, "locality": { "description": "City for locality coverage, when the claim names one.", "type": [ "string", "null" ] }, "county": { "description": "County or district, when the claim names one.", "type": [ "string", "null" ] }, "zone_name": { "description": "Named broad zone, when the claim names one.", "type": [ "string", "null" ] }, "source_kind": { "type": "string", "enum": [ "public_source", "installer_confirmed" ], "description": "Whether a public page claims this coverage or the installer confirmed it." } }, "required": [ "coverage_kind", "country_code", "region_code", "locality", "county", "zone_name", "source_kind" ], "additionalProperties": false }, "description": "Stated service coverage; office addresses never establish coverage." }, "industries": { "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string", "description": "Industry slug." }, "display_name": { "type": "string", "description": "Industry name." } }, "required": [ "slug", "display_name" ], "additionalProperties": false }, "description": "Optional industry specializations." } }, "required": [ "slug", "display_name", "website", "logo_url", "phone", "email", "contact_url", "description_md", "founded_year", "technician_count_min", "technician_count_max", "expertise", "service_areas", "industries" ], "additionalProperties": false, "description": "Published installer profile." }, "locations": { "type": "array", "items": { "type": "object", "properties": { "city": { "description": "Recorded office city.", "type": [ "string", "null" ] }, "region_code": { "description": "Recorded office state or province code.", "type": [ "string", "null" ] }, "postal_code": { "description": "Recorded office postal code, preserving leading zeros.", "type": [ "string", "null" ] }, "country_code": { "type": "string", "description": "Two-letter office country code." }, "address_line1": { "description": "Published office street address, when recorded.", "type": [ "string", "null" ] }, "address_line2": { "description": "Published office suite or secondary address, when recorded.", "type": [ "string", "null" ] } }, "required": [ "city", "region_code", "postal_code", "country_code", "address_line1", "address_line2" ], "additionalProperties": false, "description": "A recorded public office for an installer." }, "description": "Recorded public offices; an office address does not establish service coverage." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "installer", "locations", "ok" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "parameters": [ { "name": "slug", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 160, "description": "Published installer slug." } } ] }, "post": { "summary": "Get a published installer", "description": "Returns one published installer profile by slug, with recorded expertise, stated service coverage and public offices.", "tags": [ "installers" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "installer": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique URL-friendly company name." }, "display_name": { "type": "string", "description": "Installer company name." }, "website": { "description": "Company website, when known.", "type": [ "string", "null" ] }, "logo_url": { "description": "Hosted company logo URL, when collected.", "type": [ "string", "null" ] }, "phone": { "description": "Public business phone, including country code when known.", "type": [ "string", "null" ] }, "email": { "description": "Public business email address.", "type": [ "string", "null" ] }, "contact_url": { "description": "Public contact form or inquiry page.", "type": [ "string", "null" ] }, "description_md": { "description": "Company description in Markdown.", "type": [ "string", "null" ] }, "founded_year": { "description": "Confirmed public founding year, when known.", "type": [ "number", "null" ] }, "technician_count_min": { "description": "Optional lower bound on installation staff.", "type": [ "number", "null" ] }, "technician_count_max": { "description": "Optional upper bound on installation staff.", "type": [ "number", "null" ] }, "expertise": { "type": "array", "items": { "type": "object", "properties": { "manufacturer": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Logical UUID of the published record." }, "slug": { "type": "string", "description": "Published target slug." }, "display_name": { "type": "string", "description": "Published target name." } }, "required": [ "id", "slug", "display_name" ], "additionalProperties": false }, { "type": "null" } ], "description": "Published manufacturer for this expertise, when selected." }, "provider": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Logical UUID of the published record." }, "slug": { "type": "string", "description": "Published target slug." }, "display_name": { "type": "string", "description": "Published target name." } }, "required": [ "id", "slug", "display_name" ], "additionalProperties": false }, { "type": "null" } ], "description": "Published provider for this expertise, when selected." }, "services": { "type": "array", "items": { "type": "string", "enum": [ "install", "service", "repair", "retrofit", "takeover" ], "description": "Work offered for the selected brand or system." }, "description": "Services offered for this exact target." }, "experience_since_year": { "description": "Year the installer says it began working with this target.", "type": [ "number", "null" ] } }, "required": [ "manufacturer", "provider", "services", "experience_since_year" ], "additionalProperties": false }, "description": "Explicit expertise in published manufacturers or providers." }, "service_areas": { "type": "array", "items": { "type": "object", "properties": { "coverage_kind": { "type": "string", "enum": [ "locality", "county", "region", "country", "zone" ], "description": "Scope of this stated coverage claim." }, "country_code": { "description": "Two-letter country code; null only for a named broad zone.", "type": [ "string", "null" ] }, "region_code": { "description": "State or province code, when the claim names one.", "type": [ "string", "null" ] }, "locality": { "description": "City for locality coverage, when the claim names one.", "type": [ "string", "null" ] }, "county": { "description": "County or district, when the claim names one.", "type": [ "string", "null" ] }, "zone_name": { "description": "Named broad zone, when the claim names one.", "type": [ "string", "null" ] }, "source_kind": { "type": "string", "enum": [ "public_source", "installer_confirmed" ], "description": "Whether a public page claims this coverage or the installer confirmed it." } }, "required": [ "coverage_kind", "country_code", "region_code", "locality", "county", "zone_name", "source_kind" ], "additionalProperties": false }, "description": "Stated service coverage; office addresses never establish coverage." }, "industries": { "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string", "description": "Industry slug." }, "display_name": { "type": "string", "description": "Industry name." } }, "required": [ "slug", "display_name" ], "additionalProperties": false }, "description": "Optional industry specializations." } }, "required": [ "slug", "display_name", "website", "logo_url", "phone", "email", "contact_url", "description_md", "founded_year", "technician_count_min", "technician_count_max", "expertise", "service_areas", "industries" ], "additionalProperties": false, "description": "Published installer profile." }, "locations": { "type": "array", "items": { "type": "object", "properties": { "city": { "description": "Recorded office city.", "type": [ "string", "null" ] }, "region_code": { "description": "Recorded office state or province code.", "type": [ "string", "null" ] }, "postal_code": { "description": "Recorded office postal code, preserving leading zeros.", "type": [ "string", "null" ] }, "country_code": { "type": "string", "description": "Two-letter office country code." }, "address_line1": { "description": "Published office street address, when recorded.", "type": [ "string", "null" ] }, "address_line2": { "description": "Published office suite or secondary address, when recorded.", "type": [ "string", "null" ] } }, "required": [ "city", "region_code", "postal_code", "country_code", "address_line1", "address_line2" ], "additionalProperties": false, "description": "A recorded public office for an installer." }, "description": "Recorded public offices; an office address does not establish service coverage." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "installer", "locations", "ok" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "slug": { "type": "string", "minLength": 1, "maxLength": 160, "description": "Published installer slug." } }, "required": [ "slug" ] } } } } } }, "/installers/list": { "get": { "summary": "List published installers", "description": "Lists published installers, optionally filtered by one published manufacturer or provider slug, with their recorded public offices. Only published profiles are returned.", "tags": [ "installers" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "installers": { "type": "array", "items": { "type": "object", "properties": { "installer": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique URL-friendly company name." }, "display_name": { "type": "string", "description": "Installer company name." }, "website": { "description": "Company website, when known.", "type": [ "string", "null" ] }, "logo_url": { "description": "Hosted company logo URL, when collected.", "type": [ "string", "null" ] }, "phone": { "description": "Public business phone, including country code when known.", "type": [ "string", "null" ] }, "email": { "description": "Public business email address.", "type": [ "string", "null" ] }, "contact_url": { "description": "Public contact form or inquiry page.", "type": [ "string", "null" ] }, "description_md": { "description": "Company description in Markdown.", "type": [ "string", "null" ] }, "founded_year": { "description": "Confirmed public founding year, when known.", "type": [ "number", "null" ] }, "technician_count_min": { "description": "Optional lower bound on installation staff.", "type": [ "number", "null" ] }, "technician_count_max": { "description": "Optional upper bound on installation staff.", "type": [ "number", "null" ] }, "expertise": { "type": "array", "items": { "type": "object", "properties": { "manufacturer": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Logical UUID of the published record." }, "slug": { "type": "string", "description": "Published target slug." }, "display_name": { "type": "string", "description": "Published target name." } }, "required": [ "id", "slug", "display_name" ], "additionalProperties": false }, { "type": "null" } ], "description": "Published manufacturer for this expertise, when selected." }, "provider": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Logical UUID of the published record." }, "slug": { "type": "string", "description": "Published target slug." }, "display_name": { "type": "string", "description": "Published target name." } }, "required": [ "id", "slug", "display_name" ], "additionalProperties": false }, { "type": "null" } ], "description": "Published provider for this expertise, when selected." }, "services": { "type": "array", "items": { "type": "string", "enum": [ "install", "service", "repair", "retrofit", "takeover" ], "description": "Work offered for the selected brand or system." }, "description": "Services offered for this exact target." }, "experience_since_year": { "description": "Year the installer says it began working with this target.", "type": [ "number", "null" ] } }, "required": [ "manufacturer", "provider", "services", "experience_since_year" ], "additionalProperties": false }, "description": "Explicit expertise in published manufacturers or providers." }, "service_areas": { "type": "array", "items": { "type": "object", "properties": { "coverage_kind": { "type": "string", "enum": [ "locality", "county", "region", "country", "zone" ], "description": "Scope of this stated coverage claim." }, "country_code": { "description": "Two-letter country code; null only for a named broad zone.", "type": [ "string", "null" ] }, "region_code": { "description": "State or province code, when the claim names one.", "type": [ "string", "null" ] }, "locality": { "description": "City for locality coverage, when the claim names one.", "type": [ "string", "null" ] }, "county": { "description": "County or district, when the claim names one.", "type": [ "string", "null" ] }, "zone_name": { "description": "Named broad zone, when the claim names one.", "type": [ "string", "null" ] }, "source_kind": { "type": "string", "enum": [ "public_source", "installer_confirmed" ], "description": "Whether a public page claims this coverage or the installer confirmed it." } }, "required": [ "coverage_kind", "country_code", "region_code", "locality", "county", "zone_name", "source_kind" ], "additionalProperties": false }, "description": "Stated service coverage; office addresses never establish coverage." }, "industries": { "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string", "description": "Industry slug." }, "display_name": { "type": "string", "description": "Industry name." } }, "required": [ "slug", "display_name" ], "additionalProperties": false }, "description": "Optional industry specializations." } }, "required": [ "slug", "display_name", "website", "logo_url", "phone", "email", "contact_url", "description_md", "founded_year", "technician_count_min", "technician_count_max", "expertise", "service_areas", "industries" ], "additionalProperties": false, "description": "Published installer profile." }, "locations": { "type": "array", "items": { "type": "object", "properties": { "city": { "description": "Recorded office city.", "type": [ "string", "null" ] }, "region_code": { "description": "Recorded office state or province code.", "type": [ "string", "null" ] }, "postal_code": { "description": "Recorded office postal code, preserving leading zeros.", "type": [ "string", "null" ] }, "country_code": { "type": "string", "description": "Two-letter office country code." }, "address_line1": { "description": "Published office street address, when recorded.", "type": [ "string", "null" ] }, "address_line2": { "description": "Published office suite or secondary address, when recorded.", "type": [ "string", "null" ] } }, "required": [ "city", "region_code", "postal_code", "country_code", "address_line1", "address_line2" ], "additionalProperties": false, "description": "A recorded public office for an installer." }, "description": "Recorded public offices; an office address does not establish service coverage." } }, "required": [ "installer", "locations" ], "additionalProperties": false, "description": "A published installer with its recorded offices." }, "description": "Published installers in slug order." }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Published companies matching the expertise filter." }, "next_cursor": { "description": "Last slug on the page, or null at the end.", "type": [ "string", "null" ] }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "installers", "total", "next_cursor", "ok" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "parameters": [ { "name": "manufacturer_slug", "in": "query", "required": false, "schema": { "description": "Published manufacturer slug whose recorded installer expertise to match.", "type": "string", "minLength": 1, "maxLength": 160 } }, { "name": "provider_slug", "in": "query", "required": false, "schema": { "description": "Published provider slug whose recorded installer expertise to match.", "type": "string", "minLength": 1, "maxLength": 160 } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 100, "description": "Page size, 1-100.", "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "after", "in": "query", "required": false, "schema": { "description": "Last installer slug from the previous page.", "type": "string", "maxLength": 160 } } ] }, "post": { "summary": "List published installers", "description": "Lists published installers, optionally filtered by one published manufacturer or provider slug, with their recorded public offices. Only published profiles are returned.", "tags": [ "installers" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "installers": { "type": "array", "items": { "type": "object", "properties": { "installer": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique URL-friendly company name." }, "display_name": { "type": "string", "description": "Installer company name." }, "website": { "description": "Company website, when known.", "type": [ "string", "null" ] }, "logo_url": { "description": "Hosted company logo URL, when collected.", "type": [ "string", "null" ] }, "phone": { "description": "Public business phone, including country code when known.", "type": [ "string", "null" ] }, "email": { "description": "Public business email address.", "type": [ "string", "null" ] }, "contact_url": { "description": "Public contact form or inquiry page.", "type": [ "string", "null" ] }, "description_md": { "description": "Company description in Markdown.", "type": [ "string", "null" ] }, "founded_year": { "description": "Confirmed public founding year, when known.", "type": [ "number", "null" ] }, "technician_count_min": { "description": "Optional lower bound on installation staff.", "type": [ "number", "null" ] }, "technician_count_max": { "description": "Optional upper bound on installation staff.", "type": [ "number", "null" ] }, "expertise": { "type": "array", "items": { "type": "object", "properties": { "manufacturer": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Logical UUID of the published record." }, "slug": { "type": "string", "description": "Published target slug." }, "display_name": { "type": "string", "description": "Published target name." } }, "required": [ "id", "slug", "display_name" ], "additionalProperties": false }, { "type": "null" } ], "description": "Published manufacturer for this expertise, when selected." }, "provider": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Logical UUID of the published record." }, "slug": { "type": "string", "description": "Published target slug." }, "display_name": { "type": "string", "description": "Published target name." } }, "required": [ "id", "slug", "display_name" ], "additionalProperties": false }, { "type": "null" } ], "description": "Published provider for this expertise, when selected." }, "services": { "type": "array", "items": { "type": "string", "enum": [ "install", "service", "repair", "retrofit", "takeover" ], "description": "Work offered for the selected brand or system." }, "description": "Services offered for this exact target." }, "experience_since_year": { "description": "Year the installer says it began working with this target.", "type": [ "number", "null" ] } }, "required": [ "manufacturer", "provider", "services", "experience_since_year" ], "additionalProperties": false }, "description": "Explicit expertise in published manufacturers or providers." }, "service_areas": { "type": "array", "items": { "type": "object", "properties": { "coverage_kind": { "type": "string", "enum": [ "locality", "county", "region", "country", "zone" ], "description": "Scope of this stated coverage claim." }, "country_code": { "description": "Two-letter country code; null only for a named broad zone.", "type": [ "string", "null" ] }, "region_code": { "description": "State or province code, when the claim names one.", "type": [ "string", "null" ] }, "locality": { "description": "City for locality coverage, when the claim names one.", "type": [ "string", "null" ] }, "county": { "description": "County or district, when the claim names one.", "type": [ "string", "null" ] }, "zone_name": { "description": "Named broad zone, when the claim names one.", "type": [ "string", "null" ] }, "source_kind": { "type": "string", "enum": [ "public_source", "installer_confirmed" ], "description": "Whether a public page claims this coverage or the installer confirmed it." } }, "required": [ "coverage_kind", "country_code", "region_code", "locality", "county", "zone_name", "source_kind" ], "additionalProperties": false }, "description": "Stated service coverage; office addresses never establish coverage." }, "industries": { "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string", "description": "Industry slug." }, "display_name": { "type": "string", "description": "Industry name." } }, "required": [ "slug", "display_name" ], "additionalProperties": false }, "description": "Optional industry specializations." } }, "required": [ "slug", "display_name", "website", "logo_url", "phone", "email", "contact_url", "description_md", "founded_year", "technician_count_min", "technician_count_max", "expertise", "service_areas", "industries" ], "additionalProperties": false, "description": "Published installer profile." }, "locations": { "type": "array", "items": { "type": "object", "properties": { "city": { "description": "Recorded office city.", "type": [ "string", "null" ] }, "region_code": { "description": "Recorded office state or province code.", "type": [ "string", "null" ] }, "postal_code": { "description": "Recorded office postal code, preserving leading zeros.", "type": [ "string", "null" ] }, "country_code": { "type": "string", "description": "Two-letter office country code." }, "address_line1": { "description": "Published office street address, when recorded.", "type": [ "string", "null" ] }, "address_line2": { "description": "Published office suite or secondary address, when recorded.", "type": [ "string", "null" ] } }, "required": [ "city", "region_code", "postal_code", "country_code", "address_line1", "address_line2" ], "additionalProperties": false, "description": "A recorded public office for an installer." }, "description": "Recorded public offices; an office address does not establish service coverage." } }, "required": [ "installer", "locations" ], "additionalProperties": false, "description": "A published installer with its recorded offices." }, "description": "Published installers in slug order." }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Published companies matching the expertise filter." }, "next_cursor": { "description": "Last slug on the page, or null at the end.", "type": [ "string", "null" ] }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "installers", "total", "next_cursor", "ok" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "manufacturer_slug": { "description": "Published manufacturer slug whose recorded installer expertise to match.", "type": "string", "minLength": 1, "maxLength": 160 }, "provider_slug": { "description": "Published provider slug whose recorded installer expertise to match.", "type": "string", "minLength": 1, "maxLength": 160 }, "limit": { "default": 100, "description": "Page size, 1-100.", "type": "integer", "minimum": 1, "maximum": 100 }, "after": { "description": "Last installer slug from the previous page.", "type": "string", "maxLength": 160 } } } } } } } }, "/installers/nearby": { "get": { "summary": "Find published installers by US ZIP", "description": "Find published installers near a US ZIP code or with stated coverage containing it. Optionally filter by one published manufacturer or provider slug. Only published installer profiles are returned; a nearby office does not establish service coverage.", "tags": [ "installers" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "origin": { "type": "object", "properties": { "postal_code": { "type": "string", "description": "US ZIP searched." }, "display_name": { "type": "string", "description": "Reference postal location label." } }, "required": [ "postal_code", "display_name" ], "additionalProperties": false, "description": "Geographic reference point for the searched ZIP." }, "matches": { "type": "array", "items": { "type": "object", "properties": { "installer": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique URL-friendly company name." }, "display_name": { "type": "string", "description": "Installer company name." }, "website": { "description": "Company website, when known.", "type": [ "string", "null" ] }, "logo_url": { "description": "Hosted company logo URL, when collected.", "type": [ "string", "null" ] }, "phone": { "description": "Public business phone, including country code when known.", "type": [ "string", "null" ] }, "email": { "description": "Public business email address.", "type": [ "string", "null" ] }, "contact_url": { "description": "Public contact form or inquiry page.", "type": [ "string", "null" ] }, "description_md": { "description": "Company description in Markdown.", "type": [ "string", "null" ] }, "founded_year": { "description": "Confirmed public founding year, when known.", "type": [ "number", "null" ] }, "technician_count_min": { "description": "Optional lower bound on installation staff.", "type": [ "number", "null" ] }, "technician_count_max": { "description": "Optional upper bound on installation staff.", "type": [ "number", "null" ] }, "expertise": { "type": "array", "items": { "type": "object", "properties": { "manufacturer": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Logical UUID of the published record." }, "slug": { "type": "string", "description": "Published target slug." }, "display_name": { "type": "string", "description": "Published target name." } }, "required": [ "id", "slug", "display_name" ], "additionalProperties": false }, { "type": "null" } ], "description": "Published manufacturer for this expertise, when selected." }, "provider": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Logical UUID of the published record." }, "slug": { "type": "string", "description": "Published target slug." }, "display_name": { "type": "string", "description": "Published target name." } }, "required": [ "id", "slug", "display_name" ], "additionalProperties": false }, { "type": "null" } ], "description": "Published provider for this expertise, when selected." }, "services": { "type": "array", "items": { "type": "string", "enum": [ "install", "service", "repair", "retrofit", "takeover" ], "description": "Work offered for the selected brand or system." }, "description": "Services offered for this exact target." }, "experience_since_year": { "description": "Year the installer says it began working with this target.", "type": [ "number", "null" ] } }, "required": [ "manufacturer", "provider", "services", "experience_since_year" ], "additionalProperties": false }, "description": "Explicit expertise in published manufacturers or providers." }, "service_areas": { "type": "array", "items": { "type": "object", "properties": { "coverage_kind": { "type": "string", "enum": [ "locality", "county", "region", "country", "zone" ], "description": "Scope of this stated coverage claim." }, "country_code": { "description": "Two-letter country code; null only for a named broad zone.", "type": [ "string", "null" ] }, "region_code": { "description": "State or province code, when the claim names one.", "type": [ "string", "null" ] }, "locality": { "description": "City for locality coverage, when the claim names one.", "type": [ "string", "null" ] }, "county": { "description": "County or district, when the claim names one.", "type": [ "string", "null" ] }, "zone_name": { "description": "Named broad zone, when the claim names one.", "type": [ "string", "null" ] }, "source_kind": { "type": "string", "enum": [ "public_source", "installer_confirmed" ], "description": "Whether a public page claims this coverage or the installer confirmed it." } }, "required": [ "coverage_kind", "country_code", "region_code", "locality", "county", "zone_name", "source_kind" ], "additionalProperties": false }, "description": "Stated service coverage; office addresses never establish coverage." }, "industries": { "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string", "description": "Industry slug." }, "display_name": { "type": "string", "description": "Industry name." } }, "required": [ "slug", "display_name" ], "additionalProperties": false }, "description": "Optional industry specializations." } }, "required": [ "slug", "display_name", "website", "logo_url", "phone", "email", "contact_url", "description_md", "founded_year", "technician_count_min", "technician_count_max", "expertise", "service_areas", "industries" ], "additionalProperties": false, "description": "Published installer profile." }, "nearest_location": { "anyOf": [ { "type": "object", "properties": { "city": { "description": "Nearest recorded office city.", "type": [ "string", "null" ] }, "region_code": { "description": "Nearest recorded office state or province code.", "type": [ "string", "null" ] }, "postal_code": { "description": "Nearest recorded office postal code.", "type": [ "string", "null" ] }, "country_code": { "type": "string", "description": "Nearest recorded office country code." } }, "required": [ "city", "region_code", "postal_code", "country_code" ], "additionalProperties": false }, { "type": "null" } ], "description": "Nearest recorded office, when available." }, "distance_miles": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ], "description": "Approximate straight-line distance from ZIP representative point to nearest office." }, "coverage_status": { "type": "string", "enum": [ "installer_confirmed", "public_source", "not_established" ], "description": "Matching stated coverage evidence; office proximity alone does not establish coverage." } }, "required": [ "installer", "nearest_location", "distance_miles", "coverage_status" ], "additionalProperties": false }, "description": "Installers matching the search, nearest first." }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Published companies matching all geographic and expertise filters." }, "next_offset": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Next result offset or null at the end." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "origin", "matches", "total", "next_offset", "ok" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "parameters": [ { "name": "postal_code", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^\\d{5}$", "description": "Five-digit US ZIP code, preserving leading zeros." } }, { "name": "mode", "in": "query", "required": false, "schema": { "default": "nearby", "description": "Nearby recorded offices, or stated coverage containing the ZIP representative point.", "type": "string", "enum": [ "nearby", "serves" ] } }, { "name": "radius_miles", "in": "query", "required": false, "schema": { "default": 50, "description": "Office search radius in miles; only applies in nearby mode.", "type": "integer", "minimum": 1, "maximum": 500 } }, { "name": "manufacturer_slug", "in": "query", "required": false, "schema": { "description": "Published manufacturer slug whose recorded installer expertise to match.", "type": "string", "minLength": 1, "maxLength": 160 } }, { "name": "provider_slug", "in": "query", "required": false, "schema": { "description": "Published provider slug whose recorded installer expertise to match.", "type": "string", "minLength": 1, "maxLength": 160 } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 20, "description": "Page size, 1-100.", "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "offset", "in": "query", "required": false, "schema": { "default": 0, "description": "Result offset.", "type": "integer", "minimum": 0, "maximum": 10000 } } ] }, "post": { "summary": "Find published installers by US ZIP", "description": "Find published installers near a US ZIP code or with stated coverage containing it. Optionally filter by one published manufacturer or provider slug. Only published installer profiles are returned; a nearby office does not establish service coverage.", "tags": [ "installers" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "origin": { "type": "object", "properties": { "postal_code": { "type": "string", "description": "US ZIP searched." }, "display_name": { "type": "string", "description": "Reference postal location label." } }, "required": [ "postal_code", "display_name" ], "additionalProperties": false, "description": "Geographic reference point for the searched ZIP." }, "matches": { "type": "array", "items": { "type": "object", "properties": { "installer": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique URL-friendly company name." }, "display_name": { "type": "string", "description": "Installer company name." }, "website": { "description": "Company website, when known.", "type": [ "string", "null" ] }, "logo_url": { "description": "Hosted company logo URL, when collected.", "type": [ "string", "null" ] }, "phone": { "description": "Public business phone, including country code when known.", "type": [ "string", "null" ] }, "email": { "description": "Public business email address.", "type": [ "string", "null" ] }, "contact_url": { "description": "Public contact form or inquiry page.", "type": [ "string", "null" ] }, "description_md": { "description": "Company description in Markdown.", "type": [ "string", "null" ] }, "founded_year": { "description": "Confirmed public founding year, when known.", "type": [ "number", "null" ] }, "technician_count_min": { "description": "Optional lower bound on installation staff.", "type": [ "number", "null" ] }, "technician_count_max": { "description": "Optional upper bound on installation staff.", "type": [ "number", "null" ] }, "expertise": { "type": "array", "items": { "type": "object", "properties": { "manufacturer": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Logical UUID of the published record." }, "slug": { "type": "string", "description": "Published target slug." }, "display_name": { "type": "string", "description": "Published target name." } }, "required": [ "id", "slug", "display_name" ], "additionalProperties": false }, { "type": "null" } ], "description": "Published manufacturer for this expertise, when selected." }, "provider": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Logical UUID of the published record." }, "slug": { "type": "string", "description": "Published target slug." }, "display_name": { "type": "string", "description": "Published target name." } }, "required": [ "id", "slug", "display_name" ], "additionalProperties": false }, { "type": "null" } ], "description": "Published provider for this expertise, when selected." }, "services": { "type": "array", "items": { "type": "string", "enum": [ "install", "service", "repair", "retrofit", "takeover" ], "description": "Work offered for the selected brand or system." }, "description": "Services offered for this exact target." }, "experience_since_year": { "description": "Year the installer says it began working with this target.", "type": [ "number", "null" ] } }, "required": [ "manufacturer", "provider", "services", "experience_since_year" ], "additionalProperties": false }, "description": "Explicit expertise in published manufacturers or providers." }, "service_areas": { "type": "array", "items": { "type": "object", "properties": { "coverage_kind": { "type": "string", "enum": [ "locality", "county", "region", "country", "zone" ], "description": "Scope of this stated coverage claim." }, "country_code": { "description": "Two-letter country code; null only for a named broad zone.", "type": [ "string", "null" ] }, "region_code": { "description": "State or province code, when the claim names one.", "type": [ "string", "null" ] }, "locality": { "description": "City for locality coverage, when the claim names one.", "type": [ "string", "null" ] }, "county": { "description": "County or district, when the claim names one.", "type": [ "string", "null" ] }, "zone_name": { "description": "Named broad zone, when the claim names one.", "type": [ "string", "null" ] }, "source_kind": { "type": "string", "enum": [ "public_source", "installer_confirmed" ], "description": "Whether a public page claims this coverage or the installer confirmed it." } }, "required": [ "coverage_kind", "country_code", "region_code", "locality", "county", "zone_name", "source_kind" ], "additionalProperties": false }, "description": "Stated service coverage; office addresses never establish coverage." }, "industries": { "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string", "description": "Industry slug." }, "display_name": { "type": "string", "description": "Industry name." } }, "required": [ "slug", "display_name" ], "additionalProperties": false }, "description": "Optional industry specializations." } }, "required": [ "slug", "display_name", "website", "logo_url", "phone", "email", "contact_url", "description_md", "founded_year", "technician_count_min", "technician_count_max", "expertise", "service_areas", "industries" ], "additionalProperties": false, "description": "Published installer profile." }, "nearest_location": { "anyOf": [ { "type": "object", "properties": { "city": { "description": "Nearest recorded office city.", "type": [ "string", "null" ] }, "region_code": { "description": "Nearest recorded office state or province code.", "type": [ "string", "null" ] }, "postal_code": { "description": "Nearest recorded office postal code.", "type": [ "string", "null" ] }, "country_code": { "type": "string", "description": "Nearest recorded office country code." } }, "required": [ "city", "region_code", "postal_code", "country_code" ], "additionalProperties": false }, { "type": "null" } ], "description": "Nearest recorded office, when available." }, "distance_miles": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ], "description": "Approximate straight-line distance from ZIP representative point to nearest office." }, "coverage_status": { "type": "string", "enum": [ "installer_confirmed", "public_source", "not_established" ], "description": "Matching stated coverage evidence; office proximity alone does not establish coverage." } }, "required": [ "installer", "nearest_location", "distance_miles", "coverage_status" ], "additionalProperties": false }, "description": "Installers matching the search, nearest first." }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Published companies matching all geographic and expertise filters." }, "next_offset": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Next result offset or null at the end." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "origin", "matches", "total", "next_offset", "ok" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "postal_code": { "type": "string", "pattern": "^\\d{5}$", "description": "Five-digit US ZIP code, preserving leading zeros." }, "mode": { "default": "nearby", "description": "Nearby recorded offices, or stated coverage containing the ZIP representative point.", "type": "string", "enum": [ "nearby", "serves" ] }, "radius_miles": { "default": 50, "description": "Office search radius in miles; only applies in nearby mode.", "type": "integer", "minimum": 1, "maximum": 500 }, "manufacturer_slug": { "description": "Published manufacturer slug whose recorded installer expertise to match.", "type": "string", "minLength": 1, "maxLength": 160 }, "provider_slug": { "description": "Published provider slug whose recorded installer expertise to match.", "type": "string", "minLength": 1, "maxLength": 160 }, "limit": { "default": 20, "description": "Page size, 1-100.", "type": "integer", "minimum": 1, "maximum": 100 }, "offset": { "default": 0, "description": "Result offset.", "type": "integer", "minimum": 0, "maximum": 10000 } }, "required": [ "postal_code" ] } } } } } }, "/manufacturer_content/get": { "get": { "summary": "Get a manufacturer's content", "description": "Returns everything Seam publishes about one manufacturer in one call: the profile (name, description, links, logos), its published device models in the summary shape with capabilities per provider, the providers that cover the brand with their integration support levels, and the live partner apps that support it in each device category (declared-first, like `/compatibility`, including support declared for a provider that serves the brand). With a manufacturer key (secret or embed), the manufacturer is implied and `manufacturer_slug` is optional; naming another manufacturer fails with 403 `manufacturer_mismatch`. Without one, name the manufacturer with `manufacturer_slug`. Device models hidden from third parties are excluded; with the manufacturer's secret key, `include_forbidden` adds them. Device models are paged by slug with `limit` and `page_cursor`; every other field is the same on every page.", "tags": [ "manufacturers" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "manufacturer_content": { "type": "object", "properties": { "manufacturer": { "type": "object", "properties": { "manufacturer_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the manufacturer." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `schlage`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] }, "website": { "description": "Website URL, when recorded.", "type": [ "string", "null" ] }, "headquarters": { "description": "Headquarters location, when recorded.", "type": [ "string", "null" ] }, "country_of_origin": { "description": "Country of origin, when recorded.", "type": [ "string", "null" ] }, "parent_org": { "description": "Parent organization or brand the manufacturer is sold under.", "type": [ "string", "null" ] }, "inc_date": { "description": "Incorporation year as recorded in the source, not a date.", "type": [ "string", "null" ] }, "customer_support_phone": { "description": "Customer support phone, when recorded.", "type": [ "string", "null" ] }, "customer_support_email": { "description": "Customer support email, when recorded.", "type": [ "string", "null" ] }, "customer_support_url": { "description": "Customer support URL, when recorded.", "type": [ "string", "null" ] }, "description_md": { "description": "Description in markdown, when recorded.", "type": [ "string", "null" ] }, "seam_api_guide": { "description": "Seam API guide reference, when recorded.", "type": [ "string", "null" ] }, "commerce_footprint": { "anyOf": [ { "$ref": "#/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema0" }, { "type": "null" } ], "description": "Commerce footprint verbatim from the source; null where the source holds none." }, "last_commerce_search_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ], "description": "When commerce listings were last searched; null is a recorded fact, not an omission." }, "logos": { "type": "array", "items": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Square and horizontal logos in color and monochrome variants." }, "default_device_images": { "type": "array", "items": { "type": "object", "properties": { "device_type": { "type": "object", "properties": { "device_type_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device type." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `smartlock`." }, "display_name": { "type": "string", "description": "Display name." }, "is_accessory": { "type": "boolean", "description": "Accessory types (bridges, keypads) rather than primary devices." } }, "required": [ "device_type_id", "slug", "display_name", "is_accessory" ], "additionalProperties": false, "description": "Device type this fallback image applies to." }, "asset": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false, "description": "Fallback image asset for that device type." } }, "required": [ "device_type", "asset" ], "additionalProperties": false }, "description": "Fallback device image per device type." }, "providers": { "type": "array", "items": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name" ], "additionalProperties": false }, "description": "Providers this manufacturer's devices integrate with." }, "device_model_count": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Number of published device models for this manufacturer that the caller may list. Models forbidden to third parties count only for Seam callers, and for a manufacturer secret key only its own." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "manufacturer_id", "slug", "display_name", "website", "headquarters", "country_of_origin", "parent_org", "inc_date", "customer_support_phone", "customer_support_email", "customer_support_url", "description_md", "seam_api_guide", "commerce_footprint", "last_commerce_search_at", "logos", "default_device_images", "providers", "device_model_count", "created_at", "updated_at" ], "additionalProperties": false, "description": "The manufacturer profile: name, description, links, logos and default device images. `device_model_count` counts the device models this caller is shown." }, "providers": { "type": "array", "items": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] }, "description_md": { "description": "Description in markdown, when recorded.", "type": [ "string", "null" ] }, "is_acs": { "description": "Access control system provider; null where not established.", "type": [ "boolean", "null" ] }, "has_requirements": { "description": "Whether integration requirements apply; null where not established.", "type": [ "boolean", "null" ] }, "requirements_md": { "description": "Free-text integration requirements, verbatim from the source.", "type": [ "string", "null" ] }, "logos": { "type": "array", "items": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Square logos in color and monochrome variants." }, "integrations": { "type": "array", "items": { "type": "object", "properties": { "provider_integration_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the integration." }, "kind": { "type": "string", "enum": [ "access", "climate", "sensor" ], "description": "Integration kind: `access`, `climate`, or `sensor`." }, "feature": { "type": "string", "description": "Integration feature, e.g. `lock_unlock` or `hvac`." }, "integration_support_level": { "anyOf": [ { "type": "string", "enum": [ "inquire", "unavailable", "planned", "in-progress", "beta", "stable" ] }, { "type": "null" } ], "description": "Support level for this feature; null where the source has none." }, "flags": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "boolean", "null" ] }, "description": "Per-feature capability flags exactly as authored; null means not established by research." }, "extra_info": { "anyOf": [ { "$ref": "#/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema1" }, { "type": "null" } ], "description": "Additional integration data verbatim from the source." } }, "required": [ "provider_integration_id", "kind", "feature", "integration_support_level", "flags", "extra_info" ], "additionalProperties": false }, "description": "One entry per integration feature with its support level and flags." }, "industries": { "type": "array", "items": { "type": "object", "properties": { "industry_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the industry." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `short-term-rental`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] } }, "required": [ "industry_id", "slug", "display_name", "short_name" ], "additionalProperties": false }, "description": "Industries this provider serves." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." }, "device_model_count": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "How many of this manufacturer's device models the caller may see (across every page) the provider covers; 0 for a provider linked only to the manufacturer." } }, "required": [ "provider_id", "slug", "display_name", "description_md", "is_acs", "has_requirements", "requirements_md", "logos", "integrations", "industries", "created_at", "updated_at", "device_model_count" ], "additionalProperties": false }, "description": "Providers (integration paths) that cover the brand: linked to the manufacturer or to any of its device models the caller may see, with their integrations and support levels." }, "compatibility": { "type": "array", "items": { "type": "object", "properties": { "device_category": { "type": "string", "description": "Device category, the slug of a primary device type the manufacturer has models in, e.g. `smartlock`." }, "partners": { "type": "array", "items": { "type": "object", "properties": { "partner_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the partner." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `hospitable`." }, "display_name": { "type": "string", "description": "Display name." }, "website": { "description": "Website URL, when recorded.", "type": [ "string", "null" ] }, "description_md": { "description": "Markdown description written by Seam or the partner.", "type": [ "string", "null" ] }, "is_live": { "type": "boolean", "description": "The partner's Seam integration is live for its customers." }, "is_featured": { "type": "boolean", "description": "Featured by Seam in partner listings." }, "legacy_industry_featured": { "type": "boolean", "description": "Legacy per-industry featured flag; use `is_featured`." }, "industries": { "type": "array", "items": { "type": "object", "properties": { "industry_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the industry." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `short-term-rental`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] } }, "required": [ "industry_id", "slug", "display_name", "short_name" ], "additionalProperties": false }, "description": "Industries the partner serves." }, "markets": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Countries the partner sells in, as ISO 3166-1 alpha-2 codes; null when unknown." }, "solutions": { "type": "array", "items": { "type": "object", "properties": { "solution_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the solution." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `property-management-system`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "software", "service" ], "description": "`software` or `service`." } }, "required": [ "solution_id", "slug", "display_name", "short_name", "type" ], "additionalProperties": false }, "description": "Kinds of software or service the partner offers." }, "assets": { "type": "array", "items": { "type": "object", "properties": { "partner_asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "product_image" ], "description": "Logo kind or `product_image`." }, "url": { "type": "string", "format": "uri", "description": "Public URL of the asset." }, "mime": { "type": "string", "description": "Media type." }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Display order within the partner." } }, "required": [ "partner_asset_id", "kind", "url", "mime", "width", "height", "sort_order" ], "additionalProperties": false }, "description": "Logos and product images in display order." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." }, "support": { "type": "object", "properties": { "supported": { "type": "boolean", "description": "Whether the partner is listed for the requested scope." }, "resolved_level": { "anyOf": [ { "type": "string", "enum": [ "device_category", "manufacturer", "provider", "capability" ] }, { "type": "null" } ], "description": "The most specific level with a declaration that decided the outcome; null when nothing is declared. `provider` with `via_provider_slug` when a manufacturer was resolved through a provider that serves it." }, "declared_status": { "anyOf": [ { "type": "string", "enum": [ "enabled", "disabled", "not_via_seam" ] }, { "type": "null" } ], "description": "The deciding declaration: `enabled`, `disabled` or `not_via_seam`." }, "observed_status": { "anyOf": [ { "type": "string", "enum": [ "active", "trace", "none", "unknown" ] }, { "type": "null" } ], "description": "What the nightly usage sync observed at that scope; informational only." }, "note": { "description": "Note recorded with the deciding declaration, when any.", "type": [ "string", "null" ] }, "via_provider_slug": { "description": "Present when the deciding declaration was made for a provider the query did not name: a provider serving the requested manufacturer's devices (e.g. `tt-lock` for Sifely), or the provider backing the requested one (e.g. `tt-lock` for `33-lock`).", "type": "string" } }, "required": [ "supported", "resolved_level", "declared_status", "observed_status", "note" ], "additionalProperties": false, "description": "How the support matrix resolved for this category and manufacturer, with the partner's note." } }, "required": [ "partner_id", "slug", "display_name", "website", "description_md", "is_live", "is_featured", "legacy_industry_featured", "industries", "markets", "solutions", "assets", "created_at", "updated_at", "support" ], "additionalProperties": false }, "description": "Live partners that support this manufacturer's devices in this category, resolved declared-first exactly like `/compatibility`, including support declared for a provider that serves the manufacturer." } }, "required": [ "device_category", "partners" ], "additionalProperties": false }, "description": "Compatible partners per device category the manufacturer has published primary device models in." }, "device_models": { "type": "array", "items": { "type": "object", "properties": { "device_model_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device model." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `encodeplus`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] }, "description_md": { "description": "Description in markdown, when recorded.", "type": [ "string", "null" ] }, "product_url": { "description": "Manufacturer product page URL, when recorded.", "type": [ "string", "null" ] }, "no_longer_sold": { "description": "Whether the model is no longer sold; null where not established.", "type": [ "boolean", "null" ] }, "is_forbidden_to_3dparty": { "description": "Forbidden to third-party consumers; such models appear only for callers allowed to set `include_forbidden`.", "type": [ "boolean", "null" ] }, "manufacturer": { "anyOf": [ { "type": "object", "properties": { "manufacturer_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the manufacturer." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `schlage`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "manufacturer_id", "slug", "display_name" ], "additionalProperties": false }, { "type": "null" } ], "description": "Pinned published manufacturer, when set." }, "device_type": { "anyOf": [ { "type": "object", "properties": { "device_type_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device type." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `smartlock`." }, "display_name": { "type": "string", "description": "Display name." }, "is_accessory": { "type": "boolean", "description": "Accessory types (bridges, keypads) rather than primary devices." } }, "required": [ "device_type_id", "slug", "display_name", "is_accessory" ], "additionalProperties": false }, { "type": "null" } ], "description": "Pinned published device type, when set." }, "device_type_properties": { "anyOf": [ { "$ref": "#/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema2" }, { "type": "null" } ], "description": "Per-device-type properties verbatim, including the source component discriminator; null for accessory types." }, "featured_image": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "url": { "type": "string", "description": "Public URL of this rendition." }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." } }, "required": [ "url", "width", "height" ], "additionalProperties": false }, "description": "Smaller renditions present for this image, keyed `thumbnail`, `small`, `medium`, `large`; empty when there are none (e.g. SVG)." } }, "required": [ "url", "mime", "width", "height", "formats" ], "additionalProperties": false }, { "type": "null" } ], "description": "Featured image with its renditions, when present." }, "variants": { "type": "array", "items": { "type": "object", "properties": { "device_model_variant_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the variant." }, "color_name": { "description": "Variant color axis.", "type": [ "string", "null" ] }, "style_name": { "description": "Variant style axis.", "type": [ "string", "null" ] }, "primary_color_hex": { "description": "Primary color as a hex value, when recorded.", "type": [ "string", "null" ] }, "manufacturer_model_id": { "description": "Manufacturer's own model identifier, when recorded.", "type": [ "string", "null" ] }, "images": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "url": { "type": "string", "description": "Public URL of this rendition." }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." } }, "required": [ "url", "width", "height" ], "additionalProperties": false }, "description": "Smaller renditions present for this image, keyed `thumbnail`, `small`, `medium`, `large`; empty when there are none (e.g. SVG)." } }, "required": [ "url", "mime", "width", "height", "formats" ], "additionalProperties": false }, "description": "Images of this variant." }, "asin": { "description": "Amazon ASIN, when recorded. Only with `include=commerce`.", "type": [ "string", "null" ] }, "gtins": { "description": "GTIN values verbatim from the source. Only with `include=commerce`.", "anyOf": [ { "$ref": "#/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema3" }, { "type": "null" } ] }, "marketplace_listings": { "description": "Marketplace listing data verbatim from the source. Only with `include=commerce`.", "anyOf": [ { "$ref": "#/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema4" }, { "type": "null" } ] } }, "required": [ "device_model_variant_id", "color_name", "style_name", "primary_color_hex", "manufacturer_model_id", "images" ], "additionalProperties": false }, "description": "Variants in source order, each with its images." }, "providers": { "type": "array", "items": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name" ], "additionalProperties": false }, "description": "Providers that can create accesses on this model." }, "capabilities_by_provider": { "type": "array", "items": { "type": "object", "properties": { "provider": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name" ], "additionalProperties": false, "description": "Provider the capabilities belong to." }, "capabilities": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "device_connectivity", "can_program_online_access_codes", "can_program_offline_access_codes", "can_remotely_unlock", "can_remotely_lock", "can_encode_plastic_cards", "can_assign_plastic_cards", "can_provision_mobile_keys", "can_provision_wallet_keys", "can_hvac_cool", "can_hvac_heat", "can_hvac_auto", "can_hvac_fan", "can_program_thermostat_weekly_programs", "can_monitor" ], "description": "Capability name." }, "supported": { "type": "string", "enum": [ "yes", "no", "conditionally" ], "description": "Computed support: `yes`, `no`, or `conditionally`." }, "integration_support_level": { "anyOf": [ { "type": "string", "enum": [ "inquire", "unavailable", "planned", "in-progress", "beta", "stable" ] }, { "type": "null" } ], "description": "Support level of the provider integration behind this capability; null where the source has none." }, "report": { "anyOf": [ { "type": "object", "properties": { "details": { "type": "string", "description": "Report detail text, or a translation dictionary key in `report_raw`." }, "requirements": { "description": "Requirements keyed by requirement name.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "message": { "type": "string", "description": "Requirement message, or a translation dictionary key in `report_raw`." }, "device_slugs": { "description": "Device model slugs satisfying this requirement.", "type": "array", "items": { "type": "string" } } }, "required": [ "message" ], "additionalProperties": {} } }, "dependencies": { "description": "Capability names this report depends on.", "type": "array", "items": { "type": "string" } } }, "required": [ "details" ], "additionalProperties": {} }, { "type": "null" } ], "description": "Report with `details` and requirement messages resolved for the requested `locale`; null when none is stored." } }, "required": [ "name", "supported", "integration_support_level", "report" ], "additionalProperties": false }, "description": "Computed capabilities for that provider." } }, "required": [ "provider", "capabilities" ], "additionalProperties": false }, "description": "Currently published computed capabilities grouped by provider; stale scopes are omitted." }, "capabilities_stale": { "type": "boolean", "description": "True when some provider scope's capabilities are omitted until they are recomputed." }, "shop_listings": { "description": "Commerce listing data verbatim from the source. Only with `include=commerce`.", "anyOf": [ { "$ref": "#/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema5" }, { "type": "null" } ] }, "last_commerce_search_at": { "description": "When commerce listings were last searched. Only with `include=commerce`.", "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "device_model_id", "slug", "display_name", "description_md", "product_url", "no_longer_sold", "is_forbidden_to_3dparty", "manufacturer", "device_type", "device_type_properties", "featured_image", "variants", "providers", "capabilities_by_provider", "capabilities_stale", "updated_at" ], "additionalProperties": false }, "description": "Published device models, ordered by slug, in the slim summary shape." }, "pagination": { "type": "object", "properties": { "has_next_page": { "type": "boolean", "description": "Whether another page of device models follows." }, "next_page_cursor": { "description": "Pass as `page_cursor` for the next page of device models; null on the last page.", "type": [ "string", "null" ] } }, "required": [ "has_next_page", "next_page_cursor" ], "additionalProperties": false, "description": "Pagination of `device_models`; every other field is the same on every page." }, "locale": { "type": "string", "description": "The locale capability reports were resolved in, after fallback." } }, "required": [ "manufacturer", "providers", "compatibility", "device_models", "pagination", "locale" ], "additionalProperties": false, "description": "The manufacturer's published content." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "manufacturer_content", "ok" ], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema0" } } ] }, "__schema1": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema1" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema1" } } ] }, "__schema2": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema2" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema2" } } ] }, "__schema3": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema3" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema3" } } ] }, "__schema4": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema4" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema4" } } ] }, "__schema5": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema5" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema5" } } ] } } } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "parameters": [ { "name": "manufacturer_slug", "in": "query", "required": false, "schema": { "description": "Manufacturer slug. Optional with a manufacturer key, which implies its own; required otherwise.", "type": "string" } }, { "name": "locale", "in": "query", "required": false, "schema": { "description": "Locale for resolved capability report text; unknown locales fall back to the default locale.", "type": "string" } }, { "name": "include", "in": "query", "required": false, "schema": { "description": "Optional device model data to add: `commerce` adds marketplace and shop listings, ASINs and GTINs.", "type": "array", "items": { "type": "string", "enum": [ "commerce" ] } } }, { "name": "include_forbidden", "in": "query", "required": false, "schema": { "description": "Include models forbidden to third parties (`is_forbidden_to_3dparty`): all of them for Seam callers, its own for a manufacturer secret key, none otherwise. Defaults to false.", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 500, "description": "Maximum number of device models to return (1-500).", "type": "integer", "minimum": 1, "maximum": 500 } }, { "name": "page_cursor", "in": "query", "required": false, "schema": { "description": "The `pagination.next_page_cursor` from the previous page.", "type": "string" } } ] }, "post": { "summary": "Get a manufacturer's content", "description": "Returns everything Seam publishes about one manufacturer in one call: the profile (name, description, links, logos), its published device models in the summary shape with capabilities per provider, the providers that cover the brand with their integration support levels, and the live partner apps that support it in each device category (declared-first, like `/compatibility`, including support declared for a provider that serves the brand). With a manufacturer key (secret or embed), the manufacturer is implied and `manufacturer_slug` is optional; naming another manufacturer fails with 403 `manufacturer_mismatch`. Without one, name the manufacturer with `manufacturer_slug`. Device models hidden from third parties are excluded; with the manufacturer's secret key, `include_forbidden` adds them. Device models are paged by slug with `limit` and `page_cursor`; every other field is the same on every page.", "tags": [ "manufacturers" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "manufacturer_content": { "type": "object", "properties": { "manufacturer": { "type": "object", "properties": { "manufacturer_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the manufacturer." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `schlage`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] }, "website": { "description": "Website URL, when recorded.", "type": [ "string", "null" ] }, "headquarters": { "description": "Headquarters location, when recorded.", "type": [ "string", "null" ] }, "country_of_origin": { "description": "Country of origin, when recorded.", "type": [ "string", "null" ] }, "parent_org": { "description": "Parent organization or brand the manufacturer is sold under.", "type": [ "string", "null" ] }, "inc_date": { "description": "Incorporation year as recorded in the source, not a date.", "type": [ "string", "null" ] }, "customer_support_phone": { "description": "Customer support phone, when recorded.", "type": [ "string", "null" ] }, "customer_support_email": { "description": "Customer support email, when recorded.", "type": [ "string", "null" ] }, "customer_support_url": { "description": "Customer support URL, when recorded.", "type": [ "string", "null" ] }, "description_md": { "description": "Description in markdown, when recorded.", "type": [ "string", "null" ] }, "seam_api_guide": { "description": "Seam API guide reference, when recorded.", "type": [ "string", "null" ] }, "commerce_footprint": { "anyOf": [ { "$ref": "#/paths/~1manufacturer_content~1get/post/responses/200/content/application~1json/schema/$defs/__schema0" }, { "type": "null" } ], "description": "Commerce footprint verbatim from the source; null where the source holds none." }, "last_commerce_search_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ], "description": "When commerce listings were last searched; null is a recorded fact, not an omission." }, "logos": { "type": "array", "items": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Square and horizontal logos in color and monochrome variants." }, "default_device_images": { "type": "array", "items": { "type": "object", "properties": { "device_type": { "type": "object", "properties": { "device_type_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device type." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `smartlock`." }, "display_name": { "type": "string", "description": "Display name." }, "is_accessory": { "type": "boolean", "description": "Accessory types (bridges, keypads) rather than primary devices." } }, "required": [ "device_type_id", "slug", "display_name", "is_accessory" ], "additionalProperties": false, "description": "Device type this fallback image applies to." }, "asset": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false, "description": "Fallback image asset for that device type." } }, "required": [ "device_type", "asset" ], "additionalProperties": false }, "description": "Fallback device image per device type." }, "providers": { "type": "array", "items": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name" ], "additionalProperties": false }, "description": "Providers this manufacturer's devices integrate with." }, "device_model_count": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Number of published device models for this manufacturer that the caller may list. Models forbidden to third parties count only for Seam callers, and for a manufacturer secret key only its own." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "manufacturer_id", "slug", "display_name", "website", "headquarters", "country_of_origin", "parent_org", "inc_date", "customer_support_phone", "customer_support_email", "customer_support_url", "description_md", "seam_api_guide", "commerce_footprint", "last_commerce_search_at", "logos", "default_device_images", "providers", "device_model_count", "created_at", "updated_at" ], "additionalProperties": false, "description": "The manufacturer profile: name, description, links, logos and default device images. `device_model_count` counts the device models this caller is shown." }, "providers": { "type": "array", "items": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] }, "description_md": { "description": "Description in markdown, when recorded.", "type": [ "string", "null" ] }, "is_acs": { "description": "Access control system provider; null where not established.", "type": [ "boolean", "null" ] }, "has_requirements": { "description": "Whether integration requirements apply; null where not established.", "type": [ "boolean", "null" ] }, "requirements_md": { "description": "Free-text integration requirements, verbatim from the source.", "type": [ "string", "null" ] }, "logos": { "type": "array", "items": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Square logos in color and monochrome variants." }, "integrations": { "type": "array", "items": { "type": "object", "properties": { "provider_integration_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the integration." }, "kind": { "type": "string", "enum": [ "access", "climate", "sensor" ], "description": "Integration kind: `access`, `climate`, or `sensor`." }, "feature": { "type": "string", "description": "Integration feature, e.g. `lock_unlock` or `hvac`." }, "integration_support_level": { "anyOf": [ { "type": "string", "enum": [ "inquire", "unavailable", "planned", "in-progress", "beta", "stable" ] }, { "type": "null" } ], "description": "Support level for this feature; null where the source has none." }, "flags": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "boolean", "null" ] }, "description": "Per-feature capability flags exactly as authored; null means not established by research." }, "extra_info": { "anyOf": [ { "$ref": "#/paths/~1manufacturer_content~1get/post/responses/200/content/application~1json/schema/$defs/__schema1" }, { "type": "null" } ], "description": "Additional integration data verbatim from the source." } }, "required": [ "provider_integration_id", "kind", "feature", "integration_support_level", "flags", "extra_info" ], "additionalProperties": false }, "description": "One entry per integration feature with its support level and flags." }, "industries": { "type": "array", "items": { "type": "object", "properties": { "industry_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the industry." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `short-term-rental`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] } }, "required": [ "industry_id", "slug", "display_name", "short_name" ], "additionalProperties": false }, "description": "Industries this provider serves." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." }, "device_model_count": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "How many of this manufacturer's device models the caller may see (across every page) the provider covers; 0 for a provider linked only to the manufacturer." } }, "required": [ "provider_id", "slug", "display_name", "description_md", "is_acs", "has_requirements", "requirements_md", "logos", "integrations", "industries", "created_at", "updated_at", "device_model_count" ], "additionalProperties": false }, "description": "Providers (integration paths) that cover the brand: linked to the manufacturer or to any of its device models the caller may see, with their integrations and support levels." }, "compatibility": { "type": "array", "items": { "type": "object", "properties": { "device_category": { "type": "string", "description": "Device category, the slug of a primary device type the manufacturer has models in, e.g. `smartlock`." }, "partners": { "type": "array", "items": { "type": "object", "properties": { "partner_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the partner." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `hospitable`." }, "display_name": { "type": "string", "description": "Display name." }, "website": { "description": "Website URL, when recorded.", "type": [ "string", "null" ] }, "description_md": { "description": "Markdown description written by Seam or the partner.", "type": [ "string", "null" ] }, "is_live": { "type": "boolean", "description": "The partner's Seam integration is live for its customers." }, "is_featured": { "type": "boolean", "description": "Featured by Seam in partner listings." }, "legacy_industry_featured": { "type": "boolean", "description": "Legacy per-industry featured flag; use `is_featured`." }, "industries": { "type": "array", "items": { "type": "object", "properties": { "industry_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the industry." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `short-term-rental`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] } }, "required": [ "industry_id", "slug", "display_name", "short_name" ], "additionalProperties": false }, "description": "Industries the partner serves." }, "markets": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Countries the partner sells in, as ISO 3166-1 alpha-2 codes; null when unknown." }, "solutions": { "type": "array", "items": { "type": "object", "properties": { "solution_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the solution." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `property-management-system`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "software", "service" ], "description": "`software` or `service`." } }, "required": [ "solution_id", "slug", "display_name", "short_name", "type" ], "additionalProperties": false }, "description": "Kinds of software or service the partner offers." }, "assets": { "type": "array", "items": { "type": "object", "properties": { "partner_asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "product_image" ], "description": "Logo kind or `product_image`." }, "url": { "type": "string", "format": "uri", "description": "Public URL of the asset." }, "mime": { "type": "string", "description": "Media type." }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Display order within the partner." } }, "required": [ "partner_asset_id", "kind", "url", "mime", "width", "height", "sort_order" ], "additionalProperties": false }, "description": "Logos and product images in display order." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." }, "support": { "type": "object", "properties": { "supported": { "type": "boolean", "description": "Whether the partner is listed for the requested scope." }, "resolved_level": { "anyOf": [ { "type": "string", "enum": [ "device_category", "manufacturer", "provider", "capability" ] }, { "type": "null" } ], "description": "The most specific level with a declaration that decided the outcome; null when nothing is declared. `provider` with `via_provider_slug` when a manufacturer was resolved through a provider that serves it." }, "declared_status": { "anyOf": [ { "type": "string", "enum": [ "enabled", "disabled", "not_via_seam" ] }, { "type": "null" } ], "description": "The deciding declaration: `enabled`, `disabled` or `not_via_seam`." }, "observed_status": { "anyOf": [ { "type": "string", "enum": [ "active", "trace", "none", "unknown" ] }, { "type": "null" } ], "description": "What the nightly usage sync observed at that scope; informational only." }, "note": { "description": "Note recorded with the deciding declaration, when any.", "type": [ "string", "null" ] }, "via_provider_slug": { "description": "Present when the deciding declaration was made for a provider the query did not name: a provider serving the requested manufacturer's devices (e.g. `tt-lock` for Sifely), or the provider backing the requested one (e.g. `tt-lock` for `33-lock`).", "type": "string" } }, "required": [ "supported", "resolved_level", "declared_status", "observed_status", "note" ], "additionalProperties": false, "description": "How the support matrix resolved for this category and manufacturer, with the partner's note." } }, "required": [ "partner_id", "slug", "display_name", "website", "description_md", "is_live", "is_featured", "legacy_industry_featured", "industries", "markets", "solutions", "assets", "created_at", "updated_at", "support" ], "additionalProperties": false }, "description": "Live partners that support this manufacturer's devices in this category, resolved declared-first exactly like `/compatibility`, including support declared for a provider that serves the manufacturer." } }, "required": [ "device_category", "partners" ], "additionalProperties": false }, "description": "Compatible partners per device category the manufacturer has published primary device models in." }, "device_models": { "type": "array", "items": { "type": "object", "properties": { "device_model_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device model." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `encodeplus`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] }, "description_md": { "description": "Description in markdown, when recorded.", "type": [ "string", "null" ] }, "product_url": { "description": "Manufacturer product page URL, when recorded.", "type": [ "string", "null" ] }, "no_longer_sold": { "description": "Whether the model is no longer sold; null where not established.", "type": [ "boolean", "null" ] }, "is_forbidden_to_3dparty": { "description": "Forbidden to third-party consumers; such models appear only for callers allowed to set `include_forbidden`.", "type": [ "boolean", "null" ] }, "manufacturer": { "anyOf": [ { "type": "object", "properties": { "manufacturer_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the manufacturer." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `schlage`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "manufacturer_id", "slug", "display_name" ], "additionalProperties": false }, { "type": "null" } ], "description": "Pinned published manufacturer, when set." }, "device_type": { "anyOf": [ { "type": "object", "properties": { "device_type_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device type." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `smartlock`." }, "display_name": { "type": "string", "description": "Display name." }, "is_accessory": { "type": "boolean", "description": "Accessory types (bridges, keypads) rather than primary devices." } }, "required": [ "device_type_id", "slug", "display_name", "is_accessory" ], "additionalProperties": false }, { "type": "null" } ], "description": "Pinned published device type, when set." }, "device_type_properties": { "anyOf": [ { "$ref": "#/paths/~1manufacturer_content~1get/post/responses/200/content/application~1json/schema/$defs/__schema2" }, { "type": "null" } ], "description": "Per-device-type properties verbatim, including the source component discriminator; null for accessory types." }, "featured_image": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "url": { "type": "string", "description": "Public URL of this rendition." }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." } }, "required": [ "url", "width", "height" ], "additionalProperties": false }, "description": "Smaller renditions present for this image, keyed `thumbnail`, `small`, `medium`, `large`; empty when there are none (e.g. SVG)." } }, "required": [ "url", "mime", "width", "height", "formats" ], "additionalProperties": false }, { "type": "null" } ], "description": "Featured image with its renditions, when present." }, "variants": { "type": "array", "items": { "type": "object", "properties": { "device_model_variant_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the variant." }, "color_name": { "description": "Variant color axis.", "type": [ "string", "null" ] }, "style_name": { "description": "Variant style axis.", "type": [ "string", "null" ] }, "primary_color_hex": { "description": "Primary color as a hex value, when recorded.", "type": [ "string", "null" ] }, "manufacturer_model_id": { "description": "Manufacturer's own model identifier, when recorded.", "type": [ "string", "null" ] }, "images": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "url": { "type": "string", "description": "Public URL of this rendition." }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." } }, "required": [ "url", "width", "height" ], "additionalProperties": false }, "description": "Smaller renditions present for this image, keyed `thumbnail`, `small`, `medium`, `large`; empty when there are none (e.g. SVG)." } }, "required": [ "url", "mime", "width", "height", "formats" ], "additionalProperties": false }, "description": "Images of this variant." }, "asin": { "description": "Amazon ASIN, when recorded. Only with `include=commerce`.", "type": [ "string", "null" ] }, "gtins": { "description": "GTIN values verbatim from the source. Only with `include=commerce`.", "anyOf": [ { "$ref": "#/paths/~1manufacturer_content~1get/post/responses/200/content/application~1json/schema/$defs/__schema3" }, { "type": "null" } ] }, "marketplace_listings": { "description": "Marketplace listing data verbatim from the source. Only with `include=commerce`.", "anyOf": [ { "$ref": "#/paths/~1manufacturer_content~1get/post/responses/200/content/application~1json/schema/$defs/__schema4" }, { "type": "null" } ] } }, "required": [ "device_model_variant_id", "color_name", "style_name", "primary_color_hex", "manufacturer_model_id", "images" ], "additionalProperties": false }, "description": "Variants in source order, each with its images." }, "providers": { "type": "array", "items": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name" ], "additionalProperties": false }, "description": "Providers that can create accesses on this model." }, "capabilities_by_provider": { "type": "array", "items": { "type": "object", "properties": { "provider": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name" ], "additionalProperties": false, "description": "Provider the capabilities belong to." }, "capabilities": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "device_connectivity", "can_program_online_access_codes", "can_program_offline_access_codes", "can_remotely_unlock", "can_remotely_lock", "can_encode_plastic_cards", "can_assign_plastic_cards", "can_provision_mobile_keys", "can_provision_wallet_keys", "can_hvac_cool", "can_hvac_heat", "can_hvac_auto", "can_hvac_fan", "can_program_thermostat_weekly_programs", "can_monitor" ], "description": "Capability name." }, "supported": { "type": "string", "enum": [ "yes", "no", "conditionally" ], "description": "Computed support: `yes`, `no`, or `conditionally`." }, "integration_support_level": { "anyOf": [ { "type": "string", "enum": [ "inquire", "unavailable", "planned", "in-progress", "beta", "stable" ] }, { "type": "null" } ], "description": "Support level of the provider integration behind this capability; null where the source has none." }, "report": { "anyOf": [ { "type": "object", "properties": { "details": { "type": "string", "description": "Report detail text, or a translation dictionary key in `report_raw`." }, "requirements": { "description": "Requirements keyed by requirement name.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "message": { "type": "string", "description": "Requirement message, or a translation dictionary key in `report_raw`." }, "device_slugs": { "description": "Device model slugs satisfying this requirement.", "type": "array", "items": { "type": "string" } } }, "required": [ "message" ], "additionalProperties": {} } }, "dependencies": { "description": "Capability names this report depends on.", "type": "array", "items": { "type": "string" } } }, "required": [ "details" ], "additionalProperties": {} }, { "type": "null" } ], "description": "Report with `details` and requirement messages resolved for the requested `locale`; null when none is stored." } }, "required": [ "name", "supported", "integration_support_level", "report" ], "additionalProperties": false }, "description": "Computed capabilities for that provider." } }, "required": [ "provider", "capabilities" ], "additionalProperties": false }, "description": "Currently published computed capabilities grouped by provider; stale scopes are omitted." }, "capabilities_stale": { "type": "boolean", "description": "True when some provider scope's capabilities are omitted until they are recomputed." }, "shop_listings": { "description": "Commerce listing data verbatim from the source. Only with `include=commerce`.", "anyOf": [ { "$ref": "#/paths/~1manufacturer_content~1get/post/responses/200/content/application~1json/schema/$defs/__schema5" }, { "type": "null" } ] }, "last_commerce_search_at": { "description": "When commerce listings were last searched. Only with `include=commerce`.", "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "device_model_id", "slug", "display_name", "description_md", "product_url", "no_longer_sold", "is_forbidden_to_3dparty", "manufacturer", "device_type", "device_type_properties", "featured_image", "variants", "providers", "capabilities_by_provider", "capabilities_stale", "updated_at" ], "additionalProperties": false }, "description": "Published device models, ordered by slug, in the slim summary shape." }, "pagination": { "type": "object", "properties": { "has_next_page": { "type": "boolean", "description": "Whether another page of device models follows." }, "next_page_cursor": { "description": "Pass as `page_cursor` for the next page of device models; null on the last page.", "type": [ "string", "null" ] } }, "required": [ "has_next_page", "next_page_cursor" ], "additionalProperties": false, "description": "Pagination of `device_models`; every other field is the same on every page." }, "locale": { "type": "string", "description": "The locale capability reports were resolved in, after fallback." } }, "required": [ "manufacturer", "providers", "compatibility", "device_models", "pagination", "locale" ], "additionalProperties": false, "description": "The manufacturer's published content." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "manufacturer_content", "ok" ], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1manufacturer_content~1get/post/responses/200/content/application~1json/schema/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1manufacturer_content~1get/post/responses/200/content/application~1json/schema/$defs/__schema0" } } ] }, "__schema1": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1manufacturer_content~1get/post/responses/200/content/application~1json/schema/$defs/__schema1" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1manufacturer_content~1get/post/responses/200/content/application~1json/schema/$defs/__schema1" } } ] }, "__schema2": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1manufacturer_content~1get/post/responses/200/content/application~1json/schema/$defs/__schema2" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1manufacturer_content~1get/post/responses/200/content/application~1json/schema/$defs/__schema2" } } ] }, "__schema3": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1manufacturer_content~1get/post/responses/200/content/application~1json/schema/$defs/__schema3" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1manufacturer_content~1get/post/responses/200/content/application~1json/schema/$defs/__schema3" } } ] }, "__schema4": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1manufacturer_content~1get/post/responses/200/content/application~1json/schema/$defs/__schema4" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1manufacturer_content~1get/post/responses/200/content/application~1json/schema/$defs/__schema4" } } ] }, "__schema5": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1manufacturer_content~1get/post/responses/200/content/application~1json/schema/$defs/__schema5" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1manufacturer_content~1get/post/responses/200/content/application~1json/schema/$defs/__schema5" } } ] } } } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "manufacturer_slug": { "description": "Manufacturer slug. Optional with a manufacturer key, which implies its own; required otherwise.", "type": "string" }, "locale": { "description": "Locale for resolved capability report text; unknown locales fall back to the default locale.", "type": "string" }, "include": { "description": "Optional device model data to add: `commerce` adds marketplace and shop listings, ASINs and GTINs.", "type": "array", "items": { "type": "string", "enum": [ "commerce" ] } }, "include_forbidden": { "description": "Include models forbidden to third parties (`is_forbidden_to_3dparty`): all of them for Seam callers, its own for a manufacturer secret key, none otherwise. Defaults to false.", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] }, "limit": { "default": 500, "description": "Maximum number of device models to return (1-500).", "type": "integer", "minimum": 1, "maximum": 500 }, "page_cursor": { "description": "The `pagination.next_page_cursor` from the previous page.", "type": "string" } } } } } } } }, "/manufacturers/get": { "get": { "summary": "Get a manufacturer", "description": "Returns one published manufacturer by `slug` or `manufacturer_id`, with logos, default device images, providers and its device model count. `device_model_count` counts only the device models the caller can see: models hidden from third parties count only for their manufacturer's secret key.", "tags": [ "manufacturers" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "manufacturer": { "type": "object", "properties": { "manufacturer_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the manufacturer." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `schlage`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] }, "website": { "description": "Website URL, when recorded.", "type": [ "string", "null" ] }, "headquarters": { "description": "Headquarters location, when recorded.", "type": [ "string", "null" ] }, "country_of_origin": { "description": "Country of origin, when recorded.", "type": [ "string", "null" ] }, "parent_org": { "description": "Parent organization or brand the manufacturer is sold under.", "type": [ "string", "null" ] }, "inc_date": { "description": "Incorporation year as recorded in the source, not a date.", "type": [ "string", "null" ] }, "customer_support_phone": { "description": "Customer support phone, when recorded.", "type": [ "string", "null" ] }, "customer_support_email": { "description": "Customer support email, when recorded.", "type": [ "string", "null" ] }, "customer_support_url": { "description": "Customer support URL, when recorded.", "type": [ "string", "null" ] }, "description_md": { "description": "Description in markdown, when recorded.", "type": [ "string", "null" ] }, "seam_api_guide": { "description": "Seam API guide reference, when recorded.", "type": [ "string", "null" ] }, "commerce_footprint": { "anyOf": [ { "$ref": "#/paths/~1manufacturers~1get/get/responses/200/content/application~1json/schema/$defs/__schema0" }, { "type": "null" } ], "description": "Commerce footprint verbatim from the source; null where the source holds none." }, "last_commerce_search_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ], "description": "When commerce listings were last searched; null is a recorded fact, not an omission." }, "logos": { "type": "array", "items": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Square and horizontal logos in color and monochrome variants." }, "default_device_images": { "type": "array", "items": { "type": "object", "properties": { "device_type": { "type": "object", "properties": { "device_type_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device type." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `smartlock`." }, "display_name": { "type": "string", "description": "Display name." }, "is_accessory": { "type": "boolean", "description": "Accessory types (bridges, keypads) rather than primary devices." } }, "required": [ "device_type_id", "slug", "display_name", "is_accessory" ], "additionalProperties": false, "description": "Device type this fallback image applies to." }, "asset": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false, "description": "Fallback image asset for that device type." } }, "required": [ "device_type", "asset" ], "additionalProperties": false }, "description": "Fallback device image per device type." }, "providers": { "type": "array", "items": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name" ], "additionalProperties": false }, "description": "Providers this manufacturer's devices integrate with." }, "device_model_count": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Number of published device models for this manufacturer that the caller may list. Models forbidden to third parties count only for Seam callers, and for a manufacturer secret key only its own." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "manufacturer_id", "slug", "display_name", "website", "headquarters", "country_of_origin", "parent_org", "inc_date", "customer_support_phone", "customer_support_email", "customer_support_url", "description_md", "seam_api_guide", "commerce_footprint", "last_commerce_search_at", "logos", "default_device_images", "providers", "device_model_count", "created_at", "updated_at" ], "additionalProperties": false, "description": "The published manufacturer." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "manufacturer", "ok" ], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1manufacturers~1get/get/responses/200/content/application~1json/schema/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1manufacturers~1get/get/responses/200/content/application~1json/schema/$defs/__schema0" } } ] } } } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "parameters": [ { "name": "slug", "in": "query", "required": false, "schema": { "description": "Manufacturer slug; provide this or `manufacturer_id`.", "type": "string" } }, { "name": "manufacturer_id", "in": "query", "required": false, "schema": { "description": "Manufacturer UUID; provide this or `slug`.", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ] }, "post": { "summary": "Get a manufacturer", "description": "Returns one published manufacturer by `slug` or `manufacturer_id`, with logos, default device images, providers and its device model count. `device_model_count` counts only the device models the caller can see: models hidden from third parties count only for their manufacturer's secret key.", "tags": [ "manufacturers" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "manufacturer": { "type": "object", "properties": { "manufacturer_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the manufacturer." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `schlage`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] }, "website": { "description": "Website URL, when recorded.", "type": [ "string", "null" ] }, "headquarters": { "description": "Headquarters location, when recorded.", "type": [ "string", "null" ] }, "country_of_origin": { "description": "Country of origin, when recorded.", "type": [ "string", "null" ] }, "parent_org": { "description": "Parent organization or brand the manufacturer is sold under.", "type": [ "string", "null" ] }, "inc_date": { "description": "Incorporation year as recorded in the source, not a date.", "type": [ "string", "null" ] }, "customer_support_phone": { "description": "Customer support phone, when recorded.", "type": [ "string", "null" ] }, "customer_support_email": { "description": "Customer support email, when recorded.", "type": [ "string", "null" ] }, "customer_support_url": { "description": "Customer support URL, when recorded.", "type": [ "string", "null" ] }, "description_md": { "description": "Description in markdown, when recorded.", "type": [ "string", "null" ] }, "seam_api_guide": { "description": "Seam API guide reference, when recorded.", "type": [ "string", "null" ] }, "commerce_footprint": { "anyOf": [ { "$ref": "#/paths/~1manufacturers~1get/post/responses/200/content/application~1json/schema/$defs/__schema0" }, { "type": "null" } ], "description": "Commerce footprint verbatim from the source; null where the source holds none." }, "last_commerce_search_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ], "description": "When commerce listings were last searched; null is a recorded fact, not an omission." }, "logos": { "type": "array", "items": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Square and horizontal logos in color and monochrome variants." }, "default_device_images": { "type": "array", "items": { "type": "object", "properties": { "device_type": { "type": "object", "properties": { "device_type_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device type." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `smartlock`." }, "display_name": { "type": "string", "description": "Display name." }, "is_accessory": { "type": "boolean", "description": "Accessory types (bridges, keypads) rather than primary devices." } }, "required": [ "device_type_id", "slug", "display_name", "is_accessory" ], "additionalProperties": false, "description": "Device type this fallback image applies to." }, "asset": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false, "description": "Fallback image asset for that device type." } }, "required": [ "device_type", "asset" ], "additionalProperties": false }, "description": "Fallback device image per device type." }, "providers": { "type": "array", "items": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name" ], "additionalProperties": false }, "description": "Providers this manufacturer's devices integrate with." }, "device_model_count": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Number of published device models for this manufacturer that the caller may list. Models forbidden to third parties count only for Seam callers, and for a manufacturer secret key only its own." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "manufacturer_id", "slug", "display_name", "website", "headquarters", "country_of_origin", "parent_org", "inc_date", "customer_support_phone", "customer_support_email", "customer_support_url", "description_md", "seam_api_guide", "commerce_footprint", "last_commerce_search_at", "logos", "default_device_images", "providers", "device_model_count", "created_at", "updated_at" ], "additionalProperties": false, "description": "The published manufacturer." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "manufacturer", "ok" ], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1manufacturers~1get/post/responses/200/content/application~1json/schema/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1manufacturers~1get/post/responses/200/content/application~1json/schema/$defs/__schema0" } } ] } } } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "slug": { "description": "Manufacturer slug; provide this or `manufacturer_id`.", "type": "string" }, "manufacturer_id": { "description": "Manufacturer UUID; provide this or `slug`.", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } } } } } } }, "/manufacturers/list": { "get": { "summary": "List manufacturers", "description": "Lists published manufacturers with logos, default device images, providers and device model counts, ordered by slug. `device_model_count` counts only the device models the caller can see: models hidden from third parties count only for their manufacturer's secret key.", "tags": [ "manufacturers" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "manufacturers": { "type": "array", "items": { "type": "object", "properties": { "manufacturer_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the manufacturer." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `schlage`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] }, "website": { "description": "Website URL, when recorded.", "type": [ "string", "null" ] }, "headquarters": { "description": "Headquarters location, when recorded.", "type": [ "string", "null" ] }, "country_of_origin": { "description": "Country of origin, when recorded.", "type": [ "string", "null" ] }, "parent_org": { "description": "Parent organization or brand the manufacturer is sold under.", "type": [ "string", "null" ] }, "inc_date": { "description": "Incorporation year as recorded in the source, not a date.", "type": [ "string", "null" ] }, "customer_support_phone": { "description": "Customer support phone, when recorded.", "type": [ "string", "null" ] }, "customer_support_email": { "description": "Customer support email, when recorded.", "type": [ "string", "null" ] }, "customer_support_url": { "description": "Customer support URL, when recorded.", "type": [ "string", "null" ] }, "description_md": { "description": "Description in markdown, when recorded.", "type": [ "string", "null" ] }, "seam_api_guide": { "description": "Seam API guide reference, when recorded.", "type": [ "string", "null" ] }, "commerce_footprint": { "anyOf": [ { "$ref": "#/paths/~1manufacturers~1list/get/responses/200/content/application~1json/schema/$defs/__schema0" }, { "type": "null" } ], "description": "Commerce footprint verbatim from the source; null where the source holds none." }, "last_commerce_search_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ], "description": "When commerce listings were last searched; null is a recorded fact, not an omission." }, "logos": { "type": "array", "items": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Square and horizontal logos in color and monochrome variants." }, "default_device_images": { "type": "array", "items": { "type": "object", "properties": { "device_type": { "type": "object", "properties": { "device_type_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device type." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `smartlock`." }, "display_name": { "type": "string", "description": "Display name." }, "is_accessory": { "type": "boolean", "description": "Accessory types (bridges, keypads) rather than primary devices." } }, "required": [ "device_type_id", "slug", "display_name", "is_accessory" ], "additionalProperties": false, "description": "Device type this fallback image applies to." }, "asset": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false, "description": "Fallback image asset for that device type." } }, "required": [ "device_type", "asset" ], "additionalProperties": false }, "description": "Fallback device image per device type." }, "providers": { "type": "array", "items": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name" ], "additionalProperties": false }, "description": "Providers this manufacturer's devices integrate with." }, "device_model_count": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Number of published device models for this manufacturer that the caller may list. Models forbidden to third parties count only for Seam callers, and for a manufacturer secret key only its own." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "manufacturer_id", "slug", "display_name", "website", "headquarters", "country_of_origin", "parent_org", "inc_date", "customer_support_phone", "customer_support_email", "customer_support_url", "description_md", "seam_api_guide", "commerce_footprint", "last_commerce_search_at", "logos", "default_device_images", "providers", "device_model_count", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Published manufacturers." }, "pagination": { "type": "object", "properties": { "has_next_page": { "type": "boolean", "description": "Whether another page follows this one." }, "next_page_cursor": { "description": "Cursor for the next page; null on the last page.", "type": [ "string", "null" ] } }, "required": [ "has_next_page", "next_page_cursor" ], "additionalProperties": false, "description": "Pagination for this page." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "manufacturers", "pagination", "ok" ], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1manufacturers~1list/get/responses/200/content/application~1json/schema/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1manufacturers~1list/get/responses/200/content/application~1json/schema/$defs/__schema0" } } ] } } } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "parameters": [ { "name": "slugs", "in": "query", "required": false, "schema": { "description": "Only manufacturers with these slugs.", "type": "array", "items": { "type": "string" } } }, { "name": "provider", "in": "query", "required": false, "schema": { "description": "Provider slug.", "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 100, "description": "Maximum number of manufacturers to return (1-500).", "type": "integer", "minimum": 1, "maximum": 500 } }, { "name": "page_cursor", "in": "query", "required": false, "schema": { "description": "The `next_page_cursor` from the previous page.", "type": "string" } } ] }, "post": { "summary": "List manufacturers", "description": "Lists published manufacturers with logos, default device images, providers and device model counts, ordered by slug. `device_model_count` counts only the device models the caller can see: models hidden from third parties count only for their manufacturer's secret key.", "tags": [ "manufacturers" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "manufacturers": { "type": "array", "items": { "type": "object", "properties": { "manufacturer_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the manufacturer." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `schlage`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] }, "website": { "description": "Website URL, when recorded.", "type": [ "string", "null" ] }, "headquarters": { "description": "Headquarters location, when recorded.", "type": [ "string", "null" ] }, "country_of_origin": { "description": "Country of origin, when recorded.", "type": [ "string", "null" ] }, "parent_org": { "description": "Parent organization or brand the manufacturer is sold under.", "type": [ "string", "null" ] }, "inc_date": { "description": "Incorporation year as recorded in the source, not a date.", "type": [ "string", "null" ] }, "customer_support_phone": { "description": "Customer support phone, when recorded.", "type": [ "string", "null" ] }, "customer_support_email": { "description": "Customer support email, when recorded.", "type": [ "string", "null" ] }, "customer_support_url": { "description": "Customer support URL, when recorded.", "type": [ "string", "null" ] }, "description_md": { "description": "Description in markdown, when recorded.", "type": [ "string", "null" ] }, "seam_api_guide": { "description": "Seam API guide reference, when recorded.", "type": [ "string", "null" ] }, "commerce_footprint": { "anyOf": [ { "$ref": "#/paths/~1manufacturers~1list/post/responses/200/content/application~1json/schema/$defs/__schema0" }, { "type": "null" } ], "description": "Commerce footprint verbatim from the source; null where the source holds none." }, "last_commerce_search_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ], "description": "When commerce listings were last searched; null is a recorded fact, not an omission." }, "logos": { "type": "array", "items": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Square and horizontal logos in color and monochrome variants." }, "default_device_images": { "type": "array", "items": { "type": "object", "properties": { "device_type": { "type": "object", "properties": { "device_type_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the device type." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `smartlock`." }, "display_name": { "type": "string", "description": "Display name." }, "is_accessory": { "type": "boolean", "description": "Accessory types (bridges, keypads) rather than primary devices." } }, "required": [ "device_type_id", "slug", "display_name", "is_accessory" ], "additionalProperties": false, "description": "Device type this fallback image applies to." }, "asset": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false, "description": "Fallback image asset for that device type." } }, "required": [ "device_type", "asset" ], "additionalProperties": false }, "description": "Fallback device image per device type." }, "providers": { "type": "array", "items": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name" ], "additionalProperties": false }, "description": "Providers this manufacturer's devices integrate with." }, "device_model_count": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Number of published device models for this manufacturer that the caller may list. Models forbidden to third parties count only for Seam callers, and for a manufacturer secret key only its own." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "manufacturer_id", "slug", "display_name", "website", "headquarters", "country_of_origin", "parent_org", "inc_date", "customer_support_phone", "customer_support_email", "customer_support_url", "description_md", "seam_api_guide", "commerce_footprint", "last_commerce_search_at", "logos", "default_device_images", "providers", "device_model_count", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Published manufacturers." }, "pagination": { "type": "object", "properties": { "has_next_page": { "type": "boolean", "description": "Whether another page follows this one." }, "next_page_cursor": { "description": "Cursor for the next page; null on the last page.", "type": [ "string", "null" ] } }, "required": [ "has_next_page", "next_page_cursor" ], "additionalProperties": false, "description": "Pagination for this page." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "manufacturers", "pagination", "ok" ], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1manufacturers~1list/post/responses/200/content/application~1json/schema/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1manufacturers~1list/post/responses/200/content/application~1json/schema/$defs/__schema0" } } ] } } } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "slugs": { "description": "Only manufacturers with these slugs.", "type": "array", "items": { "type": "string" } }, "provider": { "description": "Provider slug.", "type": "string" }, "limit": { "default": 100, "description": "Maximum number of manufacturers to return (1-500).", "type": "integer", "minimum": 1, "maximum": 500 }, "page_cursor": { "description": "The `next_page_cursor` from the previous page.", "type": "string" } } } } } } } }, "/partners/get": { "get": { "summary": "Get a partner", "description": "Returns one published partner by slug or partner_id.", "tags": [ "partners" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "partner": { "type": "object", "properties": { "partner_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the partner." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `hospitable`." }, "display_name": { "type": "string", "description": "Display name." }, "website": { "description": "Website URL, when recorded.", "type": [ "string", "null" ] }, "description_md": { "description": "Markdown description written by Seam or the partner.", "type": [ "string", "null" ] }, "is_live": { "type": "boolean", "description": "The partner's Seam integration is live for its customers." }, "is_featured": { "type": "boolean", "description": "Featured by Seam in partner listings." }, "legacy_industry_featured": { "type": "boolean", "description": "Legacy per-industry featured flag; use `is_featured`." }, "industries": { "type": "array", "items": { "type": "object", "properties": { "industry_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the industry." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `short-term-rental`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] } }, "required": [ "industry_id", "slug", "display_name", "short_name" ], "additionalProperties": false }, "description": "Industries the partner serves." }, "markets": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Countries the partner sells in, as ISO 3166-1 alpha-2 codes; null when unknown." }, "solutions": { "type": "array", "items": { "type": "object", "properties": { "solution_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the solution." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `property-management-system`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "software", "service" ], "description": "`software` or `service`." } }, "required": [ "solution_id", "slug", "display_name", "short_name", "type" ], "additionalProperties": false }, "description": "Kinds of software or service the partner offers." }, "assets": { "type": "array", "items": { "type": "object", "properties": { "partner_asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "product_image" ], "description": "Logo kind or `product_image`." }, "url": { "type": "string", "format": "uri", "description": "Public URL of the asset." }, "mime": { "type": "string", "description": "Media type." }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Display order within the partner." } }, "required": [ "partner_asset_id", "kind", "url", "mime", "width", "height", "sort_order" ], "additionalProperties": false }, "description": "Logos and product images in display order." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "partner_id", "slug", "display_name", "website", "description_md", "is_live", "is_featured", "legacy_industry_featured", "industries", "markets", "solutions", "assets", "created_at", "updated_at" ], "additionalProperties": false, "description": "The published partner." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "partner", "ok" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [], "parameters": [ { "name": "slug", "in": "query", "required": false, "schema": { "description": "Partner slug; provide this or `partner_id`.", "type": "string" } }, { "name": "partner_id", "in": "query", "required": false, "schema": { "description": "Partner UUID; provide this or `slug`.", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ] }, "post": { "summary": "Get a partner", "description": "Returns one published partner by slug or partner_id.", "tags": [ "partners" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "partner": { "type": "object", "properties": { "partner_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the partner." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `hospitable`." }, "display_name": { "type": "string", "description": "Display name." }, "website": { "description": "Website URL, when recorded.", "type": [ "string", "null" ] }, "description_md": { "description": "Markdown description written by Seam or the partner.", "type": [ "string", "null" ] }, "is_live": { "type": "boolean", "description": "The partner's Seam integration is live for its customers." }, "is_featured": { "type": "boolean", "description": "Featured by Seam in partner listings." }, "legacy_industry_featured": { "type": "boolean", "description": "Legacy per-industry featured flag; use `is_featured`." }, "industries": { "type": "array", "items": { "type": "object", "properties": { "industry_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the industry." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `short-term-rental`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] } }, "required": [ "industry_id", "slug", "display_name", "short_name" ], "additionalProperties": false }, "description": "Industries the partner serves." }, "markets": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Countries the partner sells in, as ISO 3166-1 alpha-2 codes; null when unknown." }, "solutions": { "type": "array", "items": { "type": "object", "properties": { "solution_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the solution." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `property-management-system`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "software", "service" ], "description": "`software` or `service`." } }, "required": [ "solution_id", "slug", "display_name", "short_name", "type" ], "additionalProperties": false }, "description": "Kinds of software or service the partner offers." }, "assets": { "type": "array", "items": { "type": "object", "properties": { "partner_asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "product_image" ], "description": "Logo kind or `product_image`." }, "url": { "type": "string", "format": "uri", "description": "Public URL of the asset." }, "mime": { "type": "string", "description": "Media type." }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Display order within the partner." } }, "required": [ "partner_asset_id", "kind", "url", "mime", "width", "height", "sort_order" ], "additionalProperties": false }, "description": "Logos and product images in display order." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "partner_id", "slug", "display_name", "website", "description_md", "is_live", "is_featured", "legacy_industry_featured", "industries", "markets", "solutions", "assets", "created_at", "updated_at" ], "additionalProperties": false, "description": "The published partner." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "partner", "ok" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "slug": { "description": "Partner slug; provide this or `partner_id`.", "type": "string" }, "partner_id": { "description": "Partner UUID; provide this or `slug`.", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } } } } } } }, "/partners/list": { "get": { "summary": "List partners", "description": "Lists published partners with their industries, solutions and logos. Filters combine with AND. Pages are ordered by slug.", "tags": [ "partners" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "partners": { "type": "array", "items": { "type": "object", "properties": { "partner_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the partner." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `hospitable`." }, "display_name": { "type": "string", "description": "Display name." }, "website": { "description": "Website URL, when recorded.", "type": [ "string", "null" ] }, "description_md": { "description": "Markdown description written by Seam or the partner.", "type": [ "string", "null" ] }, "is_live": { "type": "boolean", "description": "The partner's Seam integration is live for its customers." }, "is_featured": { "type": "boolean", "description": "Featured by Seam in partner listings." }, "legacy_industry_featured": { "type": "boolean", "description": "Legacy per-industry featured flag; use `is_featured`." }, "industries": { "type": "array", "items": { "type": "object", "properties": { "industry_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the industry." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `short-term-rental`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] } }, "required": [ "industry_id", "slug", "display_name", "short_name" ], "additionalProperties": false }, "description": "Industries the partner serves." }, "markets": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Countries the partner sells in, as ISO 3166-1 alpha-2 codes; null when unknown." }, "solutions": { "type": "array", "items": { "type": "object", "properties": { "solution_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the solution." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `property-management-system`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "software", "service" ], "description": "`software` or `service`." } }, "required": [ "solution_id", "slug", "display_name", "short_name", "type" ], "additionalProperties": false }, "description": "Kinds of software or service the partner offers." }, "assets": { "type": "array", "items": { "type": "object", "properties": { "partner_asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "product_image" ], "description": "Logo kind or `product_image`." }, "url": { "type": "string", "format": "uri", "description": "Public URL of the asset." }, "mime": { "type": "string", "description": "Media type." }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Display order within the partner." } }, "required": [ "partner_asset_id", "kind", "url", "mime", "width", "height", "sort_order" ], "additionalProperties": false }, "description": "Logos and product images in display order." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "partner_id", "slug", "display_name", "website", "description_md", "is_live", "is_featured", "legacy_industry_featured", "industries", "markets", "solutions", "assets", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Published partners." }, "pagination": { "type": "object", "properties": { "has_next_page": { "type": "boolean", "description": "Whether another page follows this one." }, "next_page_cursor": { "description": "Cursor for the next page; null on the last page.", "type": [ "string", "null" ] } }, "required": [ "has_next_page", "next_page_cursor" ], "additionalProperties": false, "description": "Pagination for this page." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "partners", "pagination", "ok" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [], "parameters": [ { "name": "slugs", "in": "query", "required": false, "schema": { "description": "Only partners with these slugs.", "type": "array", "items": { "type": "string" } } }, { "name": "partner_ids", "in": "query", "required": false, "schema": { "description": "Only partners with these UUIDs.", "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, { "name": "is_live", "in": "query", "required": false, "schema": { "description": "Filter by whether the partner's Seam integration is live.", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] } }, { "name": "is_featured", "in": "query", "required": false, "schema": { "description": "Filter by whether Seam features the partner.", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] } }, { "name": "industry", "in": "query", "required": false, "schema": { "description": "Industry slug.", "type": "string" } }, { "name": "solution", "in": "query", "required": false, "schema": { "description": "Solution slug.", "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 100, "description": "Maximum number of partners to return (1-500).", "type": "integer", "minimum": 1, "maximum": 500 } }, { "name": "page_cursor", "in": "query", "required": false, "schema": { "description": "The `next_page_cursor` from the previous page.", "type": "string" } } ] }, "post": { "summary": "List partners", "description": "Lists published partners with their industries, solutions and logos. Filters combine with AND. Pages are ordered by slug.", "tags": [ "partners" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "partners": { "type": "array", "items": { "type": "object", "properties": { "partner_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the partner." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `hospitable`." }, "display_name": { "type": "string", "description": "Display name." }, "website": { "description": "Website URL, when recorded.", "type": [ "string", "null" ] }, "description_md": { "description": "Markdown description written by Seam or the partner.", "type": [ "string", "null" ] }, "is_live": { "type": "boolean", "description": "The partner's Seam integration is live for its customers." }, "is_featured": { "type": "boolean", "description": "Featured by Seam in partner listings." }, "legacy_industry_featured": { "type": "boolean", "description": "Legacy per-industry featured flag; use `is_featured`." }, "industries": { "type": "array", "items": { "type": "object", "properties": { "industry_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the industry." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `short-term-rental`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] } }, "required": [ "industry_id", "slug", "display_name", "short_name" ], "additionalProperties": false }, "description": "Industries the partner serves." }, "markets": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Countries the partner sells in, as ISO 3166-1 alpha-2 codes; null when unknown." }, "solutions": { "type": "array", "items": { "type": "object", "properties": { "solution_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the solution." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `property-management-system`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "software", "service" ], "description": "`software` or `service`." } }, "required": [ "solution_id", "slug", "display_name", "short_name", "type" ], "additionalProperties": false }, "description": "Kinds of software or service the partner offers." }, "assets": { "type": "array", "items": { "type": "object", "properties": { "partner_asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "product_image" ], "description": "Logo kind or `product_image`." }, "url": { "type": "string", "format": "uri", "description": "Public URL of the asset." }, "mime": { "type": "string", "description": "Media type." }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Display order within the partner." } }, "required": [ "partner_asset_id", "kind", "url", "mime", "width", "height", "sort_order" ], "additionalProperties": false }, "description": "Logos and product images in display order." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "partner_id", "slug", "display_name", "website", "description_md", "is_live", "is_featured", "legacy_industry_featured", "industries", "markets", "solutions", "assets", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Published partners." }, "pagination": { "type": "object", "properties": { "has_next_page": { "type": "boolean", "description": "Whether another page follows this one." }, "next_page_cursor": { "description": "Cursor for the next page; null on the last page.", "type": [ "string", "null" ] } }, "required": [ "has_next_page", "next_page_cursor" ], "additionalProperties": false, "description": "Pagination for this page." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "partners", "pagination", "ok" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "slugs": { "description": "Only partners with these slugs.", "type": "array", "items": { "type": "string" } }, "partner_ids": { "description": "Only partners with these UUIDs.", "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "is_live": { "description": "Filter by whether the partner's Seam integration is live.", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] }, "is_featured": { "description": "Filter by whether Seam features the partner.", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] }, "industry": { "description": "Industry slug.", "type": "string" }, "solution": { "description": "Solution slug.", "type": "string" }, "limit": { "default": 100, "description": "Maximum number of partners to return (1-500).", "type": "integer", "minimum": 1, "maximum": 500 }, "page_cursor": { "description": "The `next_page_cursor` from the previous page.", "type": "string" } } } } } } } }, "/providers/get": { "get": { "summary": "Get a provider", "description": "Returns one published provider by `slug` or `provider_id`, with its integrations (support level and capability flags per feature), industries, manufacturers and logos, and the provider whose integration serves it when it is a white-label brand of another (`backed_by_provider_slug`).", "tags": [ "providers" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "provider": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] }, "description_md": { "description": "Description in markdown, when recorded.", "type": [ "string", "null" ] }, "is_acs": { "description": "Access control system provider; null where not established.", "type": [ "boolean", "null" ] }, "has_requirements": { "description": "Whether integration requirements apply; null where not established.", "type": [ "boolean", "null" ] }, "requirements_md": { "description": "Free-text integration requirements, verbatim from the source.", "type": [ "string", "null" ] }, "logos": { "type": "array", "items": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Square logos in color and monochrome variants." }, "integrations": { "type": "array", "items": { "type": "object", "properties": { "provider_integration_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the integration." }, "kind": { "type": "string", "enum": [ "access", "climate", "sensor" ], "description": "Integration kind: `access`, `climate`, or `sensor`." }, "feature": { "type": "string", "description": "Integration feature, e.g. `lock_unlock` or `hvac`." }, "integration_support_level": { "anyOf": [ { "type": "string", "enum": [ "inquire", "unavailable", "planned", "in-progress", "beta", "stable" ] }, { "type": "null" } ], "description": "Support level for this feature; null where the source has none." }, "flags": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "boolean", "null" ] }, "description": "Per-feature capability flags exactly as authored; null means not established by research." }, "extra_info": { "anyOf": [ { "$ref": "#/paths/~1providers~1get/get/responses/200/content/application~1json/schema/$defs/__schema0" }, { "type": "null" } ], "description": "Additional integration data verbatim from the source." } }, "required": [ "provider_integration_id", "kind", "feature", "integration_support_level", "flags", "extra_info" ], "additionalProperties": false }, "description": "One entry per integration feature with its support level and flags." }, "industries": { "type": "array", "items": { "type": "object", "properties": { "industry_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the industry." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `short-term-rental`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] } }, "required": [ "industry_id", "slug", "display_name", "short_name" ], "additionalProperties": false }, "description": "Industries this provider serves." }, "manufacturers": { "type": "array", "items": { "type": "object", "properties": { "manufacturer_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the manufacturer." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `schlage`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "manufacturer_id", "slug", "display_name" ], "additionalProperties": false }, "description": "Manufacturers whose devices this provider integrates with." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." }, "backed_by_provider_slug": { "description": "The provider whose integration serves this one's devices (e.g. `tt-lock` for `33-lock`); support declared for that provider applies to this one. Null when it has none.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name", "description_md", "is_acs", "has_requirements", "requirements_md", "logos", "integrations", "industries", "manufacturers", "created_at", "updated_at", "backed_by_provider_slug" ], "additionalProperties": false, "description": "The published provider." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "provider", "ok" ], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1providers~1get/get/responses/200/content/application~1json/schema/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1providers~1get/get/responses/200/content/application~1json/schema/$defs/__schema0" } } ] } } } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "parameters": [ { "name": "slug", "in": "query", "required": false, "schema": { "description": "Provider slug; provide this or `provider_id`.", "type": "string" } }, { "name": "provider_id", "in": "query", "required": false, "schema": { "description": "Provider UUID; provide this or `slug`.", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ] }, "post": { "summary": "Get a provider", "description": "Returns one published provider by `slug` or `provider_id`, with its integrations (support level and capability flags per feature), industries, manufacturers and logos, and the provider whose integration serves it when it is a white-label brand of another (`backed_by_provider_slug`).", "tags": [ "providers" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "provider": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] }, "description_md": { "description": "Description in markdown, when recorded.", "type": [ "string", "null" ] }, "is_acs": { "description": "Access control system provider; null where not established.", "type": [ "boolean", "null" ] }, "has_requirements": { "description": "Whether integration requirements apply; null where not established.", "type": [ "boolean", "null" ] }, "requirements_md": { "description": "Free-text integration requirements, verbatim from the source.", "type": [ "string", "null" ] }, "logos": { "type": "array", "items": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Square logos in color and monochrome variants." }, "integrations": { "type": "array", "items": { "type": "object", "properties": { "provider_integration_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the integration." }, "kind": { "type": "string", "enum": [ "access", "climate", "sensor" ], "description": "Integration kind: `access`, `climate`, or `sensor`." }, "feature": { "type": "string", "description": "Integration feature, e.g. `lock_unlock` or `hvac`." }, "integration_support_level": { "anyOf": [ { "type": "string", "enum": [ "inquire", "unavailable", "planned", "in-progress", "beta", "stable" ] }, { "type": "null" } ], "description": "Support level for this feature; null where the source has none." }, "flags": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "boolean", "null" ] }, "description": "Per-feature capability flags exactly as authored; null means not established by research." }, "extra_info": { "anyOf": [ { "$ref": "#/paths/~1providers~1get/post/responses/200/content/application~1json/schema/$defs/__schema0" }, { "type": "null" } ], "description": "Additional integration data verbatim from the source." } }, "required": [ "provider_integration_id", "kind", "feature", "integration_support_level", "flags", "extra_info" ], "additionalProperties": false }, "description": "One entry per integration feature with its support level and flags." }, "industries": { "type": "array", "items": { "type": "object", "properties": { "industry_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the industry." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `short-term-rental`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] } }, "required": [ "industry_id", "slug", "display_name", "short_name" ], "additionalProperties": false }, "description": "Industries this provider serves." }, "manufacturers": { "type": "array", "items": { "type": "object", "properties": { "manufacturer_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the manufacturer." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `schlage`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "manufacturer_id", "slug", "display_name" ], "additionalProperties": false }, "description": "Manufacturers whose devices this provider integrates with." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." }, "backed_by_provider_slug": { "description": "The provider whose integration serves this one's devices (e.g. `tt-lock` for `33-lock`); support declared for that provider applies to this one. Null when it has none.", "type": [ "string", "null" ] } }, "required": [ "provider_id", "slug", "display_name", "description_md", "is_acs", "has_requirements", "requirements_md", "logos", "integrations", "industries", "manufacturers", "created_at", "updated_at", "backed_by_provider_slug" ], "additionalProperties": false, "description": "The published provider." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "provider", "ok" ], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1providers~1get/post/responses/200/content/application~1json/schema/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1providers~1get/post/responses/200/content/application~1json/schema/$defs/__schema0" } } ] } } } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "slug": { "description": "Provider slug; provide this or `provider_id`.", "type": "string" }, "provider_id": { "description": "Provider UUID; provide this or `slug`.", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } } } } } } }, "/providers/list": { "get": { "summary": "List providers", "description": "Lists published providers with their integrations (support level and capability flags per feature), industries, manufacturers and logos, ordered by slug.", "tags": [ "providers" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "providers": { "type": "array", "items": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] }, "description_md": { "description": "Description in markdown, when recorded.", "type": [ "string", "null" ] }, "is_acs": { "description": "Access control system provider; null where not established.", "type": [ "boolean", "null" ] }, "has_requirements": { "description": "Whether integration requirements apply; null where not established.", "type": [ "boolean", "null" ] }, "requirements_md": { "description": "Free-text integration requirements, verbatim from the source.", "type": [ "string", "null" ] }, "logos": { "type": "array", "items": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Square logos in color and monochrome variants." }, "integrations": { "type": "array", "items": { "type": "object", "properties": { "provider_integration_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the integration." }, "kind": { "type": "string", "enum": [ "access", "climate", "sensor" ], "description": "Integration kind: `access`, `climate`, or `sensor`." }, "feature": { "type": "string", "description": "Integration feature, e.g. `lock_unlock` or `hvac`." }, "integration_support_level": { "anyOf": [ { "type": "string", "enum": [ "inquire", "unavailable", "planned", "in-progress", "beta", "stable" ] }, { "type": "null" } ], "description": "Support level for this feature; null where the source has none." }, "flags": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "boolean", "null" ] }, "description": "Per-feature capability flags exactly as authored; null means not established by research." }, "extra_info": { "anyOf": [ { "$ref": "#/paths/~1providers~1list/get/responses/200/content/application~1json/schema/$defs/__schema0" }, { "type": "null" } ], "description": "Additional integration data verbatim from the source." } }, "required": [ "provider_integration_id", "kind", "feature", "integration_support_level", "flags", "extra_info" ], "additionalProperties": false }, "description": "One entry per integration feature with its support level and flags." }, "industries": { "type": "array", "items": { "type": "object", "properties": { "industry_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the industry." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `short-term-rental`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] } }, "required": [ "industry_id", "slug", "display_name", "short_name" ], "additionalProperties": false }, "description": "Industries this provider serves." }, "manufacturers": { "type": "array", "items": { "type": "object", "properties": { "manufacturer_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the manufacturer." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `schlage`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "manufacturer_id", "slug", "display_name" ], "additionalProperties": false }, "description": "Manufacturers whose devices this provider integrates with." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "provider_id", "slug", "display_name", "description_md", "is_acs", "has_requirements", "requirements_md", "logos", "integrations", "industries", "manufacturers", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Published providers." }, "pagination": { "type": "object", "properties": { "has_next_page": { "type": "boolean", "description": "Whether another page follows this one." }, "next_page_cursor": { "description": "Cursor for the next page; null on the last page.", "type": [ "string", "null" ] } }, "required": [ "has_next_page", "next_page_cursor" ], "additionalProperties": false, "description": "Pagination for this page." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "providers", "pagination", "ok" ], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1providers~1list/get/responses/200/content/application~1json/schema/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1providers~1list/get/responses/200/content/application~1json/schema/$defs/__schema0" } } ] } } } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "parameters": [ { "name": "slugs", "in": "query", "required": false, "schema": { "description": "Only providers with these slugs.", "type": "array", "items": { "type": "string" } } }, { "name": "industry", "in": "query", "required": false, "schema": { "description": "Industry slug.", "type": "string" } }, { "name": "manufacturer", "in": "query", "required": false, "schema": { "description": "Manufacturer slug.", "type": "string" } }, { "name": "is_acs", "in": "query", "required": false, "schema": { "description": "Filter to access control system providers (or non-ACS).", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 100, "description": "Maximum number of providers to return (1-500).", "type": "integer", "minimum": 1, "maximum": 500 } }, { "name": "page_cursor", "in": "query", "required": false, "schema": { "description": "The `next_page_cursor` from the previous page.", "type": "string" } } ] }, "post": { "summary": "List providers", "description": "Lists published providers with their integrations (support level and capability flags per feature), industries, manufacturers and logos, ordered by slug.", "tags": [ "providers" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "providers": { "type": "array", "items": { "type": "object", "properties": { "provider_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the provider." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `salto-ks`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] }, "description_md": { "description": "Description in markdown, when recorded.", "type": [ "string", "null" ] }, "is_acs": { "description": "Access control system provider; null where not established.", "type": [ "boolean", "null" ] }, "has_requirements": { "description": "Whether integration requirements apply; null where not established.", "type": [ "boolean", "null" ] }, "requirements_md": { "description": "Free-text integration requirements, verbatim from the source.", "type": [ "string", "null" ] }, "logos": { "type": "array", "items": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the asset." }, "kind": { "type": "string", "enum": [ "square_logo", "square_logo_mono", "horizontal_logo", "horizontal_logo_mono", "default_device_image", "featured", "variant_image" ], "description": "Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image." }, "object_key": { "type": "string", "description": "Immutable object-storage key." }, "url": { "type": "string", "description": "Public URL of the original image." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of the original bytes, when recorded.", "type": [ "string", "null" ] }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Ordering within the owning version's assets." }, "formats": { "type": "object", "propertyNames": { "type": "string", "enum": [ "thumbnail", "small", "medium", "large" ] }, "additionalProperties": { "type": "object", "properties": { "object_key": { "type": "string", "description": "Immutable object-storage key of this format." }, "url": { "type": "string", "description": "Public URL of this format." }, "mime": { "description": "Media type, when known.", "type": [ "string", "null" ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Width in pixels, when known." }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Height in pixels, when known." }, "bytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Size in bytes, when known." }, "sha256": { "description": "SHA-256 of this format's bytes, when recorded.", "type": [ "string", "null" ] } }, "required": [ "object_key", "url", "mime", "width", "height", "bytes", "sha256" ], "additionalProperties": false }, "description": "Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos)." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "asset_id", "kind", "object_key", "url", "mime", "width", "height", "bytes", "sha256", "sort_order", "formats", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Square logos in color and monochrome variants." }, "integrations": { "type": "array", "items": { "type": "object", "properties": { "provider_integration_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the integration." }, "kind": { "type": "string", "enum": [ "access", "climate", "sensor" ], "description": "Integration kind: `access`, `climate`, or `sensor`." }, "feature": { "type": "string", "description": "Integration feature, e.g. `lock_unlock` or `hvac`." }, "integration_support_level": { "anyOf": [ { "type": "string", "enum": [ "inquire", "unavailable", "planned", "in-progress", "beta", "stable" ] }, { "type": "null" } ], "description": "Support level for this feature; null where the source has none." }, "flags": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "boolean", "null" ] }, "description": "Per-feature capability flags exactly as authored; null means not established by research." }, "extra_info": { "anyOf": [ { "$ref": "#/paths/~1providers~1list/post/responses/200/content/application~1json/schema/$defs/__schema0" }, { "type": "null" } ], "description": "Additional integration data verbatim from the source." } }, "required": [ "provider_integration_id", "kind", "feature", "integration_support_level", "flags", "extra_info" ], "additionalProperties": false }, "description": "One entry per integration feature with its support level and flags." }, "industries": { "type": "array", "items": { "type": "object", "properties": { "industry_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the industry." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `short-term-rental`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] } }, "required": [ "industry_id", "slug", "display_name", "short_name" ], "additionalProperties": false }, "description": "Industries this provider serves." }, "manufacturers": { "type": "array", "items": { "type": "object", "properties": { "manufacturer_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the manufacturer." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `schlage`." }, "display_name": { "description": "Display name.", "type": [ "string", "null" ] } }, "required": [ "manufacturer_id", "slug", "display_name" ], "additionalProperties": false }, "description": "Manufacturers whose devices this provider integrates with." }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Creation time (ISO 8601)." }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "Last update time (ISO 8601)." } }, "required": [ "provider_id", "slug", "display_name", "description_md", "is_acs", "has_requirements", "requirements_md", "logos", "integrations", "industries", "manufacturers", "created_at", "updated_at" ], "additionalProperties": false }, "description": "Published providers." }, "pagination": { "type": "object", "properties": { "has_next_page": { "type": "boolean", "description": "Whether another page follows this one." }, "next_page_cursor": { "description": "Cursor for the next page; null on the last page.", "type": [ "string", "null" ] } }, "required": [ "has_next_page", "next_page_cursor" ], "additionalProperties": false, "description": "Pagination for this page." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "providers", "pagination", "ok" ], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/paths/~1providers~1list/post/responses/200/content/application~1json/schema/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/paths/~1providers~1list/post/responses/200/content/application~1json/schema/$defs/__schema0" } } ] } } } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "401": { "description": "The key is unknown, revoked or unsupported", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "403": { "description": "The key does not allow this request, such as an origin that is not allowed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [ {}, { "secret_key": [] }, { "embed_key": [] }, { "embed_key_param": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "slugs": { "description": "Only providers with these slugs.", "type": "array", "items": { "type": "string" } }, "industry": { "description": "Industry slug.", "type": "string" }, "manufacturer": { "description": "Manufacturer slug.", "type": "string" }, "is_acs": { "description": "Filter to access control system providers (or non-ACS).", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] }, "limit": { "default": 100, "description": "Maximum number of providers to return (1-500).", "type": "integer", "minimum": 1, "maximum": 500 }, "page_cursor": { "description": "The `next_page_cursor` from the previous page.", "type": "string" } } } } } } } }, "/solutions/list": { "get": { "summary": "List solutions", "description": "Lists every solution category in the ecosystem taxonomy.", "tags": [ "solutions" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "solutions": { "type": "array", "items": { "type": "object", "properties": { "solution_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the solution." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `property-management-system`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "software", "service" ], "description": "`software` or `service`." } }, "required": [ "solution_id", "slug", "display_name", "short_name", "type" ], "additionalProperties": false }, "description": "Solution categories, ordered by name." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "solutions", "ok" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [], "parameters": [] }, "post": { "summary": "List solutions", "description": "Lists every solution category in the ecosystem taxonomy.", "tags": [ "solutions" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "solutions": { "type": "array", "items": { "type": "object", "properties": { "solution_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Ecosystem UUID of the solution." }, "slug": { "type": "string", "description": "Stable identifier, e.g. `property-management-system`." }, "display_name": { "type": "string", "description": "Display name." }, "short_name": { "description": "Short display name, when set.", "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "software", "service" ], "description": "`software` or `service`." } }, "required": [ "solution_id", "slug", "display_name", "short_name", "type" ], "additionalProperties": false }, "description": "Solution categories, ordered by name." }, "ok": { "type": "boolean", "const": true, "description": "Always `true` on success." } }, "required": [ "solutions", "ok" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ok": { "type": "boolean", "const": false, "description": "Always `false` on error." }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "Machine-readable error type." }, "message": { "type": "string", "description": "Human-readable error message." }, "request_id": { "type": "string", "description": "Request ID to include when you contact Seam." }, "data": { "description": "Details for some error types, such as validation issues.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "message", "request_id" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer" } } } } }, "security": [] } } } }