Get Product Details

Endpoint

  • Method: GET

  • Path: /api/v4/product_details

  • Description: Returns metadata and flags for a product.

Authentication

See License API Authorization.

Required headers

  • Date (string) — RFC7231 GMT date string

  • Authorization (string)

  • Accept: application/json

Request

Query parameters

Required:

  • product (string) — Product short code

Optional:

  • include_latest_version (boolean) — Default: false

  • include_custom_fields (boolean) — Default: false

  • env (string) — Filter by installation file environment

Examples

Schema

chevron-rightRequest schema (TypeScript + JSON Schema)hashtag

TypeScript

JSON Schema

chevron-rightResponse schema (TypeScript + JSON Schema)hashtag

TypeScript

JSON Schema

{% hint style="info" %} If product does not have a version defined, it will return null {% endhint %}

{% hint style="info" %} If product does not have any custom fields defined, it will return an empty array {% endhint %}

Errors

If an error occurs, the response will have an HTTP status code of 400 or higher, and the response body will contain an error description in the following format:

JSON Schema

List of exceptions

chevron-rightunknown_product (400)hashtag

Provided product was not found

chevron-rightmissing_headers (400)hashtag

Some headers are missing

chevron-rightmissing_parameters (400)hashtag

Some parameters are missing in the request: { params }

Last updated

Was this helpful?