Get OEM Config Schema
Retrieves the OEM config schema for a given OEM type and app package name. Use it to get the structure that describes which OEM-specific managed configuration keys an app supports and how they're formatted.
By default this returns the latest active schema; pass version_code to pin to a specific schema version, and set include_schema=false when you only need metadata and want to avoid downloading the (potentially large) schema_json payload.
About OEM Config Schema
OEM config schemas describe device-manufacturer-specific managed configuration options (separate from an app's standard managed configuration) so that OEM-provided settings can be surfaced and applied consistently through Esper. Schemas are versioned per OEM type and package name, with one version marked active at a time.
Key Fields / Query Parameters
- oem_type — the OEM/manufacturer identifier the schema applies to
- package_name — the Android package name of the app the schema is for
- version_code — optional, retrieves a specific schema version instead of the latest active one
- include_schema — set to false to omit the schema_json payload and return metadata only
Common Use Cases
- Fetching the current OEM config schema before building a UI or payload for OEM-specific managed configuration
- Checking metadata only (via include_schema=false) to confirm a schema exists or see its version without pulling the full payload
Best Practices
- Use include_schema=false when you only need to check schema existence or version, since schema_json payloads can be large Retrieve the OEM config schema for a given OEM type and package name. Returns the latest active schema by default. Specify version_code to retrieve a specific version. Set include_schema=false to receive metadata only (avoids the large schema_json payload).
Request
- Base URLhttps://develop-api.esper.cloud/api
- URLhttps://develop-api.esper.cloud/api/v2/oem-config-schema
- AuthHTTP bearer
Query parameters
OEM manufacturer type
OEM config package name (e.g. com.zebra.oemconfig.common)
Specific version code to retrieve. When omitted, returns the latest active schema.
Set to false to return metadata only, omitting the schema_json field (avoids large payload)
Headers
Bearer token for authentication
Response
Success
Example response
{
"content": {
"package_name": "com.zebra.oemconfig.common",
"version_name": "11.3.3.00",
"version_code": "10"
}
}Changes
No recorded changes to this operation across all 6 revisions of this API.