manufacturer: your profile, with name, description, website, support contacts, and logos.device_models: your published device models, with images, variants, device type, providers, and capabilities per provider.providers: the providers (cloud services and systems) that connect your devices to Seam, with the support level of each integration.compatibility: for each device category you make, the apps that support your devices through Seam.
POST with the same parameters as a JSON body.
Examples
With a manufacturer secret key, your brand is implied:Parameters
Response
manufacturer
Your manufacturer profile: slug, display_name, website, description_md, headquarters, country_of_origin, parent_org, customer support contacts (customer_support_phone, customer_support_email, customer_support_url), logos (square and horizontal, in color and monochrome), and default_device_images (a fallback image for each device type).
device_model_count counts the device models the caller can see. It includes your hidden models only when they are included in the response.
providers
The providers that connect your devices to Seam: those linked to your brand and those linked to any of your device models. Each provider includes:
integrations: what Seam supports through this provider. Each integration has akind(access,climate, orsensor), afeature(for examplelock_unlock), anintegration_support_level(stable,beta,in-progress,planned,inquire, orunavailable), andflagswith the capabilities it provides.device_model_count: how many of your device models the provider covers. A provider linked only to your brand has0.logos,industries,is_acs(whether it is an access control system), andrequirements_md(integration requirements, when recorded).
compatibility
One entry for each device category you make, such as smartlock or thermostat. Each entry lists the partners (apps) that support your devices in that category through Seam, the same apps that Compatible Apps shows.
An app appears only where Seam or the app’s maker has declared support. Each partner includes its profile (slug, display_name, website, description_md, industries, solutions, and logos in assets) and a support object:
supported: alwaystruein this list.resolved_level: the most specific level the deciding declaration was made at:device_category,manufacturer,provider, orcapability.declared_status: the deciding declaration.note: the app’s note about its support, when it has one.
device_models
Your published device models, ordered by slug, in the device model summary shape.
pagination and locale
Only device_models is paged. Every other field is the same on every page, so you can read them from the first page. When pagination.has_next_page is true, pass pagination.next_page_cursor as page_cursor to get the next page.
locale is the language capability reports were resolved in, after any fallback.
Errors
See the overview for key, rate limit, and parameter errors.
Next Steps
- Filter device models by type, provider, or capability with List Device Model Summaries.
- Get your keys in Keys and Authentication.