/api/oauth/v1/token

Get authentication token

• Content-type (header, required) — Equal to 'application/json' or 'application/x-www-form-urlencoded', no other value allowed
• Authorization (header, required) — Equal to 'Basic xx', where 'xx' is the base 64 encoding of the client id and secret. Find out how to generate them in the Client ID/secret generation section.

/api/rest/v1

Get list of all endpoints

/api/rest/v1/asset-families/{code}

Update/create an asset family

• code (path, required) — Code of the resource

/api/rest/v1/asset-categories

Get list of PAM asset categories

• page (query, page) — Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section
• limit (query, limit) — Number of results by page, see Pagination section
• with_count (query) — Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way

/api/rest/v1/asset-categories

Update/create several PAM asset categories

/api/rest/v1/asset-categories

Create a new PAM asset category

/api/rest/v1/asset-categories/{code}

Get a PAM asset category

• code (path, required) — Code of the resource

/api/rest/v1/asset-categories/{code}

Update/create a PAM asset category

• code (path, required) — Code of the resource

/api/rest/v1/asset-families

Get list of asset families

• search_after (query) — Cursor when using the `search_after` pagination method type. Should never be set manually , see Pagination section

/api/rest/v1/asset-families/{asset_family_code}/assets

Get the list of the assets of a given asset family

• search (query) — Filter assets, for more details see the Asset filters section
• channel (query) — Filter asset values to return scopable asset attributes for the given channel as well as the non localizable/non scopable asset attributes, for more details see the Filter asset values by channel section
• locales (query) — Filter asset values to return localizable attributes for the given locales as well as the non localizable/non scopable asset attributes, for more details see the Filter asset values by locale section
• asset_family_code (path, required) — Code of the asset family
• search_after (query) — Cursor when using the `search_after` pagination method type. Should never be set manually , see Pagination section

/api/rest/v1/asset-media-files

Create a new media file for an asset

• Content-type (header, required) — Equal to 'multipart/form-data', no other value allowed

/api/rest/v1/asset-media-files/{code}

Download the media file associated to an asset

• code (path, required) — Code of the resource

/api/rest/v1/assets/{asset_code}/reference-files/{locale_code}

Get a reference file

• asset_code (path, required) — Code of the asset
• locale_code (path, required) — Code of the locale if the asset is localizable or equal to `no-locale` if the asset is not localizable

/api/rest/v1/asset-families/{asset_family_code}/assets

Update/create several assets

• asset_family_code (path, required) — Code of the asset family

/api/rest/v1/asset-families/{asset_family_code}/assets/{code}

Delete an asset

• asset_family_code (path, required) — Code of the asset family
• code (path, required) — Code of the resource

/api/rest/v1/asset-families/{asset_family_code}/assets/{code}

Get an asset of a given asset family

• asset_family_code (path, required) — Code of the asset family
• code (path, required) — Code of the resource

/api/rest/v1/asset-families/{asset_family_code}/assets/{code}

Update/create an asset

• asset_family_code (path, required) — Code of the asset family
• code (path, required) — Code of the resource

/api/rest/v1/asset-families/{asset_family_code}/attributes

Get the list of attributes of a given asset family

• asset_family_code (path, required) — Code of the asset family

/api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options

Get a list of attribute options of a given attribute for a given asset family

• asset_family_code (path, required) — Code of the asset family
• attribute_code (path, required) — Code of the attribute

/api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options/{code}

Get an attribute option for a given attribute of a given asset family

• asset_family_code (path, required) — Code of the asset family
• attribute_code (path, required) — Code of the attribute
• code (path, required) — Code of the resource

/api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options/{code}

Update/create an asset attribute option for a given asset family

• asset_family_code (path, required) — Code of the asset family
• attribute_code (path, required) — Code of the attribute
• code (path, required) — Code of the resource

/api/rest/v1/asset-families/{asset_family_code}/attributes/{code}

Get an attribute of a given asset family

• asset_family_code (path, required) — Code of the asset family
• code (path, required) — Code of the resource

/api/rest/v1/asset-families/{asset_family_code}/attributes/{code}

Update/create an attribute of a given asset family

• asset_family_code (path, required) — Code of the asset family
• code (path, required) — Code of the resource

/api/rest/v1/asset-families/{code}

Get an asset family

• code (path, required) — Code of the resource

/api/rest/v1/catalogs/{id}

Update a catalog

• id (path, required) — Catalog ID

/api/rest/v1/asset-tags

Get list of PAM asset tags

• page (query, page) — Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section
• limit (query, limit) — Number of results by page, see Pagination section
• with_count (query) — Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way

/api/rest/v1/asset-tags/{code}

Get a PAM asset tag

• code (path, required) — Code of the resource

/api/rest/v1/asset-tags/{code}

Update/create a PAM asset tag

• code (path, required) — Code of the resource

/api/rest/v1/assets

Get list of PAM assets

• pagination_type (query) — Pagination method type, see Pagination section
• page (query, page) — Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section
• search_after (query) — Cursor when using the `search_after` pagination method type. Should never be set manually , see Pagination section
• limit (query, limit) — Number of results by page, see Pagination section
• with_count (query) — Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way

/api/rest/v1/assets

Update/create several PAM assets

/api/rest/v1/assets

Create a new PAM asset

/api/rest/v1/assets/{asset_code}/reference-files/{locale_code}

Upload a new reference file

• asset_code (path, required) — Code of the asset
• locale_code (path, required) — Code of the locale if the asset is localizable or equal to `no-locale` if the asset is not localizable
• Content-type (header, required) — Equal to 'multipart/form-data', no other value allowed

/api/rest/v1/assets/{asset_code}/reference-files/{locale_code}/download

Download a reference file

• asset_code (path, required) — Code of the asset
• locale_code (path, required) — Code of the locale if the asset is localizable or equal to `no-locale` if the asset is not localizable

/api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code}

Get a variation file

• asset_code (path, required) — Code of the asset
• channel_code (path, required) — Code of the channel
• locale_code (path, required) — Code of the locale if the asset is localizable or equal to `no-locale` if the asset is not localizable

/api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code}

Upload a new variation file

• asset_code (path, required) — Code of the asset
• channel_code (path, required) — Code of the channel
• locale_code (path, required) — Code of the locale if the asset is localizable or equal to `no-locale` if the asset is not localizable
• Content-type (header, required) — Equal to 'multipart/form-data', no other value allowed

/api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code}/download

Download a variation file

• asset_code (path, required) — Code of the asset
• channel_code (path, required) — Code of the channel
• locale_code (path, required) — Code of the locale if the asset is localizable or equal to `no-locale` if the asset is not localizable

/api/rest/v1/assets/{code}

Get a PAM asset

• code (path, required) — Code of the resource

/api/rest/v1/assets/{code}

Update/create a PAM asset

• code (path, required) — Code of the resource

/api/rest/v1/association-types

Get a list of association types

• page (query, page) — Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section
• limit (query, limit) — Number of results by page, see Pagination section
• with_count (query) — Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way

/api/rest/v1/locales/{code}

Get a locale

• code (path, required) — Code of the resource

/api/rest/v1/association-types

Update/create several association types

/api/rest/v1/association-types

Create a new association type

/api/rest/v1/association-types/{code}

Get an association type

• code (path, required) — Code of the resource

/api/rest/v1/association-types/{code}

Update/create an association type

• code (path, required) — Code of the resource

/api/rest/v1/attribute-groups

Get list of attribute groups

• search (query) — Filter attribute groups, for more details see the Filters section.
• page (query, page) — Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section
• limit (query, limit) — Number of results by page, see Pagination section
• with_count (query) — Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way

/api/rest/v1/attribute-groups

Update/create several attribute groups

/api/rest/v1/attribute-groups

Create a new attribute group

/api/rest/v1/attribute-groups/{code}

Get an attribute group

• code (path, required) — Code of the resource

/api/rest/v1/attribute-groups/{code}

Update/create an attribute group

• code (path, required) — Code of the resource

/api/rest/v1/attributes

Get list of attributes

• search (query) — Filter attributes, for more details see the Filters section.
• page (query, page) — Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section
• limit (query, limit) — Number of results by page, see Pagination section
• with_count (query) — Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way
• with_table_select_options (query) — Return the options of 'select' column types (of a table attribute) in the response. (Only available since the 7.0 version)

/api/rest/v1/attributes

Update/create several attributes

/api/rest/v1/attributes

Create a new attribute

/api/rest/v1/attributes/{attribute_code}/options

Get list of attribute options

• attribute_code (path, required) — Code of the attribute
• page (query, page) — Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section
• limit (query, limit) — Number of results by page, see Pagination section
• with_count (query) — Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way

/api/rest/v1/attributes/{attribute_code}/options

Update/create several attribute options

• attribute_code (path, required) — Code of the attribute

/api/rest/v1/attributes/{attribute_code}/options

Create a new attribute option

• attribute_code (path, required) — Code of the attribute

/api/rest/v1/attributes/{attribute_code}/options/{code}

Get an attribute option

• attribute_code (path, required) — Code of the attribute
• code (path, required) — Code of the resource

/api/rest/v1/attributes/{attribute_code}/options/{code}

Update/create an attribute option

• attribute_code (path, required) — Code of the attribute
• code (path, required) — Code of the resource

/api/rest/v1/attributes/{code}

Get an attribute

• code (path, required) — Code of the resource
• with_table_select_options (query) — Return the options of 'select' column types (of a table attribute) in the response. (Only available since the 7.0 version)

/api/rest/v1/attributes/{code}

Update/create an attribute

• code (path, required) — Code of the resource

/api/rest/v1/catalogs

Get the list of owned catalogs

• page (query, page) — Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section
• limit (query, limit) — Number of results by page, see Pagination section

/api/rest/v1/catalogs

Create a new catalog

/api/rest/v1/catalogs/{id}

Delete a catalog

• id (path, required) — Catalog ID

/api/rest/v1/catalogs/{id}

Get a catalog

• id (path, required) — Catalog ID

/api/rest/v1/catalogs/{id}/product-uuids

Get the list of product uuids

• id (path, required) — Id of the catalog
• search_after (query) — Cursor when using the `search_after` pagination method type. Should never be set manually , see Pagination section
• limit (query, limit) — Number of results by page, see Pagination section
• updated_before (query) — Filter products that have been updated BEFORE the provided date (Only available on Catalogs endpoints)
• updated_after (query) — Filter products that have been updated AFTER the provided date (Only available on Catalogs endpoints)

/api/rest/v1/catalogs/{id}/products

Get the list of products related to a catalog

• id (path, required) — Catalog ID
• search_after (query) — Cursor when using the `search_after` pagination method type. Should never be set manually , see Pagination section
• limit (query, limit) — Number of results by page, see Pagination section
• updated_before (query) — Filter products that have been updated BEFORE the provided date (Only available on Catalogs endpoints)
• updated_after (query) — Filter products that have been updated AFTER the provided date (Only available on Catalogs endpoints)

/api/rest/v1/catalogs/{id}/products/{uuid}

Get a product related to a catalog

• id (path, required) — Catalog ID
• uuid (path, required) — Product UUID

/api/rest/v1/categories

Get list of categories

• search (query) — Filter categories, for more details see the Filters section.
• page (query, page) — Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section
• limit (query, limit) — Number of results by page, see Pagination section
• with_count (query) — Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way
• with_position (query) — Return information about category position into its category tree (only available since the 7.0 version)
• with_enriched_attributes (query) — Return attribute values of the category (only available on SaaS platforms)

/api/rest/v1/categories

Update/create several categories

/api/rest/v1/categories

Create a new category

/api/rest/v1/categories/{code}

Get a category

• code (path, required) — Code of the resource
• with_position (query) — Return information about category position into its category tree (only available since the 7.0 version)
• with_enriched_attributes (query) — Return attribute values of the category (only available on SaaS platforms) [COMING SOON]

/api/rest/v1/categories/{code}

Update/create a category

• code (path, required) — Code of the resource

/api/rest/v1/category-media-files/{code}/download

Download a category media file [COMING SOON]

• code (path, required) — Code of the resource

/api/rest/v1/channels

Get a list of channels

• page (query, page) — Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section
• limit (query, limit) — Number of results by page, see Pagination section
• with_count (query) — Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way

/api/rest/v1/channels

Update/create several channels

/api/rest/v1/channels

Create a new channel

/api/rest/v1/channels/{code}

Get a channel

• code (path, required) — Code of the resource

/api/rest/v1/channels/{code}

Update/create a channel

• code (path, required) — Code of the resource

/api/rest/v1/currencies

Get a list of currencies

• page (query, page) — Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section
• limit (query, limit) — Number of results by page, see Pagination section
• with_count (query) — Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way

/api/rest/v1/currencies/{code}

Get a currency

• code (path, required) — Code of the resource

/api/rest/v1/families

Get list of families

• search (query) — Filter families, for more details see the Filters section.
• page (query, page) — Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section
• limit (query, limit) — Number of results by page, see Pagination section
• with_count (query) — Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way

/api/rest/v1/reference-entities/{reference_entity_code}/records/{code}

Get a record of a given reference entity

• reference_entity_code (path, required) — Code of the reference entity
• code (path, required) — Code of the resource

/api/rest/v1/families

Update/create several families

/api/rest/v1/families

Create a new family

/api/rest/v1/families/{code}

Get a family

• code (path, required) — Code of the resource

/api/rest/v1/families/{code}

Update/create a family

• code (path, required) — Code of the resource

/api/rest/v1/families/{family_code}/variants

Get list of family variants

• family_code (path, required) — Code of the family
• page (query, page) — Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section
• limit (query, limit) — Number of results by page, see Pagination section
• with_count (query) — Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way

/api/rest/v1/families/{family_code}/variants

Update/create several family variants

• family_code (path, required) — Code of the family

/api/rest/v1/families/{family_code}/variants

Create a new family variant

• family_code (path, required) — Code of the family

/api/rest/v1/families/{family_code}/variants/{code}

Get a family variant

• family_code (path, required) — Code of the family
• code (path, required) — Code of the resource

/api/rest/v1/families/{family_code}/variants/{code}

Update/create a family variant

• family_code (path, required) — Code of the family
• code (path, required) — Code of the resource

/api/rest/v1/locales

Get a list of locales

• search (query) — Filter locales, for more details see the Filters section
• page (query, page) — Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section
• limit (query, limit) — Number of results by page, see Pagination section
• with_count (query) — Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way

/api/rest/v1/measure-families

Get list of measure familiy

/api/rest/v1/measure-families/{code}

Get a measure family

• code (path, required) — Code of the resource

/api/rest/v1/measurement-families

Get list of measurement families

/api/rest/v1/measurement-families

Update/create several measurement families

/api/rest/v1/media-files

Get a list of product media files

• page (query, page) — Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section
• limit (query, limit) — Number of results by page, see Pagination section
• with_count (query) — Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way

/api/rest/v1/media-files

Create a new product media file

• Content-type (header, required) — Equal to 'multipart/form-data', no other value allowed

/api/rest/v1/media-files/{code}

Get a product media file

• code (path, required) — Code of the resource

/api/rest/v1/media-files/{code}/download

Download a product media file

• code (path, required) — Code of the resource

/api/rest/v1/product-models

Get list of product models

• search (query) — Filter product models, for more details see the Filters section
• scope (query) — Filter product values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more details see the Filter product values via channel section
• locales (query) — Filter product values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for more details see the Filter product values via locale section
• attributes (query) — Filter product values to only return those concerning the given attributes, for more details see the Filter on product values section and the Filter on product model properties section
• pagination_type (query) — Pagination method type, see Pagination section
• page (query, page) — Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section
• search_after (query) — Cursor when using the `search_after` pagination method type. Should never be set manually , see Pagination section
• limit (query, limit) — Number of results by page, see Pagination section
• with_count (query) — Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way
• with_quality_scores (query) — Return product model quality scores in the response. (Only available since the 6.0 version)

/api/rest/v1/product-models

Update/create several product models

/api/rest/v1/product-models

Create a new product model

/api/rest/v1/product-models/{code}

Delete a product model

• code (path, required) — Code of the resource

/api/rest/v1/product-models/{code}

Get a product model

• code (path, required) — Code of the resource
• with_quality_scores (query) — Return product model quality scores in the response. (Only available since the 6.0 version)

/api/rest/v1/product-models/{code}

Update/create a product model

• code (path, required) — Code of the resource

/api/rest/v1/product-models/{code}/draft

Get a draft

• code (path, required) — Code of the resource

/api/rest/v1/product-models/{code}/proposal

Submit a draft for approval

• code (path, required) — Code of the resource

/api/rest/v1/products

Get list of products

• search (query) — Filter products, for more details see the Filters section
• scope (query) — Filter product values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more details see the Filter product values via channel section
• locales (query) — Filter product values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for more details see the Filter product values via locale section
• attributes (query) — Filter product values to only return those concerning the given attributes, for more details see the Filter on product values section
• pagination_type (query) — Pagination method type, see Pagination section
• page (query, page) — Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section
• search_after (query) — Cursor when using the `search_after` pagination method type. Should never be set manually , see Pagination section
• limit (query, limit) — Number of results by page, see Pagination section
• with_count (query) — Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way
• with_attribute_options (query) — Return labels of attribute options in the response. (Only available since the 5.0 version)
• with_quality_scores (query) — Return product quality scores in the response. (Only available since the 5.0 version)
• with_completenesses (query) — Return product completenesses in the response. (Only available since the 6.0 version)

/api/rest/v1/products

Update/create several products

/api/rest/v1/products

Create a new product

/api/rest/v1/products-uuid

Get list of products

• search (query) — Filter products, for more details see the Filters section
• scope (query) — Filter product values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more details see the Filter product values via channel section
• locales (query) — Filter product values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for more details see the Filter product values via locale section
• attributes (query) — Filter product values to only return those concerning the given attributes, for more details see the Filter on product values section
• pagination_type (query) — Pagination method type, see Pagination section
• page (query, page) — Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section
• search_after (query) — Cursor when using the `search_after` pagination method type. Should never be set manually , see Pagination section
• limit (query, limit) — Number of results by page, see Pagination section
• with_count (query) — Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way
• with_attribute_options (query) — Return labels of attribute options in the response. (Only available since the 5.0 version)
• with_quality_scores (query) — Return product quality scores in the response. (Only available since the 5.0 version)
• with_completenesses (query) — Return product completenesses in the response. (Only available since the 6.0 version)

/api/rest/v1/products-uuid

Update/create several products

/api/rest/v1/products-uuid

Create a new product

/api/rest/v1/products-uuid/{uuid}

Delete a product

• uuid (path, required) — Uuid of the resource

/api/rest/v1/products-uuid/{uuid}

Get a product

• uuid (path, required) — Uuid of the resource
• with_attribute_options (query) — Return labels of attribute options in the response. (Only available since the 5.0 version)
• with_quality_scores (query) — Return product quality scores in the response. (Only available since the 5.0 version)
• with_completenesses (query) — Return product completenesses in the response. (Only available since the 6.0 version)

/api/rest/v1/products-uuid/{uuid}

Update/create a product

• uuid (path, required) — Uuid of the resource

/api/rest/v1/products-uuid/{uuid}/draft

Get a draft

• uuid (path, required) — Uuid of the resource

/api/rest/v1/products-uuid/{uuid}/proposal

Submit a draft for approval

• uuid (path, required) — Uuid of the resource

/api/rest/v1/products/{code}

Delete a product

• code (path, required) — Code of the resource

/api/rest/v1/products/{code}

Get a product

• code (path, required) — Code of the resource
• with_attribute_options (query) — Return labels of attribute options in the response. (Only available since the 5.0 version)
• with_quality_scores (query) — Return product quality scores in the response. (Only available since the 5.0 version)
• with_completenesses (query) — Return product completenesses in the response. (Only available since the 6.0 version)

/api/rest/v1/products/{code}

Update/create a product

• code (path, required) — Code of the resource

/api/rest/v1/products/{code}/draft

Get a draft

• code (path, required) — Code of the resource

/api/rest/v1/products/{code}/proposal

Submit a draft for approval

• code (path, required) — Code of the resource

/api/rest/v1/published-products

Get list of published products

• search (query) — Filter published products, for more details see the Filters section
• scope (query) — Filter published product values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more details see the Filter on published product values section
• locales (query) — Filter published product values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for more details see the Filter on published product values section
• attributes (query) — Filter published product values to only return those concerning the given attributes, for more details see the Filter on product values section
• pagination_type (query) — Pagination method type, see Pagination section
• page (query, page) — Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section
• search_after (query) — Cursor when using the `search_after` pagination method type. Should never be set manually , see Pagination section
• limit (query, limit) — Number of results by page, see Pagination section
• with_count (query) — Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way

/api/rest/v1/published-products/{code}

Get a published product

• code (path, required) — Code of the resource

/api/rest/v1/reference-entities/{reference_entity_code}/records

Update/create several reference entity records

• reference_entity_code (path, required) — Code of the reference entity

/api/rest/v1/reference-entities

Get list of reference entities

• search_after (query) — Cursor when using the `search_after` pagination method type. Should never be set manually , see Pagination section

/api/rest/v1/reference-entities-media-files

Create a new media file for a reference entity or a record

• Content-type (header, required) — Equal to 'multipart/form-data', no other value allowed

/api/rest/v1/reference-entities-media-files/{code}

Download the media file associated to a reference entity or a record

• code (path, required) — Code of the resource

/api/rest/v1/reference-entities/{code}

Get a reference entity

• code (path, required) — Code of the resource

/api/rest/v1/reference-entities/{code}

Update/create a reference entity

• code (path, required) — Code of the resource

/api/rest/v1/reference-entities/{reference_entity_code}/attributes

Get the list of attributes of a given reference entity

• reference_entity_code (path, required) — Code of the reference entity

/api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options

Get a list of attribute options of a given attribute for a given reference entity

• reference_entity_code (path, required) — Code of the reference entity
• attribute_code (path, required) — Code of the attribute

/api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options/{code}

Get an attribute option for a given attribute of a given reference entity

• reference_entity_code (path, required) — Code of the reference entity
• attribute_code (path, required) — Code of the attribute
• code (path, required) — Code of the resource

/api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options/{code}

Update/create a reference entity attribute option

• reference_entity_code (path, required) — Code of the reference entity
• attribute_code (path, required) — Code of the attribute
• code (path, required) — Code of the resource

/api/rest/v1/reference-entities/{reference_entity_code}/attributes/{code}

Get an attribute of a given reference entity

• reference_entity_code (path, required) — Code of the reference entity
• code (path, required) — Code of the resource

/api/rest/v1/reference-entities/{reference_entity_code}/attributes/{code}

Update/create an attribute of a given reference entity

• reference_entity_code (path, required) — Code of the reference entity
• code (path, required) — Code of the resource

/api/rest/v1/reference-entities/{reference_entity_code}/records

Get the list of the records of a reference entity

• search (query) — Filter records of the reference entity, for more details see the Filters section
• channel (query) — Filter attribute values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more details see the Filter attribute values by channel section
• locales (query) — Filter attribute values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for more details see the Filter attribute values by locale section
• reference_entity_code (path, required) — Code of the reference entity
• search_after (query) — Cursor when using the `search_after` pagination method type. Should never be set manually , see Pagination section

/api/rest/v1/reference-entities/{reference_entity_code}/records/{code}

Update/create a record of a given reference entity

• reference_entity_code (path, required) — Code of the reference entity
• code (path, required) — Code of the resource

/api/rest/v1/system-information

Get system information