Device Metadata API

Retrieve the information you need to build integrations with Jabra devices.

The Device Metadata API provides structured information about Jabra devices and their capabilities. Use it when you need to:

• Discover available Jabra devices.
• Identify firmware versions supported by each device variant.
• Find device properties supported by a specific product variant and firmware version.
• Check which values are valid for a device property.
• Retrieve additional product metadata, such as product images and related web content links.

API endpoints

The API has two endpoint groups: device model endpoints and device content endpoints.

Device model endpoints

These endpoints provide basic information about devices and their capabilities.

Base URL: https://cdn.cloud.jabra.com/models/v/{apiVersion}/

Name	Endpoint and purpose
Device catalog	List basic information about Jabra devices, including variants, product IDs (PIDs), available firmware versions, product bundle relationships, and more. GET {Base URL}/product-group-bundles/bundles.json Example response ↗
Device feature model	Retrieve device settings and their supported values for a specific product variant and firmware version. Includes device setting names used by the Jabra Plus API. GET {Base URL}/vendors/{vendorId}/products/{productId}/variants/{variantType}/firmware-versions/{firmwareVersion}/feature-model.json {vendorId}, {productId}, {variantType}, and {firmwareVersion}: Core product and firmware identifiers. Available through the Device Catalog endpoint, Jabra Plus API, JabraCLI, and the SDKs. Example response ↗
SDK device properties	Retrieve information about supported Device Properties for specific product variants and firmware versions. Used in the Jabra SDK and JabraCLI. You can combine this data with the Device feature model endpoint to understand property behavior in more detail. GET {Base URL}/vendors/{vendorId}/products/{productId}/variants/{variantType}/firmware-versions/{firmwareVersion}/device-models/Jabra%20SDK%20V4/definition-versions/{definitionVersion}.json {vendorId}, {productId}, {variantType}, and {firmwareVersion}: Core product and firmware identifiers. Available through the Device Catalog endpoint, Jabra Plus API, JabraCLI, and the SDKs. {definitionVersion}: Match the definitions version of the Properties definitions package used in your SDK app, or the listed definition version for the JabraCLI version you are using. See Retrieving latest definitions versions for more information. Example response ↗

Device content endpoint

Use these endpoints to retrieve product web content.

Base URL: https://cdn.cloud.jabra.com/content/v/{apiVersion}/

Name	Endpoint and purpose
Product web content	Retrieve product web content for Jabra devices, including product images and links to support pages with product information and firmware release notes. GET /content/v/{apiVersion}/products.json Example response ↗

Supported API versions

apiVersion	Released	Availability commitment (see versioning lifecycle policy)	OpenAPI specs
18	15 Sep 2026	Six months after version 19 is released.	OpenAPI specification (Device model endpoints)

OpenAPI spec endpoint URLs

OpenAPI endpoint URLs are relative. Add the base URL and append ".json" before calling them. See the example responses above.

Retrieving latest definitions versions

As noted above, match the definitionVersion to the property definitions package used in your SDK app.

If you are building with the Jabra SDKs, never use a definitionVersion greater than the version of the Jabra.Properties.Definition npm or NuGet package used by your application.

In some cases, the SDK definitions packages are newer than the definitions versions available in the SDK device properties API endpoint. To find the latest definitions version supported by the API, follow these steps:

1. Get the latest schema version from this endpoint: GET https://cdn.cloud.jabra.com/models/v/{apiVersion}/protocol-definitions/gnp/schema-versions.json
   Example response ↗
2. Using that schema version, read the latest available definitions version from this endpoint: GET https://cdn.cloud.jabra.com/models/v/{apiVersion}/protocol-definitions/gnp/definition-versions/schema-versions/{schemaVersion}/latest/info.json
   Example response ↗

WARNING

If you are building with the Jabra SDKs, never use a definitionVersion greater than the version of the Jabra.Properties.Definition npm or NuGet package used by your application.

Live demo

The Device Properties Explorer is powered by the Device Metadata API. Use it to familiarize yourself with the data available.

Versioning and lifecycle policy

Breaking changes are introduced in new API versions so integrations can continue using an existing version while they are updated and tested against the latest release. The API version applies to all listed endpoints. Each new API version is documented through updates to the corresponding OpenAPI specs.

API lifecycle policy

We support each released API version for six months after the publication of a newer released version.

Example: API version 18 will be supported for six months after the release date of version 19.

Older API versions may continue to work beyond six months after a newer version is released. We still recommend updating to the latest version as soon as practical, because older versions may be deprecated at any time after this period.

Schema versions for SDK and CLI properties are never deprecated. If you use an older schema version, your API responses will not include newer properties that require an updated schema.

Get help and support

If you need help using the Device Metadata API, have questions about supported properties, or want to discuss an integration, contact developer support.