# Bluestone PIM - Production Documentation > Welcome to the Bluestone PIM developer hub. You'll find comprehensive guides and documentation to help you start working with Bluestone PIM as quickly as possible, as well as support if you get stuck. Let's jump right in! ## Guides - [Authentication](https://docs.api.bluestonepim.com/docs/authentication.md) - [Environments](https://docs.api.bluestonepim.com/docs/environments.md) - [Generate SDKs and client code from OpenAPI](https://docs.api.bluestonepim.com/docs/generate-sdks-and-client-code-from-openapi.md) - [Rate limits, retries, and backoff](https://docs.api.bluestonepim.com/docs/rate-limits-retries-and-backoff.md) - [Webhook events and delivery](https://docs.api.bluestonepim.com/docs/webhook-events-and-delivery.md) - [Build reliable AI agents on Bluestone PIM](https://docs.api.bluestonepim.com/docs/build-reliable-ai-agents-on-bluestone-pim.md) - [Use the Bluestone PIM docs MCP server](https://docs.api.bluestonepim.com/docs/use-the-bluestone-pim-docs-mcp-server.md) - [Deprecated endpoints](https://docs.api.bluestonepim.com/docs/deprecated-endpoints.md) ## API Reference - [Generate token](https://docs.api.bluestonepim.com/reference/generate-token.md): Use this endpoint to generate a bearer token. Once you have obtained the token, copy it and use it for authenticating your requests to the OAuth2 endpoints. - [Get async task status.](https://docs.api.bluestonepim.com/reference/getjobstatus.md): This operation allows users to retrieve the status of an asynchronous task using its unique task ID. It is useful for monitoring the progress of long-running or background tasks. For more detailed information on how to work with product bulk actions in Bluestone PIM, refer to our help pages [Use product bulk actions](https://help.bluestonepim.com/bulk-actions). - [Delete products attributes.](https://docs.api.bluestonepim.com/reference/deleteproductsattribute.md): This operation allows users to remove the specified attribute from selected products. For more detailed information on how to work with product bulk actions in Bluestone PIM, refer to our help pages [Use product bulk actions](https://help.bluestonepim.com/bulk-actions). - [Create new catalog or category.](https://docs.api.bluestonepim.com/reference/createcategory.md): This endpoint allows you to create a new catalog or category within Bluestone PIM. The new catalog or category ID is generated by Bluestone PIM and is included in the response headers under `resource-id`. For more detailed information on how to work with catalogs and categories in Bluestone PIM, refer to our help pages [Create and manage catalogs and categories](https://help.bluestonepim.com/catalogs-categories). - [List all catalog nodes/categories that use the attribute definition in a Category Level Attribute (CLA).](https://docs.api.bluestonepim.com/reference/findbycategorylevelattributes.md): This endpoint allows you to retrieve a list of catalog nodes that use a specific attribute definition in a Category Level Attribute (CLA). For more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help pages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes). - [Describe catalog nodes/categories.](https://docs.api.bluestonepim.com/reference/getfilterednodes.md): This endpoint allows you to filter and retrieve details of catalog nodes/categories based on specified criteria. For more detailed information on how to work with catalog nodes/categories in Bluestone PIM, refer to our help pages [Catalogs and categories](https://help.bluestonepim.com/catalogs-categories). - [Delete catalog node/category structure.](https://docs.api.bluestonepim.com/reference/deletecategorynode.md): This endpoint allows you to delete a specific catalog node/category structure identified by its internal ID. For more detailed information on how to work with catalog nodes/categories in Bluestone PIM, refer to our help pages [Catalogs and categories](https://help.bluestonepim.com/catalogs-categories). - [Describe catalog node/category.](https://docs.api.bluestonepim.com/reference/getnode.md): This endpoint allows you to retrieve details of a specific catalog node/category identified by its internal ID. For more detailed information on how to work with catalog nodes/categories in Bluestone PIM, refer to our help pages [Catalogs and categories](https://help.bluestonepim.com/catalogs-categories). - [Update catalog node/category main details, supports partial update.](https://docs.api.bluestonepim.com/reference/partialupdatecatalognode.md): This endpoint allows you to partially update specific fields of a catalog node/category identified by its internal ID. Only the fields provided in the request will be updated, leaving other fields unchanged. - [Update catalog node/category.](https://docs.api.bluestonepim.com/reference/updatecatalognode.md): This endpoint allows you to update the details of a specific catalog node/category identified by its internal ID. For more detailed information on how to work with catalog nodes/categories in Bluestone PIM, refer to our help pages [Catalogs and categories](https://help.bluestonepim.com/catalogs-categories). - [List catalog node/category child nodes/categories.](https://docs.api.bluestonepim.com/reference/getcatalognodechildren.md): Retrieve a list of child nodes/categories for the specified catalog node/category. This endpoint supports pagination and context-based filtering. For more detailed information on how to work with catalogs and categories in Bluestone PIM, refer to our help pages [Create and manage catalogs and categories](https://help.bluestonepim.com/catalogs-categories). - [Move catalog node/category to new parent.](https://docs.api.bluestonepim.com/reference/movecatalognode.md): Move the specified catalog node/category to a new parent node/category, effectively changing its position in the catalog hierarchy. For more detailed information on how to work with catalogs and categories in Bluestone PIM, refer to our help pages [Create and manage catalogs and categories](https://help.bluestonepim.com/catalogs-categories). - [Change category order.](https://docs.api.bluestonepim.com/reference/updatecatalognodeorder.md): Update the order of the specified catalog node/category within its parent node/category. This operation allows for reordering of categories. For more detailed information on how to work with catalogs and categories in Bluestone PIM, refer to our help pages [Create and manage catalogs and categories](https://help.bluestonepim.com/catalogs-categories). - [List catalog node/category path to root.](https://docs.api.bluestonepim.com/reference/getpathtonode.md): Retrieve the path from the specified catalog node/category to the root node. This endpoint provides the full hierarchy path. For more detailed information on how to work with catalogs and categories in Bluestone PIM, refer to our help pages [Create and manage catalogs and categories](https://help.bluestonepim.com/catalogs-categories). - [List catalog node/category products.](https://docs.api.bluestonepim.com/reference/getcategoryproducts.md): List all products associated with the specified catalog node/category. This endpoint supports pagination and can filter by archive state and context. For more detailed information on managing products in Bluestone PIM, refer to the [Create new products](https://help.bluestonepim.com/add-new-products) and [Search your products](https://help.bluestonepim.com/search-your-products) articles. - [Add product to the catalog node/category.](https://docs.api.bluestonepim.com/reference/addcategoryproducts.md): Add a product to the specified catalog node/category. This operation assigns the product to the catalog node/category, making it part of the catalog node's/category's product list. For more detailed information on managing products in Bluestone PIM, refer to the [Create new products](https://help.bluestonepim.com/add-new-products) and [Search your products](https://help.bluestonepim.com/search-your-products) articles. - [Remove product from the catalog node/category.](https://docs.api.bluestonepim.com/reference/deletecategoryproducts.md): Remove a product from the specified catalog node/category. This operation disassociates the product from the catalog node/category, removing it from the catalog node's/category's product list. For more detailed information on managing products in Bluestone PIM, refer to the [Create new products](https://help.bluestonepim.com/add-new-products) and [Search your products](https://help.bluestonepim.com/search-your-products) articles. - [Get policy by category node id.](https://docs.api.bluestonepim.com/reference/getpolicybycategorynodeid.md): Retrieve the policies associated with a specific catalog node. This endpoint supports pagination and allows filtering by context. For more detailed information on how to work with access management in Bluestone PIM, refer to our help pages [Access management](https://help.bluestonepim.com/access-management). - [Add policy to products for category node id.](https://docs.api.bluestonepim.com/reference/addpolicytoproductsforcategorynodeid.md): Add a policy to all products associated with the specified catalog node. This operation assigns the policy to the products, enforcing the defined rules and permissions. For more detailed information on how to work with access management in Bluestone PIM, refer to our help pages [Access management](https://help.bluestonepim.com/access-management). - [Delete policy from products for category node id.](https://docs.api.bluestonepim.com/reference/deletepolicyfromproductsforcategorynodeid.md): Remove a policy from all products associated with the specified catalog node. This operation removes the policy, revoking the defined rules and permissions. For more detailed information on how to work with access management in Bluestone PIM, refer to our help pages [Access management](https://help.bluestonepim.com/access-management). - [Get policy by category id.](https://docs.api.bluestonepim.com/reference/getpolicybycategoryid.md): Retrieve the policies associated with a specific category by its internal ID. This operation allows users to access policies applied to a category, including read and write permissions. For more detailed information on how to work with access management in Bluestone PIM, refer to our help pages [Access management](https://help.bluestonepim.com/access-management). - [Add policy to products for category id.](https://docs.api.bluestonepim.com/reference/addpolicytoproductsforcategoryid.md): Assign a new policy to products within a specific category by its internal ID. This operation allows users to add read or write permissions to products in a category. For more detailed information on how to work with access management in Bluestone PIM, refer to our help pages [Access management](https://help.bluestonepim.com/access-management). - [Delete policy from products for category id.](https://docs.api.bluestonepim.com/reference/deletepolicyfromproductsforcategoryid.md): Remove a specific policy from products within a category by its internal ID and policy ID. This operation allows users to delete read or write permissions from products in a category. For more detailed information on how to work with access management in Bluestone PIM, refer to our help pages [Access management](https://help.bluestonepim.com/access-management). - [Get catalog node by policy id.](https://docs.api.bluestonepim.com/reference/getcatalognodebypolicyid.md): Retrieves a list of catalog nodes associated with a specific policy ID, with support for pagination and context filtering. For more detailed information on how to work with access management in Bluestone PIM, refer to our help pages [Access management](https://help.bluestonepim.com/access-management). - [Get categories by policy id.](https://docs.api.bluestonepim.com/reference/getcatalogbypolicyid.md): Retrieves a list of categories associated with a specific policy ID, with support for pagination and context filtering. For more detailed information on how to work with access management in Bluestone PIM, refer to our help pages [Access management](https://help.bluestonepim.com/access-management). - [Get policies by attribute definition ID.](https://docs.api.bluestonepim.com/reference/getbydefinitionid.md): Retrieves access management policies associated with the specified attribute definition ID. This operation helps in managing access and permissions for attribute definitions. For more detailed information on how to work with access management in Bluestone PIM, refer to our help pages [Access management](https://help.bluestonepim.com/access-management) and [Roles and policies management](https://help.bluestonepim.com/roles-and-policies-management#policies-overview). - [Add policy to attribute definition.](https://docs.api.bluestonepim.com/reference/addpolicytoattributedefinition.md): Adds a new policy to the specified attribute definition. This operation allows for fine-grained access control and management of attribute definitions. For more detailed information on how to work with access management in Bluestone PIM, refer to our help pages [Access management](https://help.bluestonepim.com/access-management) and [Roles and policies management](https://help.bluestonepim.com/roles-and-policies-management#policies-overview). - [Delete policy for attribute definition.](https://docs.api.bluestonepim.com/reference/deletepolicyforattributedefinition.md): Deletes a specified policy from the attribute definition. Useful for managing and updating access controls for attribute definitions. For more detailed information on how to work with access management in Bluestone PIM, refer to our help pages [Access management](https://help.bluestonepim.com/access-management) and [Roles and policies management](https://help.bluestonepim.com/roles-and-policies-management#policies-overview). - [Get attribute definitions by policy ID.](https://docs.api.bluestonepim.com/reference/getattributedefinitionsbypolicyid.md): Retrieves a list of attribute definitions associated with a specific policy ID, with support for pagination and context filtering. For more detailed information on how to work with access management in Bluestone PIM, refer to our help pages [Access management](https://help.bluestonepim.com/access-management) and [Roles and policies management](https://help.bluestonepim.com/roles-and-policies-management#policies-overview). - [Create new product.](https://docs.api.bluestonepim.com/reference/createproduct.md): Creates a new product in the system. The product's ID is generated by Bluestone PIM and is included in the response headers under `resource-id`. For more detailed information on how to work with new products in Bluestone PIM, refer to our help pages [Create new products](https://help.bluestonepim.com/add-new-products). **Variant Attribute Configuration Validation** When creating a product of type `GROUP`, variant-defining attributes must be properly configured. This error occurs when a product of type GROUP contains variant-defining attributes that are not configured to be propagated to its variants. Attributes marked as `definingAttributes`, `locked` or `mandatory` require `copy = true`. If `copy` is set to `false` (or omitted), the configuration becomes inconsistent and the request is rejected with HTTP 400 Bad Request. The response lists the attribute definition IDs that violate this rule. - [Archive products by IDs.](https://docs.api.bluestonepim.com/reference/archiveproductsbyids.md): Archive multiple products identified by their IDs. Archiving a product will make it inactive in the system. For more information on key concepts like product statuses in Bluestone PIM, refer to our help pages. - [Create a copy of product.](https://docs.api.bluestonepim.com/reference/copyandupdateproduct.md): This endpoint allows you to create a copy of a specified product and update it. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api). - [Get products using cursor with details from given views.](https://docs.api.bluestonepim.com/reference/getproductswithcursorandviews.md): This endpoint allows users to retrieve a list of products with views\* using a cursor for pagination. It is useful for efficiently managing large result sets by retrieving a specific page of the results. \*A view is a subset of product data, like `METADATA`, `ATTRIBUTES`, `ASSETS` and `CATEGORIES` to be included in the response, if no views are specified in the request, only product IDs will be returned. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api). - [Show list of products filtered by type with details from given views.](https://docs.api.bluestonepim.com/reference/listproductsviewsbytypes.md): This endpoint allows you to retrieve a list of products filtered by type, providing details from specified views. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api). - [Show list of products filtered by asset ids with details from given views.](https://docs.api.bluestonepim.com/reference/listproductsviewsbyassets.md): This endpoint allows you to retrieve a list of products filtered by asset IDs, providing details from specified views\*. \*A view is a subset of product data, like `METADATA`, `ATTRIBUTES`, `ASSETS` and `CATEGORIES` to be included in the response, if no views are specified in the request, only product IDs will be returned. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api). - [Show list of products filtered by ids with details from given views.](https://docs.api.bluestonepim.com/reference/listproductsviewsbyids.md): This endpoint allows you to retrieve a list of products filtered by IDs, providing details from specified views. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api). - [Show list of products filtered by numbers with details from given views.](https://docs.api.bluestonepim.com/reference/listproductsviewsbynumbers.md): This endpoint allows you to retrieve a list of products filtered by numbers, providing details from specified views. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api). - [[DEPRECATED; EOL 2026-11-10] Change products state by ids.](https://docs.api.bluestonepim.com/reference/changestatusesbyids.md): This endpoint allows you to change the state of multiple products identified by their IDs. For more information on key concepts like product statuses in Bluestone PIM, refer to our help pages [Overview of key components](https://help.bluestonepim.com/overview-of-key-components). **Note:** This endpoint is available only for organizations not migrated to the new sync. - [Unarchive products by ids.](https://docs.api.bluestonepim.com/reference/unarchiveproductsbyids.md): Unarchives a set of products identified by their internal IDs. This operation is useful for restoring products that were previously archived. For more information on key concepts like product statuses in Bluestone PIM, refer to our help pages [Overview of key components](https://help.bluestonepim.com/overview-of-key-components). - [Show product details.](https://docs.api.bluestonepim.com/reference/getproduct.md): This operation allows users to access detailed information about a product, including its attributes, categories, relations, assets, and more. If the product with the specified ID does not exist, a 404 error will be returned. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api). - [Update product main details, supports partial update.](https://docs.api.bluestonepim.com/reference/updateproduct.md): This endpoint allows you to modify the name, number and/or the description of a product. Supports partial updates. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api). - [Create a copy of product.](https://docs.api.bluestonepim.com/reference/copyproduct.md): This endpoint allows you to create a copy of an existing product in the system. The new product's ID is generated by Bluestone PIM and is included in the response headers under `resource-id`. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api). - [Show product filtered by id with view.](https://docs.api.bluestonepim.com/reference/findproductviewsbyid.md): This endpoint allows you to retrieve a product filtered by its ID, providing details from specified views\*. \*A view is a subset of product data, like `METADATA`, `ATTRIBUTES`, `ASSETS` and `CATEGORIES` to be included in the response, if no view is specified in the request, an error will be returned. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api). - [Show product overview.](https://docs.api.bluestonepim.com/reference/productoverview.md): This endpoint allows you to retrieve an overview of a product, providing a summary of key product information. The overview includes essential details about the product without the full data set. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api). - [[DEPRECATED; EOL 2026-11-10] Change products state.](https://docs.api.bluestonepim.com/reference/changestatus.md): Change the state of a product, such as publishing, unpublishing, archiving, unarchiving, syncing, connecting, or disconnecting. For more information on key concepts like product statuses in Bluestone PIM, refer to our help pages [Overview of key components](https://help.bluestonepim.com/overview-of-key-components). **Note:** This endpoint is available only for organizations not migrated to the new sync. - [Validates attribute definitions.](https://docs.api.bluestonepim.com/reference/validateattribute.md): This endpoint allows you to validate attribute definitions for a product. - [[DEPRECATED; EOL 2026-12-20] Validates list of products.](https://docs.api.bluestonepim.com/reference/validateproducts.md): This endpoint is deprecated and will be removed soon. For product validation, please use endpoint from bs-core-completeness-score service: POST /validations/product/attribute Validate product attribute. - [Validates attribute value.](https://docs.api.bluestonepim.com/reference/validatevalue.md): This endpoint allows you to validate a single attribute value for a product. - [Add products as children of category.](https://docs.api.bluestonepim.com/reference/assignproductstocategory.md): This endpoint allows you to add multiple products to a specified category. For more details on working with products and categories, refer to the [Product details panel>Categories](https://help.bluestonepim.com/product-details-overview#Categoriestab). - [List of category IDs the product resides in.](https://docs.api.bluestonepim.com/reference/getproductscategories.md): This operation allows you to retrieve a list of category IDs that the specified product resides in. For more details on working with products and categories, refer to the [Product details panel>Categories](https://help.bluestonepim.com/product-details-overview#Categoriestab). - [Add product to categories.](https://docs.api.bluestonepim.com/reference/addproducttocategories.md): This operation allows you to add the specified product to multiple categories. For more details on working with products and categories, refer to the [Product details panel>Categories](https://help.bluestonepim.com/product-details-overview#Categoriestab). - [Remove product from category.](https://docs.api.bluestonepim.com/reference/removeproductfromcategory.md): This operation allows you to remove the specified product from the specified category. For more details on working with products and categories, refer to the [Product details panel>Categories](https://help.bluestonepim.com/product-details-overview#Categoriestab). - [List all Catalog or Category attributes.](https://docs.api.bluestonepim.com/reference/getattributesassociatedtocategory.md) - [Unassigns an attribute from Catalog/Category.](https://docs.api.bluestonepim.com/reference/unassigndefinitionfromcategory.md) - [Assigns an attribute to Catalog/Category.](https://docs.api.bluestonepim.com/reference/assigndefinitiontocategory.md) - [Sets the value of a dictionary Catalog or Category attribute.](https://docs.api.bluestonepim.com/reference/setdictionarydefinitionvalue.md) - [Sets the value of a select/multiselect Catalog or Category attribute.](https://docs.api.bluestonepim.com/reference/setselectdefinitionvalue.md) - [Sets the value of a simple Catalog or Category attribute.](https://docs.api.bluestonepim.com/reference/setsimpledefinitionvalue.md) - [List all product templates.](https://docs.api.bluestonepim.com/reference/findproducttemplates.md): Retrieves a list of all product templates available in the system. This is useful for managing and utilizing product templates for creating new products. For more detailed information on using product templates in Bluestone PIM, refer to the [Product templates documentation](https://help.bluestonepim.com/create-product-from-saved-template-1). - [Delete product template.](https://docs.api.bluestonepim.com/reference/deleteproducttemplate.md): Deletes the specified product template identified by its ID. This can be useful for removing outdated or unused templates. For more detailed information on managing product templates in Bluestone PIM, refer to the [Product templates documentation](https://help.bluestonepim.com/create-product-from-saved-template-1). - [Show details of product template.](https://docs.api.bluestonepim.com/reference/getproducttemplate.md): Retrieves the details of a specific product template identified by its ID. This is useful for viewing and managing the configuration of product templates. For more detailed information on using product templates in Bluestone PIM, refer to the [Product templates documentation](https://help.bluestonepim.com/create-product-from-saved-template-1). - [Create product template.](https://docs.api.bluestonepim.com/reference/createproducttemplate.md): Creates a new product template in the system by "marking"/referencing a specified product as being a template. **Note**: The template feature is referencing the product. This means that updates on the template product will be copied to any new products created based on this template. Existing products created from this template are unaffected by any later changes. A product can only be "marked"/referenced as template once, an error will be returned if one tries to create a new template for a product that is already "marked"/referenced as a template. For more detailed information on creating product templates in Bluestone PIM, refer to the [Product templates documentation](https://help.bluestonepim.com/create-product-from-saved-template-1). - [Update product template name.](https://docs.api.bluestonepim.com/reference/updatename.md): Updates the name of the specified product template identified by its ID. This can be useful for modifying existing template names to reflect changes in product configurations. For more detailed information on managing product templates in Bluestone PIM, refer to the [Product templates documentation](https://help.bluestonepim.com/create-product-from-saved-template-1). - [Show all relations with directions for the product.](https://docs.api.bluestonepim.com/reference/getproductrelations.md): This operation allows you to retrieve all relations with directions for the specified product. The direction of the relation can be either `DIRECT` or `REVERSE`. For more details on working with products and relations, refer to the [Add product relations](https://help.bluestonepim.com/add-a-relation-to-a-product). - [Create new relation between two products.](https://docs.api.bluestonepim.com/reference/createproductconnection.md): This operation allows you to create a new relation between two products. For more details on working with products and relations, refer to the [Add product relations](https://help.bluestonepim.com/add-a-relation-to-a-product). - [Update a product relations sorting order source.](https://docs.api.bluestonepim.com/reference/updaterelatedproductsrelationsortingordersource.md): This operation allows you to update the source of the ordering of product relation definitions. This is relevant when a product has multiple relation definitions added to it and one wants to control the exact ordering of them. Either the relation definitions are sorted by the order they are in the general list of relation definitions, or they are sorted in the order they are in the current product identified by `id`. For example: If a product has two relation definitions added to it like: - "Contains" - "Spare part of" The order to use when listing these two relation definitions can be set to follow either the ordering in the general list of relation definitions (source = `RELATION_DEFINITION`) or the ordering in the list of relation definitions stored on the product itself (source = `PRODUCT`). - [Delete all product relations based on a specified product and relation.](https://docs.api.bluestonepim.com/reference/deleteproductconnectionsbyrelation.md): This operation allows you to delete all product relations based on the specified product and relation. For more details on working with products and relations, refer to the [Add product relations](https://help.bluestonepim.com/add-a-relation-to-a-product). - [Retrieve related products for given product and relation.](https://docs.api.bluestonepim.com/reference/getproductforrelation.md): This operation allows you to retrieve related products for a given product, relation and direction. For more details on working with products and relations, refer to the [Add product relations](https://help.bluestonepim.com/add-a-relation-to-a-product). - [Create new relations between multiple products.](https://docs.api.bluestonepim.com/reference/createproductconnections.md): This operation allows you to create new relations between a product and multiple other products for a specified relation definition. **Note**: If any of the specified other products already are related to the product using the specified relation definition, a HTTP 400 will be returned and no new relations will be created. For more details on working with products and relations, refer to the [Add product relations](https://help.bluestonepim.com/add-a-relation-to-a-product). - [Remove multiple product relations from a specified product and relation.](https://docs.api.bluestonepim.com/reference/deletemanyproductconnections.md): This operation allows you to remove multiple product relations from the specified product and relation. For more details on working with products and relations, refer to the [Add product relations](https://help.bluestonepim.com/add-a-relation-to-a-product). - [Update the order of relation definitions on product.](https://docs.api.bluestonepim.com/reference/updateorderproductrelation.md): This endpoint allows you to update the order of relation definitions for a given product by specifying the product, a relation and its target position. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api). - [Delete relation between two products.](https://docs.api.bluestonepim.com/reference/deleteproductconnection.md): This endpoint allows you to delete the relation between two products for a specified relation. For more information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api). - [Update the order of products in a product relation.](https://docs.api.bluestonepim.com/reference/updateorderproductconnections.md): This endpoint allows you to update the order of the products in a relation definition on the specified product by also specifying one of the related products and a wished for target position. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api). - [Update connection quantity.](https://docs.api.bluestonepim.com/reference/updateconnectionquantity.md) - [Add attribute values in given set of products.](https://docs.api.bluestonepim.com/reference/addattributesbyids.md): This endpoint allows users to add attribute values for a specified attribute definition to a given set of products. It is useful for bulk operations where attributes need to be added to multiple products. For more detailed information on working with bulk operations in Bluestone PIM, refer to our help pages [Use product bulk actions](https://help.bluestonepim.com/bulk-actions). - [Upsert attribute values in given set of products.](https://docs.api.bluestonepim.com/reference/upsertattributesbyids.md): This endpoint allows users to upsert (update or insert) attribute values in a given set of products. It is useful for bulk operations where attributes need to be added or updated in multiple products. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api). - [Update attribute values in given set of products.](https://docs.api.bluestonepim.com/reference/updateattributesbyids.md): This endpoint allows users to update attribute values in a given set of products. It is useful for bulk operations where attributes need to be updated in multiple products. For more detailed information on working with bulk operations in Bluestone PIM, refer to our help pages [Use product bulk actions](https://help.bluestonepim.com/bulk-actions). - [Append dictionary value to products.](https://docs.api.bluestonepim.com/reference/appenddictionaryvalues.md): This endpoint allows you to add dictionary values to the selected products. Useful for bulk operations when you need to add dictionary values to multiple products. For details about bulk operations, see [Use product bulk actions](https://help.bluestonepim.com/bulk-actions). - [Deduct dictionary value from products.](https://docs.api.bluestonepim.com/reference/deductdictionaryvalues.md): This endpoint allows you to remove dictionary values from the selected products. Useful for bulk operations when you need to remove dictionary values from multiple products. For details about bulk operations, see [Use product bulk actions](https://help.bluestonepim.com/bulk-actions). - [Append select/multiselect values to products.](https://docs.api.bluestonepim.com/reference/appendselectvalues.md): This endpoint allows you to add select/multiselect values to the selected products. Useful for bulk operations when you need to add select/multiselect values to multiple products. For details about bulk operations, see [Use product bulk actions](https://help.bluestonepim.com/bulk-actions). - [Deduct select/multiselect values from products.](https://docs.api.bluestonepim.com/reference/deductselectvalues.md): This endpoint allows you to remove select or multiselect values from the selected products. Useful for bulk operations when you need to remove select/multiselect values from multiple products. For more details on bulk operations, see Use product bulk actions. - [Retrieve the attributes associated with a product.](https://docs.api.bluestonepim.com/reference/getproductattributes.md): This operation allows users to retrieve a list of attributes associated with a specified product. The attributes are identified by their unique definitionIds. If the product with the specified ID does not exist, a 404 error will be returned. - [Add an attribute to a product.](https://docs.api.bluestonepim.com/reference/addproductattribute.md): Add a new attribute to a specified product. For more information, refer to the [Create, edit or remove attributes](https://help.bluestonepim.com/edit-attributes) article. - [Upsert many attributes on a product.](https://docs.api.bluestonepim.com/reference/updateproductattributes.md): Upsert multiple attributes for a specified product. For more information, refer to the [Create, edit or remove attributes](https://help.bluestonepim.com/edit-attributes) article. - [Add column attribute to product.](https://docs.api.bluestonepim.com/reference/addcolumnattribute.md): Use this endpoint to add a column attribute to a product in Bluestone PIM. You can specify the attribute values, context, and whether to use a fallback for context. For more details, refer to the [Create, edit or remove attributes](https://help.bluestonepim.com/edit-attributes). - [Update column attribute of product.](https://docs.api.bluestonepim.com/reference/updatecolumnattribute.md): Use this endpoint to update a column attribute of a product in Bluestone PIM. You can specify the updated attribute values, context, and whether to use a fallback for context. For more details, refer to the [Create, edit or remove attributes](https://help.bluestonepim.com/edit-attributes). - [Add dictionary attribute to product.](https://docs.api.bluestonepim.com/reference/adddictionaryattribute.md): Add a new dictionary attribute to a specified product. For more information, refer to the [Create, edit or remove attributes](https://help.bluestonepim.com/edit-attributes) article. - [Set values for dictionary attribute of product.](https://docs.api.bluestonepim.com/reference/setdictionaryattributevaluesforproduct.md): Set values for a dictionary attribute for a specified product. For more information, refer to the [Create, edit or remove attributes](https://help.bluestonepim.com/edit-attributes) article. - [Add matrix attribute to product.](https://docs.api.bluestonepim.com/reference/addmatrixattribute.md): Add a new matrix attribute to a specified product. For more information, refer to the [Create, edit or remove attributes](https://help.bluestonepim.com/edit-attributes) article. - [Update matrix attribute of product.](https://docs.api.bluestonepim.com/reference/updatematrixattribute.md): Update an existing matrix attribute for a specified product. For more information, refer to the [Create, edit or remove attributes](https://help.bluestonepim.com/edit-attributes) article. - [Delete product attribute.](https://docs.api.bluestonepim.com/reference/deleteproductattribute.md): Use this endpoint to remove a specified attribute from a product. For more details, refer to the [Create, edit or remove attributes](https://help.bluestonepim.com/edit-attributes) article. - [Update product attribute.](https://docs.api.bluestonepim.com/reference/updateproductattribute.md): Use this endpoint to update a product attribute in Bluestone PIM. You can specify the updated attribute values, context, and whether to use a fallback for context. For more details, refer to the [Create, edit or remove attributes](https://help.bluestonepim.com/edit-attributes) article. - [Get grouped product attributes.](https://docs.api.bluestonepim.com/reference/getgroupedproductattributes.md): This endpoint allows you to retrieve attribute groups with child attributes for a specified product. The grouped attributes provide a consolidated view of the product's attributes, considering the specified context and archive state. For more information, refer to the [Create, edit or remove attributes](https://help.bluestonepim.com/edit-attributes) article. - [List all Category Level Attributes (CLA).](https://docs.api.bluestonepim.com/reference/list.md): This endpoint allows you to retrieve a list of all Category Level Attributes (CLA) with optional filtering and pagination support. For more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help pages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes). - [List only Category Level Attributes (CLA) attached to given catalog node/category.](https://docs.api.bluestonepim.com/reference/listattributesattachedtogivennode.md): This operation retrieves a list of Category Level Attributes (CLA) that are specifically attached to a given catalog node/category. It provides detailed information about each attribute associated with the node. For more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help pages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes). - [Delete Category Level Attribute (CLA) from catalog node/category.](https://docs.api.bluestonepim.com/reference/deleteattributefromnode.md): This operation removes a specified Category Level Attribute (CLA) from a catalog node/category. Once deleted, the attribute will no longer be associated with the catalog node/category. For more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help pages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes). - [Update Category Level Attribute (CLA) and schedule propagation task.](https://docs.api.bluestonepim.com/reference/updatenodeattributevalue.md): This operation updates the value of a specified Category Level Attribute (CLA) and schedules a task to propagate the change. The attribute value will be updated, and the change will be reflected across relevant nodes. Propagation means that the CLA will be added to all products in the category and all underlying subcategories. For more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help pages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes). - [Create a Category Level Attribute (CLA) and schedule propagation task.](https://docs.api.bluestonepim.com/reference/createcatalognodeattribute.md): This operation creates a new Category Level Attribute (CLA) for a specified catalog node/category and schedules a task to propagate the change. The CLA will be created, and the change will be reflected across relevant nodes. Propagation means that the CLA will be added to all products in the category and all underlying subcategories. For more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help pages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes). - [Create column Category Level Attribute (CLA) and schedule propagation task.](https://docs.api.bluestonepim.com/reference/createcatalognodeattributecolumn.md): Creates a new column Category Level Attribute (CLA) for the specified catalog node/category and schedules a propagation task. This operation is useful for managing attributes across multiple catalog nodes efficiently. Propagation means that the CLA will be added to all products in the category and all underlying subcategories. For more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help pages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes). - [Update column Category Level Attribute (CLA) and schedule propagation task.](https://docs.api.bluestonepim.com/reference/updatenodeattributecolumnvalue.md): Updates the specified column Category Level Attribute (CLA) for the catalog node/category and schedules a propagation task. This operation is useful for maintaining consistency across catalog nodes. Propagation means that the CLA will be added to all products in the category and all underlying subcategories. For more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help pages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes). - [Create compound Category Level Attribute (CLA) and schedule propagation task.](https://docs.api.bluestonepim.com/reference/createcatalognodeattributecompound.md): Creates a new compound Category Level Attribute (CLA) for the specified catalog node/category and schedules a propagation task. This operation is useful for managing complex attributes across multiple catalog nodes efficiently. Propagation means that the CLA will be added to all products in the category and all underlying subcategories. For more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help pages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes). - [Create dictionary Category Level Attribute (CLA) and schedule propagation task.](https://docs.api.bluestonepim.com/reference/createcatalognodeattributedictionary.md): Creates a new dictionary Category Level Attribute (CLA) for the specified catalog node/category and schedules a propagation task. This operation is useful for managing dictionary attributes across multiple catalog nodes efficiently. Propagation means that the CLA will be added to all products in the category and all underlying subcategories. For more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help pages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes). - [Set values for dictionary Category Level Attribute (CLA) and schedule propagation task.](https://docs.api.bluestonepim.com/reference/setdictionaryattributevaluesforcategory.md): Sets the values for a dictionary Category Level Attribute (CLA) for the specified catalog node/category and schedules a propagation task. This operation is useful for managing dictionary attribute values across multiple catalog nodes efficiently. Propagation means that the CLA will be added to all products in the category and all underlying subcategories. For more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help pages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes). - [Create matrix Category Level Attribute (CLA) and schedule propagation task.](https://docs.api.bluestonepim.com/reference/createcatalognodeattributematrix.md): Creates a new matrix Category Level Attribute (CLA) for the specified catalog node/category and schedules a propagation task. This operation is useful for managing matrix attributes across multiple catalog nodes efficiently. Propagation means that the CLA will be added to all products in the category and all underlying subcategories. For more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help pages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes). - [Update matrix Category Level Attribute (CLA) and schedule propagation task.](https://docs.api.bluestonepim.com/reference/updatenodeattributematrixvalue.md): Updates the specified matrix Category Level Attribute (CLA) for the catalog node/category and schedules a propagation task. This operation is useful for maintaining consistency across catalog nodes. Propagation means that the CLA will be added to all products in the category and all underlying subcategories. For more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help pages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes). - [Show all relation definitions.](https://docs.api.bluestonepim.com/reference/findrelations.md): Show all relation definitions available in the organization. This endpoint allows you to retrieve a list of relation definitions, optionally filtering by context and using pagination to manage large result sets. For more detailed information on how to work with relation definitions in Bluestone PIM, refer to our help pages [The data model > Relations](https://help.bluestonepim.com/the-data-model#relations). - [Create new relation definition.](https://docs.api.bluestonepim.com/reference/createrelation.md): Create a new relation definition. The ID for the new relation definition is generated by Bluestone PIM and included in the response headers under `resource-id`. For more detailed information on how to work with relation definitions in Bluestone PIM, refer to our help pages [The data model > Relations](https://help.bluestonepim.com/the-data-model#relations). - [Filter relation definitions.](https://docs.api.bluestonepim.com/reference/getfilteredrelations.md): Filter relation definitions based on specified criteria. This endpoint allows you to retrieve a list of relation definitions that match the given filters. **Note**: For a relation definitions to be found it needs to map to at least one of the values in each object in the filters array. **Example**: Imagine if we have these two relation definitions: Relation definition: `Contains` - Number: `contains-relation` - ID: `64ef9336bec72f3271090e97` Relation definition: `Spare part of` - Number: `spare-part-of-relation` - ID: `64ef9336bec72f3271090e98` And then we filter on the criteria's below. Then only the relation definition `Contains` will be found since it maps to one of the values in both the `NUMBER_IN` and `ID_IN` objects. The relation definition `Spare part of` will **not** be found since it only maps to a value in the `NUMBER_IN` object but not to any value in the `ID_IN` object: ``` "filters": [ { "type": "NUMBER_IN", "values": [ "contains-relation", "spare-part-of-relation" ] }, { "type": "ID_IN", "values": [ "64ef9336bec72f3271090e97", "111111111111111111111111" ] } ] ``` For more detailed information on how to work with relation definitions in Bluestone PIM, refer to our help pages [The data model > Relations](https://help.bluestonepim.com/the-data-model#relations). - [Delete relation definition.](https://docs.api.bluestonepim.com/reference/delete.md): Delete a specific relation definition identified by its ID. For more detailed information on how to work with relation definitions in Bluestone PIM, refer to our help pages [The data model > Relations](https://help.bluestonepim.com/the-data-model#relations). - [Show relation definition details.](https://docs.api.bluestonepim.com/reference/findone.md): Retrieve the details of a specific relation definition identified by its ID. For more detailed information on how to work with relation definitions in Bluestone PIM, refer to our help pages [The data model > Relations](https://help.bluestonepim.com/the-data-model#relations). - [Update relation definition.](https://docs.api.bluestonepim.com/reference/updaterelation.md): Update the details of a specific relation definition identified by its ID. For more detailed information on how to work with relation definitions in Bluestone PIM, refer to our help pages [The data model > Relations](https://help.bluestonepim.com/the-data-model#relations). - [Update relation definition order.](https://docs.api.bluestonepim.com/reference/updateorderrelation.md): Update the order of a specific relation definition identified by its ID. For more detailed information on how to work with relation definitions in Bluestone PIM, refer to our help pages [The data model > Relations](https://help.bluestonepim.com/the-data-model#relations). - [Show all product relations using relation definition.](https://docs.api.bluestonepim.com/reference/getproductconnectionsbyrelationid.md): Retrieve the product relations associated with a specific relation definition. For more detailed information on how to work with relation definitions in Bluestone PIM, refer to our help pages [The data model > Relations](https://help.bluestonepim.com/the-data-model#relations). For more details on working with products and relations, refer to the [Add product relations](https://help.bluestonepim.com/add-a-relation-to-a-product). - [Lists details of compound attribute definition.](https://docs.api.bluestonepim.com/reference/findallcompounddefinitions.md): Retrieve a list of compound attribute definitions with pagination support. This operation allows users to access details of compound attributes, including their names and descriptions. For more detailed information on managing compound attributes, refer to our help pages [Attribute types - Compound](https://help.bluestonepim.com/attribute-types-1#compound). - [Create compound attribute definition.](https://docs.api.bluestonepim.com/reference/createcompounddefinition.md): Create a new compound attribute definition. This operation allows users to define new attributes that are combinations of existing ones. For more detailed information on managing compound attributes, refer to our help pages [Attribute types - Compound](https://help.bluestonepim.com/attribute-types-1#compound). - [List all compound attributes that use the attribute definition.](https://docs.api.bluestonepim.com/reference/findbysubdefinitions.md): List all compound attributes that use the specified attribute definition. This endpoint helps in retrieving compound attributes that are associated with the given attribute definition ID. For more detailed information on managing compound attributes, refer to our help pages [Attribute types - Compound](https://help.bluestonepim.com/attribute-types-1#compound). - [Delete compound attribute definition.](https://docs.api.bluestonepim.com/reference/deletecompounddefinition.md): Deletes a specific compound attribute definition identified by its internal ID. For more detailed information on managing compound attributes, refer to our help pages [Attribute types - Compound](https://help.bluestonepim.com/attribute-types-1#compound). - [Show details of compound attribute definition.](https://docs.api.bluestonepim.com/reference/getcompounddefinition.md): Retrieve detailed information about a specific compound attribute definition using its internal ID. For more detailed information on managing compound attributes, refer to our help pages [Attribute types - Compound](https://help.bluestonepim.com/attribute-types-1#compound). - [Update compound attribute definition.](https://docs.api.bluestonepim.com/reference/updatecompounddefinition.md): Update an existing compound attribute definition using its internal ID. This endpoint allows modifying the definition's properties and validation strategies. For more detailed information on managing compound attributes, refer to our help pages [Attribute types](https://help.bluestonepim.com/attribute-types-1#compound). - [Assign multiple product variants to a variant group.](https://docs.api.bluestonepim.com/reference/addproductvariants.md): Assigns the specified products as variants of the parent variant group product. For more detailed information on how to work with the data model in Bluestone PIM, refer to our help pages [The data model](https://help.bluestonepim.com/the-data-model). - [Create variant group.](https://docs.api.bluestonepim.com/reference/setproductgroup.md): Creates a variant group for the specified product. This operation helps in managing variants and variant groups effectively. For more detailed information on how to work with variants and variant groups in Bluestone PIM, refer to our help pages [Create and connect variants](https://help.bluestonepim.com/create-and-connect-variants). - [Retrieve variant level attribute (VLA).](https://docs.api.bluestonepim.com/reference/getproductvariantattribute.md): Retrieve the details of a specific variant level attribute (VLA) set in a variant group product. Variant Level Attribute (VLA) is a product attribute used to manage product variations like size or color. For more detailed information on how to work with Variant Level Attributes (VLA) in Bluestone PIM, refer to our help pages [The data model - Variant Level Attribute (VLA)](https://help.bluestonepim.com/the-data-model#VLA). - [Update variant level attribute (VLA).](https://docs.api.bluestonepim.com/reference/updateproductvariantattribute.md): Updates the specified variant level attribute (VLA) for a variant group. For more detailed information on how to work with Variant Level Attributes (VLA) in Bluestone PIM, refer to our help pages [The data model - Variant Level Attribute (VLA)](https://help.bluestonepim.com/the-data-model#VLA). **Variant Attribute Configuration Validation** Variant-defining attributes must be properly configured to be propagated to variants. This error occurs when a variant level attribute is not configured to be propagated to its variants. Attributes marked as `definingAttributes`, `locked` or `mandatory` require `copy = true`. If `copy` is set to `false` (or omitted), the configuration becomes inconsistent and the request is rejected with HTTP 400 Bad Request. - [Unassign product variant.](https://docs.api.bluestonepim.com/reference/unassignproductvariant.md): Unassigns the specified variant from the given variant group product. For more detailed information on how to work with the data model in Bluestone PIM, refer to our help pages [The data model](https://help.bluestonepim.com/the-data-model). - [Assign product variant.](https://docs.api.bluestonepim.com/reference/addproductvariant.md): Assigns the specified product as a variant of the parent variant group product. For more detailed information on how to work with the data model in Bluestone PIM, refer to our help pages [The data model](https://help.bluestonepim.com/the-data-model). - [Update product variant order.](https://docs.api.bluestonepim.com/reference/moveproductvariant.md): Updates the order of the specified variant for a variant group product. This operation helps in organizing product variants and maintaining accurate product groupings. For more detailed information on how to work with the data model in Bluestone PIM, refer to our help pages [The data model](https://help.bluestonepim.com/the-data-model). - [List catalogs.](https://docs.api.bluestonepim.com/reference/listcatalogs.md): Lists all catalogs within the Bluestone PIM system. This endpoint supports pagination, archive state filtering, and context fallback. For more detailed information on managing catalogs in Bluestone PIM, refer to the [Create and manage catalogs and categories](https://help.bluestonepim.com/catalogs-categories) article. - [Archive catalog.](https://docs.api.bluestonepim.com/reference/archive.md): Archive the specified catalog. This operation marks the catalog as archived, making it inactive and preventing further modifications. For more detailed information on managing catalogs in Bluestone PIM, refer to the [Create and manage catalogs and categories](https://help.bluestonepim.com/catalogs-categories) article. - [Unarchive catalog.](https://docs.api.bluestonepim.com/reference/unarchive.md): Unarchive the specified catalog. This operation marks the catalog as active, allowing further modifications and interactions. For more detailed information on managing catalogs in Bluestone PIM, refer to the [Create and manage catalogs and categories](https://help.bluestonepim.com/catalogs-categories) article. - [List all nodes/categories from catalog.](https://docs.api.bluestonepim.com/reference/getcategorytree.md): Retrieve the entire category tree from the specified catalog. This endpoint allows you to view all nodes/categories within the catalog, supporting filtering by archive state and context. For more detailed information on managing catalogs and categories in Bluestone PIM, refer to the [Create and manage catalogs and categories](https://help.bluestonepim.com/catalogs-categories) article. - [getcategoryview](https://docs.api.bluestonepim.com/reference/getcategoryview.md) - [List all attribute groups.](https://docs.api.bluestonepim.com/reference/findattributegroups.md): This endpoint allows you to retrieve a list of all attribute groups within the Bluestone PIM system. It supports pagination to manage large result sets and can filter by context. For more detailed information on how to work with attribute definitions in Bluestone PIM, refer to our help pages [Create, edit or remove attributes](https://help.bluestonepim.com/edit-attributes). - [Create new attribute group.](https://docs.api.bluestonepim.com/reference/createattributegroup.md): This endpoint allows you to create a new attribute group within the Bluestone PIM system. It is useful for organizing attributes into logical groupings for easier management and retrieval. For more detailed information on how to create attribute group in Bluestone PIM, refer to our help pages [Create an attribute group](https://help.bluestonepim.com/edit-attributes#create-an-attribute-group). - [List definitions that are not in any group.](https://docs.api.bluestonepim.com/reference/finddefinitionswithoutgroup.md): This endpoint allows you to retrieve a list of attribute definitions that are not assigned to any group within the Bluestone PIM system. It supports pagination to manage large result sets and can filter by context. For more detailed information on how to find an attribute using the management API (MAPI) in Bluestone PIM, refer to our help pages [Find an attribute](https://help.bluestonepim.com/find-an-attribute). - [Change order strategy for definitions without group.](https://docs.api.bluestonepim.com/reference/setotherdefinitionsorderstrategy.md): This endpoint allows you to change the order strategy for attribute definitions that are not assigned to any group within the Bluestone PIM system. You can specify whether the definitions should be ordered by name. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api). - [Change attribute's order.](https://docs.api.bluestonepim.com/reference/moveattributedefinitioningroup.md): This endpoint allows you to change the order of an attribute definition within its group in the Bluestone PIM system. You can specify the target position for the attribute definition. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api). - [Get attribute root group.](https://docs.api.bluestonepim.com/reference/getattributerootgroup.md): This endpoint allows you to retrieve the root group of attributes within the Bluestone PIM system. The root group serves as the top-level container for all attribute groups. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api). - [Delete attribute group.](https://docs.api.bluestonepim.com/reference/deleteattributegroup.md): Deletes a specific attribute group identified by its internal ID. For more detailed information on how to delete an attribute group in Bluestone PIM, refer to our help pages [Delete attribute group](https://help.bluestonepim.com/edit-attributes#delete-an-attribute-group). - [Change group's order.](https://docs.api.bluestonepim.com/reference/movegroup.md): This operation allows you to change the order of an attribute group by moving it to a specified position. For more detailed information on how to edit an attribute group in Bluestone PIM, refer to our help pages [Edit an attribute group](https://help.bluestonepim.com/edit-attributes#edit-an-attribute-group). - [List definitions in attribute group.](https://docs.api.bluestonepim.com/reference/finddefinitionsingroup.md): Lists all attribute definitions within a specified attribute group. This endpoint supports pagination and context fallback. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api). - [Change order strategy for definitions in group.](https://docs.api.bluestonepim.com/reference/setdefinitionsorderstrategyingroup.md): This operation allows you to change the order strategy for attribute definitions within a specified group. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api). - [Change attribute's order in group.](https://docs.api.bluestonepim.com/reference/moveattributedefinition.md): This operation allows you to change the order of an attribute definition within a specified group by moving it to a specified position. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api). - [Rename attribute group.](https://docs.api.bluestonepim.com/reference/rename.md): This endpoint allows you to rename an attribute group within Bluestone PIM. For more detailed information on how to work with attribute definitions in Bluestone PIM, refer to our help pages [Create, edit or remove attributes](https://help.bluestonepim.com/edit-attributes). - [Change attribute group number.](https://docs.api.bluestonepim.com/reference/updatenumber.md): This endpoint allows you to update the number of an attribute group within Bluestone PIM. For more detailed information on how to work with attribute definitions in Bluestone PIM, refer to our help pages [Create, edit or remove attributes](https://help.bluestonepim.com/edit-attributes). - [Create product bundle.](https://docs.api.bluestonepim.com/reference/createproductbundle.md): Create a bundle product by specifying an existing `SINGLE` product that is to be changed into a `BUNDLE` product. For more details, refer to the [Bundles documentation](https://help.bluestonepim.com/working-with-bundles). - [Delete product from bundle.](https://docs.api.bluestonepim.com/reference/deleteproductfrombundle.md): This operation allows you to remove a complementary product from an existing product bundle. For more details, refer to the [Bundles documentation](https://help.bluestonepim.com/working-with-bundles). - [Add product to bundle.](https://docs.api.bluestonepim.com/reference/addproducttobundle.md): This operation allows you to add a complementary product to an existing product bundle. **Important note**: bundles cannot include other bundle products. For more details, refer to the [Bundles documentation](https://help.bluestonepim.com/working-with-bundles). - [Update the quantity of a product included in a bundle.](https://docs.api.bluestonepim.com/reference/updateproductbundlequantity.md): This operation allows you to update the quantity of a complementary product within an existing product bundle. For more details, refer to the [Bundles documentation](https://help.bluestonepim.com/working-with-bundles). - [Change a product's position in a bundle.](https://docs.api.bluestonepim.com/reference/moveproductinbundle.md): This operation allows you to change the position of a complementary product within an existing bundle. For more details, refer to the [Bundles documentation](https://help.bluestonepim.com/working-with-bundles). - [Retrieve the assets associated with a product.](https://docs.api.bluestonepim.com/reference/getproductassets.md): This operation allows users to retrieve a list of assets associated with a specified product. The assets are identified by their unique IDs. If the product with the specified ID does not exist, a 404 error will be returned. For more information on assets in Bluestone PIM, refer to our help pages [Assets overview](https://help.bluestonepim.com/assets-panel). - [Associate assets with a product.](https://docs.api.bluestonepim.com/reference/associateassets.md): This operation allows users to associate a list of assets with a specified product. Existing associated assets on the product will be preserved and not overwritten. If the product with the specified ID does not exist, a 404 error will be returned. For more information on assets in Bluestone PIM, refer to our help pages [Assets overview](https://help.bluestonepim.com/assets-panel). - [Set assets for a product.](https://docs.api.bluestonepim.com/reference/setproductassets.md): This operation allows users to set a list of assets for a specified product, replacing any existing associations. If the product with the specified ID does not exist, a 404 error will be returned. For more information on assets in Bluestone PIM, refer to our help pages [Assets overview](https://help.bluestonepim.com/assets-panel). - [Disassociate an asset from a product.](https://docs.api.bluestonepim.com/reference/disassociateassetfromproduct.md): This operation allows users to disassociate a specified asset from a product. If the product or asset with the specified IDs do not exist, a 404 error will be returned. For more information on assets in Bluestone PIM, refer to our help pages [Assets overview](https://help.bluestonepim.com/assets-panel). - [Associate an asset with a product.](https://docs.api.bluestonepim.com/reference/associateassetwithproduct.md): This operation allows users to associate a specified asset with a product. If the product or asset with the specified IDs do not exist, a 404 error will be returned. For more information on assets in Bluestone PIM, refer to our help pages [Assets overview](https://help.bluestonepim.com/assets-panel). - [Move an asset within a product.](https://docs.api.bluestonepim.com/reference/moveproductasset.md): This operation allows users to change the order of an asset within a specified product. If the product or asset with the specified IDs do not exist, a 404 error will be returned. For more information on assets in Bluestone PIM, refer to our help pages [Assets overview](https://help.bluestonepim.com/assets-panel). - [Get policies by category node id.](https://docs.api.bluestonepim.com/reference/getbycategorynodeid.md): Retrieve a list of policies associated with the specified catalog node. This endpoint supports pagination. For more detailed information on how to work with access management in Bluestone PIM, refer to our help pages [Access management](https://help.bluestonepim.com/access-management). - [Add policy to category node.](https://docs.api.bluestonepim.com/reference/addpolicytocategorynode.md): Add a new policy to the specified catalog node. This operation allows for the assignment of detailed permissions to the node. For more detailed information on how to work with access management in Bluestone PIM, refer to our help pages [Access management](https://help.bluestonepim.com/access-management). - [Delete policy by category node and policy id.](https://docs.api.bluestonepim.com/reference/deletepolicybycategorynodeandpolicyid.md): Delete a specific policy from the specified catalog node. This operation removes the assigned permissions for the node. For more detailed information on how to work with access management in Bluestone PIM, refer to our help pages [Access management](https://help.bluestonepim.com/access-management). - [Get policies by category id.](https://docs.api.bluestonepim.com/reference/getpoliciesbycategoryid.md): Retrieve the policies associated with a specific category by its internal ID. This operation allows users to access policies applied to a category, including read and write permissions. For more detailed information on how to work with access management in Bluestone PIM, refer to our help pages [Access management](https://help.bluestonepim.com/access-management). - [Add policy to category.](https://docs.api.bluestonepim.com/reference/addpolicytocategory.md): Assign a new policy to a specific category by its internal ID. This operation allows users to add read or write permissions to a category. For more detailed information on managing policies, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api). - [Delete policy by category and policy id.](https://docs.api.bluestonepim.com/reference/deletepolicybycategoryandpolicyid.md): Remove a specific policy from a category by its internal ID and policy ID. This operation allows users to delete read or write permissions from a category. For more detailed information on how to work with access management in Bluestone PIM, refer to our help pages [Access management](https://help.bluestonepim.com/access-management). - [Get categories by policy id.](https://docs.api.bluestonepim.com/reference/getcategoriesbypolicyid.md): Retrieves categories associated with the specified policy ID. Useful for managing access and permissions for categories. For more detailed information on how to work with access management in Bluestone PIM, refer to our help pages [Access management](https://help.bluestonepim.com/access-management). - [Get categories node by policy id.](https://docs.api.bluestonepim.com/reference/getcategoriesnodebypolicyid.md): Retrieves category nodes associated with the specified policy ID. Useful for managing access and permissions for category nodes. For more detailed information on how to work with access management in Bluestone PIM, refer to our help pages [Access management](https://help.bluestonepim.com/access-management). - [Remove product label from the set of products.](https://docs.api.bluestonepim.com/reference/removelabelfromproducts.md): This endpoint allows you to remove a specified product label from a set of products. For more detailed information on how to work with product labels in Bluestone PIM, refer to our help pages [Add/remove product labels](https://help.bluestonepim.com/bulk-actions#add-product-labels). - [Add product label to the set of products.](https://docs.api.bluestonepim.com/reference/addlabeltoproducts.md): This endpoint allows you to add a specified product label to a set of products. For more detailed information on how to work with product labels in Bluestone PIM, refer to our help pages [Add/remove product labels](https://help.bluestonepim.com/bulk-actions#add-product-labels). - [Remove labels from the product.](https://docs.api.bluestonepim.com/reference/removelabelsfromproduct.md): This endpoint allows you to remove a set of labels from the specified product. For more detailed information on how to work with product labels in Bluestone PIM, refer to our help pages [Add/remove product labels](https://help.bluestonepim.com/bulk-actions#add-product-labels). - [Retrieve product labels.](https://docs.api.bluestonepim.com/reference/getproductslabels.md): Retrieve the list of product label IDs associated with a product. This endpoint helps in managing and organizing product labels efficiently. For more detailed information on how to work with product labels in Bluestone PIM, refer to our help pages [Add/remove product labels](https://help.bluestonepim.com/bulk-actions#add-product-labels). - [Add product labels to product.](https://docs.api.bluestonepim.com/reference/addlabelstoproduct.md): Associates the specified product labels with the given product. This operation helps in tagging and categorizing products for better organization and retrieval. - [Remove product label from product.](https://docs.api.bluestonepim.com/reference/removelabelfromproduct.md): Removes the specified product label from the given product. This operation helps in updating and managing product labels to ensure accurate tagging. - [List all attribute definitions.](https://docs.api.bluestonepim.com/reference/findallattributedefinitions.md): Retrieve a list of all attribute definitions available. This endpoint supports pagination for managing large result sets. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api), [Create, edit or remove attributes](https://help.bluestonepim.com/edit-attributes) and [Attribute types](https://help.bluestonepim.com/attribute-types-1). - [Create attribute definition.](https://docs.api.bluestonepim.com/reference/createattributedefinition.md): Create a new attribute definition. The new attribute definition's ID is generated by Bluestone PIM and is included in the response headers under `resource-id`. **Example:** ```resource-id: 664cc80da825236207fe01a7``` For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api) and [Attribute types](https://help.bluestonepim.com/attribute-types-1). - [Create column attribute definition.](https://docs.api.bluestonepim.com/reference/createcolumndefinition.md): Create a new column attribute definition. The new attribute definition's ID is generated by Bluestone PIM and is included in the response headers under `resource-id`. **Example:** ```resource-id: 664cc80da825236207fe01a7``` For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api) and [Attribute types - Column](https://help.bluestonepim.com/attribute-types-1#column). - [Update column attribute definition.](https://docs.api.bluestonepim.com/reference/updatecolumndefinition.md): Update an existing column attribute definition using its internal ID. This endpoint allows modifying the definition's properties and validation strategies. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api) and [Attribute types - Column](https://help.bluestonepim.com/attribute-types-1#column). - [Show number of elements affected by the column attribute definition update operation.](https://docs.api.bluestonepim.com/reference/updatecolumndefinitiondryrun.md): This operation shows the number of elements that would be affected by the update operation of the specified column attribute definition. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api) and [Attribute types - Column](https://help.bluestonepim.com/attribute-types-1#column). - [Create dictionary attribute definition.](https://docs.api.bluestonepim.com/reference/createdictionarydefinition.md): Create dictionary attribute definition. The new attribute definition's ID is generated by Bluestone PIM and is included in the response headers under `resource-id`. **Example:** ```resource-id: 664cc80da825236207fe01a7``` For more detailed information on how to work with attribute definitions in Bluestone PIM, refer to our help pages [Create, edit or remove attributes](https://help.bluestonepim.com/edit-attributes) and [Attribute types - Dictionary](https://help.bluestonepim.com/attribute-types-1#dictionary). - [Update selected items limit for dictionary attribute definition.](https://docs.api.bluestonepim.com/reference/patchupdate.md): Update the limit of selected items for a dictionary attribute definition. This allows you to manage how many items can be selected for the given dictionary attribute. To make the dictionary act as a single select, simply set `selectedValuesLimit` to `1`. Update the 'dictionaryValuesMetadataType' property to change the type of metadata associated with the dictionary values. This allows you to define how additional information about each dictionary value is stored and represented. For example, you can specify whether the metadata should be in the form of simple text, color codes, or other formats that suit your application's needs. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api) and [Attribute types - Dictionary](https://help.bluestonepim.com/attribute-types-1#dictionary). - [Update dictionary attribute definition.](https://docs.api.bluestonepim.com/reference/updatedictionarydefinition.md): Update the details of an existing dictionary attribute definition. This endpoint allows you to modify the name, properties, and other metadata of the dictionary attribute definition. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api) and [Attribute types - Dictionary](https://help.bluestonepim.com/attribute-types-1#dictionary). - [Delete dictionary parent from dictionary definition.](https://docs.api.bluestonepim.com/reference/deletedictionaryparent.md): Remove the parent dictionary from a dictionary attribute definition. This is useful when the parent-child relationship between dictionary attribute definitions needs to be updated or removed. For more detailed information on managing dictionary attributes, refer to our help pages [Attribute types - Dictionary](https://help.bluestonepim.com/attribute-types-1#dictionary). - [Set dictionary parent for filtering dictionary values.](https://docs.api.bluestonepim.com/reference/setdictionaryparent.md): Assign a parent dictionary to the dictionary attribute definition for filtering purposes. This sets up a parent-child relationship between two dictionary attribute definitions, which can be used to filter dictionary values in the child dictionary based on selected dictionary values in the parent dictionary. **Example:** You have two dictionary attribute definitions: - `Age`, with values from 1-130 - `Age Group`, with values Child, Youth, Adult, Senior You set the `Age Group` dictionary as a parent for the `Age` dictionary with these relations: - Child -> Age: 1-14 - Youth -> Age: 15-24 - Adult -> 25-64 - Senior -> 65+ Now if the editor in Bluestone PIM chooses `Age Group` = `Youth`, then only options 15-24 will be available to choose from in the `Age` dictionary. For more detailed information on managing dictionary attributes, refer to our help pages [Attribute types - Dictionary](https://help.bluestonepim.com/attribute-types-1#dictionary). - [Create dictionary attribute value.](https://docs.api.bluestonepim.com/reference/createdictionaryattribute.md): Create a new dictionary attribute value for a dictionary attribute definition. This endpoint allows you to add a new value to the dictionary attribute definition. Dictionaries are typically used for larger pre-defined lists of values (sometimes referred to as options in other systems). Each dictionary value is an object with properties like `Name`, `Number` and `ID`, where the ID is automatically generated by Bluestone PIM on creation. For more detailed information on managing dictionary attributes, refer to our help pages [Attribute types - Dictionary](https://help.bluestonepim.com/attribute-types-1#dictionary). - [Count dictionary attribute values for given dictionary attribute definition.](https://docs.api.bluestonepim.com/reference/countdictionaryattributes.md): Retrieve the count of dictionary attribute values associated with a specific dictionary attribute definition. This endpoint helps in determining the number of attribute values linked to a particular dictionary attribute definition. For more detailed information on managing dictionary attributes, refer to our help pages [Attribute types - Dictionary](https://help.bluestonepim.com/attribute-types-1#dictionary). - [List filtered dictionary attribute definitions.](https://docs.api.bluestonepim.com/reference/findfiltereddictionaryattributes.md): Retrieve a list of dictionary attribute definitions that match specified filter criteria. This endpoint allows you to filter dictionary attribute definitions based on various parameters and return a customized list. For more detailed information on managing dictionary attributes, refer to our help pages [Attribute types - Dictionary](https://help.bluestonepim.com/attribute-types-1#dictionary). - [List filtered dictionary attribute values.](https://docs.api.bluestonepim.com/reference/findfiltereddictionarydefinitions.md): Lists filtered dictionary attribute values within the given attribute definition ID. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api). - [Delete dictionary attribute value.](https://docs.api.bluestonepim.com/reference/deletedictionaryattribute.md): Deletes a specific dictionary attribute value identified by its internal ID. For more detailed information on managing dictionary attributes, refer to our help pages [Attribute types - Dictionary](https://help.bluestonepim.com/attribute-types-1#dictionary). - [Show details of dictionary attribute value.](https://docs.api.bluestonepim.com/reference/getdictionaryattribute.md): This operation allows users to access metadata associated with a dictionary attribute value such as its name and number. If the dictionary attribute value with the specified ID does not exist, a 404 error will be returned. For more detailed information on managing dictionary attributes, refer to our help pages [Attribute types - Dictionary](https://help.bluestonepim.com/attribute-types-1#dictionary). - [Update dictionary attribute value.](https://docs.api.bluestonepim.com/reference/updatedictionaryattribute.md): Updates the details of a dictionary attribute value within the specified context. For more detailed information on managing dictionary attributes, refer to our help pages [Attribute types - Dictionary](https://help.bluestonepim.com/attribute-types-1#dictionary). - [Delete dictionary attribute value parent/child filter.](https://docs.api.bluestonepim.com/reference/deletedictionaryfilter.md): Deletes a specific dictionary attribute value parent/child filter identified by its internal ID. For more detailed information on managing dictionary attributes, refer to our help pages [Attribute types - Dictionary](https://help.bluestonepim.com/attribute-types-1#dictionary). - [Create dictionary attribute value parent/child filter.](https://docs.api.bluestonepim.com/reference/createdictionaryvaluefilter.md): Creates a dictionary attribute value parent/child filter for the specified dictionary attribute value and parent value. For more detailed information on managing dictionary attributes, refer to our help pages [Attribute types - Dictionary](https://help.bluestonepim.com/attribute-types-1#dictionary). - [List filtered attribute definitions.](https://docs.api.bluestonepim.com/reference/findfilteredattributedefinitions.md): Lists all filtered attribute definitions based on the specified criteria. For more detailed information on managing attributes, refer to our help pages [Attribute types](https://help.bluestonepim.com/attribute-types-1). - [Create matrix attribute definition.](https://docs.api.bluestonepim.com/reference/creatematrixdefinition.md): Creates a new matrix attribute definition. The new ID is generated by Bluestone PIM and is included in the response headers under `resource-id`. **Example:** ```resource-id: 664cc80da825236207fe01a7``` For more detailed information on managing matrix attributes, refer to our help pages [Attribute types - Matrix](https://help.bluestonepim.com/attribute-types-1#matrix). - [Update matrix attribute definition.](https://docs.api.bluestonepim.com/reference/updatematrixdefinition.md): This operation allows users to update the details of a matrix attribute definition within the specified context. If the attribute definition with the specified ID does not exist, a 404 error will be returned. For more detailed information on managing matrix attributes, refer to our help pages [Attribute types - Matrix](https://help.bluestonepim.com/attribute-types-1#matrix). - [Show number of elements affected by the matrix attribute definition update operation.](https://docs.api.bluestonepim.com/reference/updatematrixdefinitiondryrun.md): This operation allows users to see the number of elements affected by the matrix attribute definition update within the specified context. If the attribute definition with the specified ID does not exist, a 404 error will be returned. For more detailed information on how to work with attribute definitions in Bluestone PIM, refer to the [Create, edit or remove attributes](https://help.bluestonepim.com/edit-attributes) article. - [List simple attribute definitions.](https://docs.api.bluestonepim.com/reference/findsimple.md): Lists all simple attribute definitions with pagination support. This endpoint allows you to retrieve a list of simple attribute definitions, optionally filtering by context and using pagination to manage large result sets. For more detailed information on how to work with attribute definitions in Bluestone PIM, refer to our help pages [Create, edit or remove attributes](https://help.bluestonepim.com/edit-attributes). - [Delete simple attribute definition.](https://docs.api.bluestonepim.com/reference/deleteattributedefinition.md): Deletes a specific attribute definition identified by its internal ID. For more detailed information on how to work with attribute definitions in Bluestone PIM, refer to the [Create, edit or remove attributes](https://help.bluestonepim.com/edit-attributes) article. - [Show details of attribute definition.](https://docs.api.bluestonepim.com/reference/getattributedefinition.md): This operation allows users to access metadata associated with an attribute definition such as its name and description. If the attribute definition with the specified ID does not exist, a 404 error will be returned. For more detailed information on how to work with attribute definitions in Bluestone PIM, refer to the [Create, edit or remove attributes](https://help.bluestonepim.com/edit-attributes) article. - [Update simple attribute definition.](https://docs.api.bluestonepim.com/reference/updatemetadata.md): This endpoint allows you to modify the name and other metadata of the attribute definition within the specified context. For more detailed information on how to work with attribute definitions in Bluestone PIM, refer to the [Create, edit or remove attributes](https://help.bluestonepim.com/edit-attributes) article. - [Update simple attribute definition.](https://docs.api.bluestonepim.com/reference/updateattributedefinition.md): This endpoint allows you to modify the attribute definition within the specified context. For more detailed information on how to work with attribute definitions in Bluestone PIM, refer to the [Create, edit or remove attributes](https://help.bluestonepim.com/edit-attributes) article. - [Switch the context-awareness of an attribute definition.](https://docs.api.bluestonepim.com/reference/updatecontextaware.md): This endpoint changes the `contextAware` flag of the specified attribute definition, allowing it to switch between global and context-specific behavior. Because this change can affect many dependent entities, it is handled asynchronously. A background job is triggered to perform the transition and clean up any related references. The operation returns a `taskId` that can be used to monitor the status of this background job. - [Show number of elements affected by the attribute definition delete operation.](https://docs.api.bluestonepim.com/reference/deletedryrun.md): This operation shows the number of elements that would be affected by the delete operation of the specified attribute definition. Useful for understanding the impact of deletes before proceeding. For more detailed information on how to work with attribute definitions in Bluestone PIM, refer to the [Create, edit or remove attributes](https://help.bluestonepim.com/edit-attributes) article. - [Show number of elements affected by the attribute definition update operation.](https://docs.api.bluestonepim.com/reference/updateattributedefinitiondryrun.md): Displays the number of elements that would be affected by the update operation for the specified attribute definition. Useful for understanding the impact of updates before proceeding. For more detailed information on how to work with attribute definitions in Bluestone PIM, refer to the [Create, edit or remove attributes](https://help.bluestonepim.com/edit-attributes) article. - [List all products that use the simple attribute definition.](https://docs.api.bluestonepim.com/reference/findproducts.md): Retrieves all products that use the specified simple attribute definition. Useful for managing and understanding product associations with attribute definitions. - [Get relations by policy ID.](https://docs.api.bluestonepim.com/reference/getrelationsbypolicyid.md): Fetches the relation details based on the provided policy ID. This operation supports pagination and context-based retrieval. For more detailed information on how to work with access management in Bluestone PIM, refer to our help pages [Access management](https://help.bluestonepim.com/access-management). - [Get relation policies.](https://docs.api.bluestonepim.com/reference/getbyrelationid.md): Retrieve the policies associated with a specific relation. This endpoint allows you to fetch a list of policies that govern the relation, ensuring compliance and governance. For more detailed information on how to work with access management in Bluestone PIM, refer to our help pages [Access management](https://help.bluestonepim.com/access-management). - [Add policy to the relation.](https://docs.api.bluestonepim.com/reference/addpolicytorelation.md): Add a policy to a specific relation identified by its ID. This endpoint allows you to associate a policy with a relation to ensure compliance and governance. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api). - [Delete policy.](https://docs.api.bluestonepim.com/reference/deletepolicyforrelation.md): Delete a specific policy associated with a relation identified by its ID. This endpoint allows you to remove a policy from a relation, ensuring the relation's policies are up-to-date. For more detailed information on how to work with access management in Bluestone PIM, refer to our help pages [Access management](https://help.bluestonepim.com/access-management). - [List categories associated with asset.](https://docs.api.bluestonepim.com/reference/getcategoriesbyassetid.md): This endpoint allows you to retrieve a list of categories associated with a specific asset. For more detailed information on how to work with assets in Bluestone PIM, refer to our help pages [Assets module](https://help.bluestonepim.com/assets-panel). - [List assets associated with category.](https://docs.api.bluestonepim.com/reference/getcategoryassets.md): This endpoint allows you to retrieve a list of assets associated with a specific catalog node. For more detailed information on how to work with assets in Bluestone PIM, refer to our help pages [Assets module](https://help.bluestonepim.com/assets-panel). - [Disassociate asset from category.](https://docs.api.bluestonepim.com/reference/disassociateassetfromcategory.md): This operation removes the association between a specified asset and a category. Once disassociated, the asset will no longer be linked to the category. - [Associate asset with category.](https://docs.api.bluestonepim.com/reference/associateassetwithcategory.md): This operation creates an association between a specified asset and a category. Once associated, the asset will be linked to the category. - [Change asset's order.](https://docs.api.bluestonepim.com/reference/movecategoryasset.md): This operation changes the order of a specified asset within a category. The asset will be moved to a new position as specified in the request. - [Show service version.](https://docs.api.bluestonepim.com/reference/getversion.md): Retrieve the current version of the Bluestone PIM service. This endpoint allows you to check the version of the service to ensure compatibility and proper integration. For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api). - [Lists labels.](https://docs.api.bluestonepim.com/reference/describe.md) - [Create a custom type of media label.](https://docs.api.bluestonepim.com/reference/create.md) - [Create a specified type of media label.](https://docs.api.bluestonepim.com/reference/createtype.md) - [Get label with given id.](https://docs.api.bluestonepim.com/reference/getlabelbyid.md) - [Update a custom type of media label.](https://docs.api.bluestonepim.com/reference/update.md) - [Delete a custom type of media label.](https://docs.api.bluestonepim.com/reference/delete-1.md) - [Update a specified type of media label.](https://docs.api.bluestonepim.com/reference/updatetype.md) - [Delete a specified type of media label.](https://docs.api.bluestonepim.com/reference/deletetype.md) - [List specified type of media labels.](https://docs.api.bluestonepim.com/reference/list-1.md) - [Show service version.](https://docs.api.bluestonepim.com/reference/presentversion.md) - [Health checks.](https://docs.api.bluestonepim.com/reference/checkstatuses.md) - [Complete asset creation. The asset will be moved to \assets path.](https://docs.api.bluestonepim.com/reference/completeasset.md) - [Lists assets in upload phase for current user.](https://docs.api.bluestonepim.com/reference/describeassetuploads.md) - [Create new empty asset. The asset will not be available for other users until done operation is completed.](https://docs.api.bluestonepim.com/reference/createasset.md) - [Update the asset's information to be uploaded.](https://docs.api.bluestonepim.com/reference/updateasset.md) - [Create new version for existing asset. The new asset version will not be available for other users until done operation is completed.](https://docs.api.bluestonepim.com/reference/createversionasset.md) - [Cancel asset's creation. Any uploaded file and asset will be removed.](https://docs.api.bluestonepim.com/reference/deleteassetupload.md) - [Assign attribute to asset.](https://docs.api.bluestonepim.com/reference/assignattributetoasset.md) - [Unassign attribute from asset.](https://docs.api.bluestonepim.com/reference/unassignattributefromasset.md) - [Get list of attributes associated to asset.](https://docs.api.bluestonepim.com/reference/getassetattributes.md) - [Set values to dictionary asset's attribute](https://docs.api.bluestonepim.com/reference/updateassetdictionaryattributevalues.md) - [Set values to select asset's attribute](https://docs.api.bluestonepim.com/reference/updateassetselectattributevalues.md) - [Set value to simple asset's attribute](https://docs.api.bluestonepim.com/reference/updateassetsimpleattributevalue.md) - [Append select/multiselect values to assets.](https://docs.api.bluestonepim.com/reference/appendselectvalues-1.md) - [Deduct select/multiselect values from assets.](https://docs.api.bluestonepim.com/reference/deductselectvalues-1.md) - [Unassign attribute from assets.](https://docs.api.bluestonepim.com/reference/deleteassetattributes.md) - [Add attribute to assets.](https://docs.api.bluestonepim.com/reference/addattributetoassets.md) - [Upsert assets attribute.](https://docs.api.bluestonepim.com/reference/addattributetoassets_1.md) - [Update assets attribute.](https://docs.api.bluestonepim.com/reference/updateassetsattribute.md) - [Append values to dictionary asset's attribute](https://docs.api.bluestonepim.com/reference/appendassetdictionaryattributevalues.md) - [Deduct values to dictionary asset's attribute](https://docs.api.bluestonepim.com/reference/deductassetdictionaryattributevalues.md) - [Sets the assets labels attribute.](https://docs.api.bluestonepim.com/reference/setlabelstoasset.md) - [Adds labels to asset's labels.](https://docs.api.bluestonepim.com/reference/addlabelstoasset.md) - [Bulk add assets label.](https://docs.api.bluestonepim.com/reference/bulkaddassetslabels.md) - [Bulk delete assets label.](https://docs.api.bluestonepim.com/reference/bulkdeleteassetslabels.md) - [Bulk update of asset published flag.](https://docs.api.bluestonepim.com/reference/bulkupdateassetpublished.md) - [[DEPRECATED; EOL 2026-07-30] Describe asset.](https://docs.api.bluestonepim.com/reference/describeasset.md): This endpoint is deprecated and will be removed soon. Instead, please use these endpoints:

POST /assets/{id}/views
- [Mark current asset as deleted.](https://docs.api.bluestonepim.com/reference/deleteasset.md) - [Describe working asset versions.](https://docs.api.bluestonepim.com/reference/describeassetversions.md) - [Duplicate the asset.](https://docs.api.bluestonepim.com/reference/duplicateasset.md) - [Generate fixed link for latest version of asset. Full url follows the scheme: [pms-host]/latest/{url}](https://docs.api.bluestonepim.com/reference/generatefixedlink.md) - [[DEPRECATED; EOL 2026-07-30] Describe working assets. Search enabled by assetIds with paging.](https://docs.api.bluestonepim.com/reference/listassetsbyids.md): This endpoint is deprecated and will be removed soon. Instead, please use these endpoints:

POST /assets/views/by-ids
- [Describe working assets. Search enabled with query parameters.](https://docs.api.bluestonepim.com/reference/listassetsbynumbers.md) - [List working asset using cursor.](https://docs.api.bluestonepim.com/reference/listworkingassetswithcursor.md) - [Removes given label from the asset's labels.](https://docs.api.bluestonepim.com/reference/removelabelfromasset.md) - [[DEPRECATED; EOL 2027-01-03] Bulk delete operation for list of assets.](https://docs.api.bluestonepim.com/reference/removelistofassets.md) - [Revert version of asset.](https://docs.api.bluestonepim.com/reference/revertasset.md) - [Update asset alpha channel flag.](https://docs.api.bluestonepim.com/reference/updateassetalphachannel.md) - [Update asset clipping path.](https://docs.api.bluestonepim.com/reference/updateassetclippingpath.md) - [Update asset description.](https://docs.api.bluestonepim.com/reference/updateassetdescription.md) - [Update asset internal flag.](https://docs.api.bluestonepim.com/reference/updateassetinternal.md) - [Update asset name.](https://docs.api.bluestonepim.com/reference/updateassetname.md) - [Update asset number.](https://docs.api.bluestonepim.com/reference/updateassetnumber.md) - [Update asset published flag.](https://docs.api.bluestonepim.com/reference/updateassetpublished.md) - [Show assets filtered by id with view.](https://docs.api.bluestonepim.com/reference/getassetviewsbyid.md) - [Show list of assets filtered by ids with details from given views.](https://docs.api.bluestonepim.com/reference/listassetviewsbyids.md) - [Bulk delete assets by IDs.](https://docs.api.bluestonepim.com/reference/removeassetsbyids.md) - [Generate presigned download URLs for assets.](https://docs.api.bluestonepim.com/reference/generatedownloadurls.md) - [Execute the search query.](https://docs.api.bluestonepim.com/reference/find.md) - [Search for products using an Elasticsearch query.](https://docs.api.bluestonepim.com/reference/productssearch.md) - [Search for products using an Elasticsearch query and scroll. Prefer using POST products/cursor instead.](https://docs.api.bluestonepim.com/reference/productssearchwithscroll.md) - [Count for products using an Elasticsearch query.](https://docs.api.bluestonepim.com/reference/productscount.md) - [Search for assets using an Elasticsearch query.](https://docs.api.bluestonepim.com/reference/assetssearch.md) - [Count for assets using an Elasticsearch query.](https://docs.api.bluestonepim.com/reference/assetscount.md) - [Search for assets using cursor-based pagination.](https://docs.api.bluestonepim.com/reference/assetssearchwithcursor.md) - [Search for products using cursor-based pagination with default sorting.](https://docs.api.bluestonepim.com/reference/productssearchwithcursor.md) - [Get a label.](https://docs.api.bluestonepim.com/reference/find-1.md) - [Update a label.](https://docs.api.bluestonepim.com/reference/update-1.md) - [Delete a label.](https://docs.api.bluestonepim.com/reference/delete-2.md) - [List labels.](https://docs.api.bluestonepim.com/reference/list-2.md) - [Create a new label.](https://docs.api.bluestonepim.com/reference/create-1.md) - [List labels by ids.](https://docs.api.bluestonepim.com/reference/findbyids.md) - [Grant or update filter permission to user.](https://docs.api.bluestonepim.com/reference/grantpermission.md) - [Revoke filter permission from user.](https://docs.api.bluestonepim.com/reference/revokepermission.md) - [List public and private filters using filtering criteria.](https://docs.api.bluestonepim.com/reference/findall.md) - [List filters using filtering criteria.](https://docs.api.bluestonepim.com/reference/findfilter.md) - [Create new filter.](https://docs.api.bluestonepim.com/reference/createfilter.md) - [Get filter by using id.](https://docs.api.bluestonepim.com/reference/getfilter.md) - [Delete filter using id.](https://docs.api.bluestonepim.com/reference/deletefilter.md) - [Update filter using id.](https://docs.api.bluestonepim.com/reference/updatefilter.md) - [Delete filter of any user.](https://docs.api.bluestonepim.com/reference/deletefilterfromall.md) - [Update public and private filter](https://docs.api.bluestonepim.com/reference/updatepublicfilter.md) - [Lists users with filter permission.](https://docs.api.bluestonepim.com/reference/getpermissions.md) - [Get context definition.](https://docs.api.bluestonepim.com/reference/get.md) - [Update context definition.](https://docs.api.bluestonepim.com/reference/update-2.md) - [Archive context definition.](https://docs.api.bluestonepim.com/reference/archive-1.md) - [List all context definitions.](https://docs.api.bluestonepim.com/reference/find-2.md) - [Create context definition.](https://docs.api.bluestonepim.com/reference/create-2.md) - [List context definitions by names.](https://docs.api.bluestonepim.com/reference/findbynames.md) - [Retrieve history events.](https://docs.api.bluestonepim.com/reference/list-3.md) - [Retrieve history events for given entity type.](https://docs.api.bluestonepim.com/reference/list_1.md) - [Retrieve history events for given entity.](https://docs.api.bluestonepim.com/reference/list_2.md) - [Retrieve history events for a given entity type using Point-In-Time (PIT) search. Suitable for paginated access to large result sets.](https://docs.api.bluestonepim.com/reference/scrolllist.md): Use the 'count' parameter in the initial request to specify how many results to return. In subsequent requests, use both 'scrollId' (returned from the previous response) and 'count' parameters together. Note: A new scrollId is returned with each response and must be used in the next request. Always update the scroll in your pagination logic. - [Count events for given entity.](https://docs.api.bluestonepim.com/reference/count-1.md) - [Retrieving the history of events for a given type of entities that have a value from the query.](https://docs.api.bluestonepim.com/reference/search-1.md) - [Retrieve history events for given entity that have a value from the query.](https://docs.api.bluestonepim.com/reference/search_1.md) - [Show service version.](https://docs.api.bluestonepim.com/reference/presentversion-2.md) - [List all comments with replies for given task.](https://docs.api.bluestonepim.com/reference/listalltaskcomments.md) - [Add a comment for given task](https://docs.api.bluestonepim.com/reference/addtaskcomment.md) - [Add a comment reply for given task comment.](https://docs.api.bluestonepim.com/reference/addtaskcommentreply.md) - [Get reminders for task.](https://docs.api.bluestonepim.com/reference/getreminderconfig.md) - [Create reminder for task (max 5 allowed per task).](https://docs.api.bluestonepim.com/reference/createtasksreminderconfig.md) - [Update reminder config.](https://docs.api.bluestonepim.com/reference/updatereminderconfig.md) - [Delete reminder config.](https://docs.api.bluestonepim.com/reference/deletereminderconfig.md) - [Assign products to task.](https://docs.api.bluestonepim.com/reference/assignproducts.md) - [Assign task.](https://docs.api.bluestonepim.com/reference/assigntask.md) - [Complete product in scope of a task.](https://docs.api.bluestonepim.com/reference/completetaskproduct.md) - [List all tasks for organization.](https://docs.api.bluestonepim.com/reference/listtasks.md) - [Create new task.](https://docs.api.bluestonepim.com/reference/createtask.md) - [Delete product from task scope.](https://docs.api.bluestonepim.com/reference/deletetaskproduct.md) - [List all/archived/assigned/created tasks for user.](https://docs.api.bluestonepim.com/reference/fetchtasks.md) - [List all/archived/assigned tasks for user group.](https://docs.api.bluestonepim.com/reference/fetchtasksforusergroup.md) - [Get single task by id.](https://docs.api.bluestonepim.com/reference/getsingletask.md) - [Update task data.](https://docs.api.bluestonepim.com/reference/updatetask.md) - [List archived tasks for organization.](https://docs.api.bluestonepim.com/reference/listarchivedtasksv2.md) - [List folders of tasks for user.](https://docs.api.bluestonepim.com/reference/listfolders.md) - [Mark product as incomplete in scope of a task.](https://docs.api.bluestonepim.com/reference/revoketaskproduct.md) - [Complete task by id of logged in user.](https://docs.api.bluestonepim.com/reference/completeusertask.md) - [Get tasks of logged in user.](https://docs.api.bluestonepim.com/reference/getallusertasks.md) - [Get tasks assigned to logged in user.](https://docs.api.bluestonepim.com/reference/getassignedusertasks.md) - [Get task by id of logged in user.](https://docs.api.bluestonepim.com/reference/getusertask.md) - [Set task as important by id of logged in user.](https://docs.api.bluestonepim.com/reference/setimportantusertask.md) - [Set task as unimportant by id of logged in user.](https://docs.api.bluestonepim.com/reference/setunimportantusertask.md) - [Revoke task by id of logged in user.](https://docs.api.bluestonepim.com/reference/uncompleteusertask.md) - [Validate passed view](https://docs.api.bluestonepim.com/reference/getvalidview.md) - [Search for products for given query.](https://docs.api.bluestonepim.com/reference/search-2.md) - [Get number of products for given query.](https://docs.api.bluestonepim.com/reference/getcount.md) - [Scroll products for given query.](https://docs.api.bluestonepim.com/reference/scrollsearch.md): This endpoint is using scroll functionality. To get to further pages, use scroll id returned from each request. Scroll is active only limited time - after 10 seconds of inactivity, scroll is removed and further requests with related scroll ids are unavailable. - [Create a new persisted product query.](https://docs.api.bluestonepim.com/reference/createpersistedproductquery.md) - [Update persisted product query.](https://docs.api.bluestonepim.com/reference/updatepersistedproductquery.md) - [Delete persisted product query.](https://docs.api.bluestonepim.com/reference/deletepersistedproductquery.md) - [List persisted product queries.](https://docs.api.bluestonepim.com/reference/listpersistedproductqueries.md) - [Search for persisted queries for given product.](https://docs.api.bluestonepim.com/reference/searchpersistedproductqueries.md) - [/organization](https://docs.api.bluestonepim.com/reference/deleteorganization.md): Delete all data for an organization. This endpoint can only be called if the organization in the context of this request is archived and the user has the system role ORG_DELETE_ADMIN. - [Close session.](https://docs.api.bluestonepim.com/reference/closesession.md) - [Cancel session.](https://docs.api.bluestonepim.com/reference/cancelsession.md) - [Add products to session.](https://docs.api.bluestonepim.com/reference/addproductstosession.md) - [Create a new sync session.](https://docs.api.bluestonepim.com/reference/createsession.md) - [Get sync session.](https://docs.api.bluestonepim.com/reference/getsession.md) - [List product states.](https://docs.api.bluestonepim.com/reference/searchproductstatebyids.md) - [Change product states.](https://docs.api.bluestonepim.com/reference/changeproductstate.md) - [List category states.](https://docs.api.bluestonepim.com/reference/searchcategorystatebyids.md) - [Create products report file.](https://docs.api.bluestonepim.com/reference/createsessionreportproductsfile.md) - [Get products by issue type for the session.](https://docs.api.bluestonepim.com/reference/getproductidsbyissuetype.md) - [Create entities report file.](https://docs.api.bluestonepim.com/reference/createsessionreportfile.md) - [Create assets report file.](https://docs.api.bluestonepim.com/reference/createsessionreportassetfile.md) - [Get products report link.](https://docs.api.bluestonepim.com/reference/getsessionreportproductslink.md) - [Get products issues for the session.](https://docs.api.bluestonepim.com/reference/getsessionproductsissues.md) - [Get entities issues for the session.](https://docs.api.bluestonepim.com/reference/getsessionentitiesissues.md) - [Get assets issues for the session.](https://docs.api.bluestonepim.com/reference/getsessionassetsissues.md) - [Get entities report link.](https://docs.api.bluestonepim.com/reference/getsessionreportlink.md) - [Get assets report link.](https://docs.api.bluestonepim.com/reference/getsessionreportassetlink.md) - [Get a session report.](https://docs.api.bluestonepim.com/reference/getsessionreport.md) - [Get assets by issue type for the session.](https://docs.api.bluestonepim.com/reference/getassetidsbyissuetype.md) - [/products/list](https://docs.api.bluestonepim.com/reference/findproducts-1.md): Find products in PAPI - [Show list of products filtered by ids.](https://docs.api.bluestonepim.com/reference/findproductsbyids.md) - [Show list of products filtered by numbers.](https://docs.api.bluestonepim.com/reference/findproductsbynumbers.md) - [/products/cursor/all](https://docs.api.bluestonepim.com/reference/findproductsbycursor.md) - [/products/{id}](https://docs.api.bluestonepim.com/reference/getproduct-1.md): Get the product with given id - [/categories](https://docs.api.bluestonepim.com/reference/getcategories.md): Describe the root categories available in the system.
name - category contains a name
itemsOnPage - items to be displayed on page.
pageNo - page number to display. - [/categories/{categoryId}/ancestors](https://docs.api.bluestonepim.com/reference/getancestors.md): Describe categories associated with given category.
deep - deepness of sub categories to be retrieved. default 10. - [/categories/scan](https://docs.api.bluestonepim.com/reference/scan.md): Get paginated flat list of categories: given category and its descendants. CategoryId is optional, if not provided all catalogs are listed. - [[DEPRECATED; EOL 2027-01-15] undefined](https://docs.api.bluestonepim.com/reference/getcategorybyid.md): Describe categories associated with given category.
deep - deepness of sub categories to be retrieved. default 10.
This endpoint is deprecated and will be removed soon. Instead, please use this endpoint: GET /categories/scan - [/categories/{categoryId}/products](https://docs.api.bluestonepim.com/reference/getproducts-1.md): Get a list of products for given category.
subCategories - default false. Set to true provides products for all sub categories.
withLabels - format "label1;label2" a set of labels products should contain.
name - part of the name contained by the product
itemsOnPage - items to be displayed on page.
pageNo - page number to display. - [Show list of categories filtered by numbers.](https://docs.api.bluestonepim.com/reference/findcategoriesbynumbers.md) - [Retrieves a collection of publish info for given tenant.](https://docs.api.bluestonepim.com/reference/getpublishinfos.md) - [Retrieves the information about given PublishInfo environment.](https://docs.api.bluestonepim.com/reference/getpublishinfo.md) - [/differences/products](https://docs.api.bluestonepim.com/reference/getproductdifferences.md): Return a set of differences done during last sync operation.
diffType - filter returned values on difference type.
itemsOnPage - items to be displayed on page.
pageNo - page number to display. - [/differences/sync/{id}/products](https://docs.api.bluestonepim.com/reference/getproductdifferencesonsyncdeletes.md): Return a set of changed products with given sync
id - sync id for which differences should be retrieved.
diffType - filter returned values on difference type.
itemsOnPage - amount of items to be retrieved.
pageNo - page number. - [/differences/categories](https://docs.api.bluestonepim.com/reference/getcategorydifferences.md): Return a set of changed categories during last publish
diffType - filter returned values on difference type.
itemsOnPage - amount of items to be retrieved.
pageNo - page number. - [/differences/sync/{id}/categories](https://docs.api.bluestonepim.com/reference/getcategorydifferencesonsyncdeletes.md): Return a set of differences done with a given sync.
id - sync id for which differences should be retrieved.
itemsOnPage - items to be displayed on page.
pageNo - page number to display. - [/differences/attributes](https://docs.api.bluestonepim.com/reference/getattributedifferences.md): Return a set of differences done during last sync operation.
diffType - filter returned values on difference type.
itemsOnPage - items to be displayed on page.
pageNo - page number to display. - [/differences/sync/{id}/attributes](https://docs.api.bluestonepim.com/reference/getattributedifferencesonsyncdeletes.md): Return a set of changed attributes with given sync
id - sync id for which differences should be retrieved.
diffType - filter returned values on difference type.
itemsOnPage - amount of items to be retrieved.
pageNo - page number. - [/differences/relations](https://docs.api.bluestonepim.com/reference/getrelationdifferences.md): Return a set of differences done during last sync operation.
diffType - filter returned values on difference type.
itemsOnPage - items to be displayed on page.
pageNo - page number to display. - [/differences/sync/{id}/relations](https://docs.api.bluestonepim.com/reference/getrelationdifferencesonsyncdeletes.md): Return a set of changed relations with given sync
id - sync id for which differences should be retrieved.
diffType - filter returned values on difference type.
itemsOnPage - amount of items to be retrieved.
pageNo - page number. - [lists currently available publications](https://docs.api.bluestonepim.com/reference/getsegmentinfo.md) - [/health](https://docs.api.bluestonepim.com/reference/gethealth.md): A Health check for PAPI service. - [/relations](https://docs.api.bluestonepim.com/reference/getrelations.md): Describe the relations available in the system. - [/attributes](https://docs.api.bluestonepim.com/reference/getattributes.md): Describe the attributes available in the system.
id - attribute id.
itemsOnPage - items to be displayed on page.
pageNo - page number to display. - [/attributes/dictionary/{attributeDefinitionId}/values/cursor/all](https://docs.api.bluestonepim.com/reference/finddictionaryvaluesbycursor.md) - [/attributes/by-numbers](https://docs.api.bluestonepim.com/reference/findpattributesbynumbers.md) - [Returns list of additional user properties.](https://docs.api.bluestonepim.com/reference/getadditionaluserproperties.md) - [Returns the latest agreement.](https://docs.api.bluestonepim.com/reference/getlatestagreement.md) - [Check if user has approved latest agreement.](https://docs.api.bluestonepim.com/reference/getadditionalconsentproperties.md) - [Accept agreement with given id.](https://docs.api.bluestonepim.com/reference/acceptagreement.md) - [Returns list of registered API Clients.](https://docs.api.bluestonepim.com/reference/getallapiclients.md) - [Returns list of registered API Clients names and ids.](https://docs.api.bluestonepim.com/reference/getallapiclientsname.md) - [Returns list of all dependent permissions for a permissions.](https://docs.api.bluestonepim.com/reference/getdependentpermissionsforallpermissions.md) - [Returns list of managed roles.](https://docs.api.bluestonepim.com/reference/getallmanagedroles.md) - [Returns managed role.](https://docs.api.bluestonepim.com/reference/getmanagedrolewithid.md) - [Returns simplified list of UI permissions in account from token.](https://docs.api.bluestonepim.com/reference/getuseruipermissions.md) - [Reset MFA secret for currently logged in user.](https://docs.api.bluestonepim.com/reference/resetmfa.md) - [Returns list of user organizations.](https://docs.api.bluestonepim.com/reference/getuserorganizations.md) - [Return organization.](https://docs.api.bluestonepim.com/reference/getorganizationwithid.md) - [Returns list of permissions.](https://docs.api.bluestonepim.com/reference/getallpermissions.md) - [Return permission.](https://docs.api.bluestonepim.com/reference/getpermissionwithid.md) - [Returns ids of assigned plugins for organization from token.](https://docs.api.bluestonepim.com/reference/getallpluginpermissions.md) - [Return permissions for specific plugin in organization.](https://docs.api.bluestonepim.com/reference/getpluginpermissionwithid.md) - [Returns list of policies.](https://docs.api.bluestonepim.com/reference/getallpolicies.md) - [Create new policy.](https://docs.api.bluestonepim.com/reference/createpolicy.md) - [Return policy.](https://docs.api.bluestonepim.com/reference/getpolicywithid.md) - [Update policy.](https://docs.api.bluestonepim.com/reference/updatepolicywithid.md) - [Archive policy.](https://docs.api.bluestonepim.com/reference/archivepolicywithid.md) - [Returns list of roles.](https://docs.api.bluestonepim.com/reference/getallroles.md) - [Create new role.](https://docs.api.bluestonepim.com/reference/createrole.md) - [Returns role.](https://docs.api.bluestonepim.com/reference/getrolewithid.md) - [Archive role.](https://docs.api.bluestonepim.com/reference/archiverolewithid.md) - [Edit role.](https://docs.api.bluestonepim.com/reference/updaterolewithid.md) - [Assign permissions by ids to role by id.](https://docs.api.bluestonepim.com/reference/assignrolepermissionswithid.md) - [Revoke permissions by ids of role by id.](https://docs.api.bluestonepim.com/reference/revokerolepermissionswithid.md) - [Get permissions for plugin.](https://docs.api.bluestonepim.com/reference/getpluginpermissions.md) - [Update permissions for plugin.](https://docs.api.bluestonepim.com/reference/updatepluginpermissions.md) - [Assign plugin permissions to plugin.](https://docs.api.bluestonepim.com/reference/assignpluginpermissions.md) - [Revoke plugin permissions from plugin.](https://docs.api.bluestonepim.com/reference/revokepluginpermissions.md) - [Get default role.](https://docs.api.bluestonepim.com/reference/getdefaultrole.md) - [Set default role.](https://docs.api.bluestonepim.com/reference/setdefaultrole.md) - [Clear default role.](https://docs.api.bluestonepim.com/reference/cleardefaultrole.md) - [Returns list of registered API Clients names and ids.](https://docs.api.bluestonepim.com/reference/getallservicesids.md) - [Returns list of SSO provider configurations for the authenticated organization.](https://docs.api.bluestonepim.com/reference/getssoproviders.md): Note: If an SSO configuration (realm) is bound to multiple organizations, it will be returned if any of them match the user's organization. - [Update client secret for a specific SSO provider.](https://docs.api.bluestonepim.com/reference/updatessoprovidersecret.md): Important Note: If this SSO configuration (realm) is bound to multiple organizations, updating the client secret will affect all of them. - [Create new user group.](https://docs.api.bluestonepim.com/reference/createusergroup.md) - [Returns list of user groups.](https://docs.api.bluestonepim.com/reference/getusergroupslist.md) - [Returns total number of user groups.](https://docs.api.bluestonepim.com/reference/getusergroupscount.md) - [Returns user group.](https://docs.api.bluestonepim.com/reference/getusergroupwithid.md) - [Update user group.](https://docs.api.bluestonepim.com/reference/updateusergroup.md) - [Delete user group.](https://docs.api.bluestonepim.com/reference/deleteusergroup.md) - [/userGroups/{id}/duplicate](https://docs.api.bluestonepim.com/reference/duplicateusergroup.md) - [Add role to user group.](https://docs.api.bluestonepim.com/reference/addroletousergroup.md) - [Remove role from user group.](https://docs.api.bluestonepim.com/reference/removerolefromusergroup.md) - [Assign policy to user group](https://docs.api.bluestonepim.com/reference/assignpolicytousergroup.md) - [Unassign policy from user group](https://docs.api.bluestonepim.com/reference/unassignpolicyfromusergroup.md) - [Add managed role to user group.](https://docs.api.bluestonepim.com/reference/addmanagedroletousergroup.md) - [Remove managed role from user group.](https://docs.api.bluestonepim.com/reference/removemanagedrolefromusergroup.md) - [Returns list of users.](https://docs.api.bluestonepim.com/reference/getusers.md) - [Create new user.](https://docs.api.bluestonepim.com/reference/createuser.md) - [Returns user.](https://docs.api.bluestonepim.com/reference/getuserwithid.md) - [Update user.](https://docs.api.bluestonepim.com/reference/updateuser.md) - [Upload user picture.](https://docs.api.bluestonepim.com/reference/uploaduserpicture.md) - [Change user password.](https://docs.api.bluestonepim.com/reference/changeuserpassword.md) - [Resend join email.](https://docs.api.bluestonepim.com/reference/resendjoinemail.md) - [Set user status.](https://docs.api.bluestonepim.com/reference/setuserstatus.md) - [Update user type.](https://docs.api.bluestonepim.com/reference/updateusertype.md) - [Grant role.](https://docs.api.bluestonepim.com/reference/grantrole.md) - [Revoke role.](https://docs.api.bluestonepim.com/reference/revokerole.md) - [Grant policy.](https://docs.api.bluestonepim.com/reference/grantpolicy.md) - [Revoke policy.](https://docs.api.bluestonepim.com/reference/revokepolicy.md) - [Grant managed role.](https://docs.api.bluestonepim.com/reference/grantmanagedrole.md) - [Revoke managed role.](https://docs.api.bluestonepim.com/reference/revokemanagedrole.md) - [Grant additional properties.](https://docs.api.bluestonepim.com/reference/assignpropertiestouser.md) - [Revoke additional properties.](https://docs.api.bluestonepim.com/reference/removepropertiesfromuser.md) - [Assign user group to user.](https://docs.api.bluestonepim.com/reference/assignusergrouptouser.md) - [Unassign user group from user.](https://docs.api.bluestonepim.com/reference/unassignusergroupfromuser.md) - [Reset MFA secret for user.](https://docs.api.bluestonepim.com/reference/resetmfaforuser.md) - [Unsubscribe for given events for given webhook.](https://docs.api.bluestonepim.com/reference/unsubscribe.md) - [Get all events subscriptions enabled for given webhook.](https://docs.api.bluestonepim.com/reference/findwebhook.md) - [Subscribe for given events for given webhook.](https://docs.api.bluestonepim.com/reference/subscribe.md) - [Create webhook.](https://docs.api.bluestonepim.com/reference/create-3.md) - [Search webhook.](https://docs.api.bluestonepim.com/reference/search-3.md) - [Delete webhook.](https://docs.api.bluestonepim.com/reference/delete-3.md) - [Get webhook.](https://docs.api.bluestonepim.com/reference/get-1.md) - [[ASYNCHRONOUS ENDPOINT] Update webhook.](https://docs.api.bluestonepim.com/reference/update-3.md) - [Get user aggregation configuration for given entity type.](https://docs.api.bluestonepim.com/reference/findconfiguration.md) - [Modify user aggregation configuration for given entity type.](https://docs.api.bluestonepim.com/reference/updateemailfrequency.md) - [Unsubscribe for given events for email channel.](https://docs.api.bluestonepim.com/reference/unsubscribeemail.md) - [Get all events subscriptions enabled for email channel.](https://docs.api.bluestonepim.com/reference/findemail.md) - [Subscribe for given events for email channel.](https://docs.api.bluestonepim.com/reference/subscribeemail.md) - [Unsubscribe for given events for in-app channel.](https://docs.api.bluestonepim.com/reference/unsubscribeinapp.md) - [Get all events subscriptions enabled for in-app channel.](https://docs.api.bluestonepim.com/reference/findinapp.md) - [Subscribe for given events for in-app channel.](https://docs.api.bluestonepim.com/reference/subscribeinapp.md) - [Ping webhook.](https://docs.api.bluestonepim.com/reference/pingwebhook.md) - [Get messages for a given webhook.](https://docs.api.bluestonepim.com/reference/getmessages.md) - [Get in-app messages.](https://docs.api.bluestonepim.com/reference/getinappmessage.md) - [Get in-app user messages.](https://docs.api.bluestonepim.com/reference/getinappusermessage.md) - [Mark all messages as read.](https://docs.api.bluestonepim.com/reference/markallmessagesasread.md) - [Mark message as read.](https://docs.api.bluestonepim.com/reference/markmessageasread.md) - [Mark message as unread.](https://docs.api.bluestonepim.com/reference/markmessageasunread.md) - [Get email messages.](https://docs.api.bluestonepim.com/reference/getemailmessages.md) - [Get email message.](https://docs.api.bluestonepim.com/reference/getemailmessage.md) - [Get info about apps queue webhook.](https://docs.api.bluestonepim.com/reference/getuseappsqueue.md) - [Update apps queue for the given webhook.](https://docs.api.bluestonepim.com/reference/updateappsqueue.md) - [Unsubscribe watch for given entities.](https://docs.api.bluestonepim.com/reference/unsubscribefromentity.md) - [Get all entities watched for given eventType.](https://docs.api.bluestonepim.com/reference/findwatchedentities.md) - [Subscribe watch for given entities.](https://docs.api.bluestonepim.com/reference/subscribetoentity.md) - [Get general user configuration.](https://docs.api.bluestonepim.com/reference/finduserconfig.md) - [Modify general user configuration.](https://docs.api.bluestonepim.com/reference/upsert.md) - [Update requirement.](https://docs.api.bluestonepim.com/reference/update-4.md) - [Delete requirement.](https://docs.api.bluestonepim.com/reference/delete-4.md) - [Add included category to requirement.](https://docs.api.bluestonepim.com/reference/addincludedcategory.md) - [Remove included category to requirement.](https://docs.api.bluestonepim.com/reference/removeincludedcategory.md) - [Add excluded category to requirement.](https://docs.api.bluestonepim.com/reference/addexcludedcategory.md) - [Remove excluded category to requirement.](https://docs.api.bluestonepim.com/reference/removeexcludedcategory.md) - [Create requirement.](https://docs.api.bluestonepim.com/reference/create-4.md) - [List requirements.](https://docs.api.bluestonepim.com/reference/list-4.md) - [Count requirements.](https://docs.api.bluestonepim.com/reference/count.md) - [Get requirements for single entity.](https://docs.api.bluestonepim.com/reference/getrequirementsforsingleentity.md) - [Add included product type to requirement.](https://docs.api.bluestonepim.com/reference/addincludedproducttype.md) - [Remove included product type to requirement.](https://docs.api.bluestonepim.com/reference/removeincludedproducttype.md) - [Get scores.](https://docs.api.bluestonepim.com/reference/getscores.md) - [Get category scores.](https://docs.api.bluestonepim.com/reference/getcategoryscores.md) - [Stop ongoing calculation.](https://docs.api.bluestonepim.com/reference/stopcalculation.md) - [Start new calculation.](https://docs.api.bluestonepim.com/reference/startcalculation.md) - [Recalculate score for entities.](https://docs.api.bluestonepim.com/reference/recalculateforentity.md) - [Invalidate scores.](https://docs.api.bluestonepim.com/reference/scoresinvalidation.md) - [Get detailed scores for single entity.](https://docs.api.bluestonepim.com/reference/getdetailedscoresforsingleentity.md) - [Get calculation status.](https://docs.api.bluestonepim.com/reference/getcalculationstatus.md) - [Validate product attribute.](https://docs.api.bluestonepim.com/reference/validateproductattribute.md) - [Validate definition value.](https://docs.api.bluestonepim.com/reference/validatedefinitionvalue.md) - [Get validation issues for product.](https://docs.api.bluestonepim.com/reference/getvalidationissues.md) - [Get validation issues for products by ids.](https://docs.api.bluestonepim.com/reference/getbulkvalidationissues.md): Returns validation results only for entities that exist. - [Get metadata for given provider using cursor with details from given views.](https://docs.api.bluestonepim.com/reference/findprovidermetadatawithcursorandviewsbyproviderid.md) - [Get metadata for entities for given provider.](https://docs.api.bluestonepim.com/reference/getmetadataforentities.md) - [Upsert metadata for given provider.](https://docs.api.bluestonepim.com/reference/upsertmetadata.md) - [Delete metadata for given provider.](https://docs.api.bluestonepim.com/reference/deletemetadata.md) - [Delete metadata for given provider by ids.](https://docs.api.bluestonepim.com/reference/deleteprovidermetadatabyids.md) - [List providers by numbers.](https://docs.api.bluestonepim.com/reference/listproviders-1.md) - [Get providers for organization.](https://docs.api.bluestonepim.com/reference/getregisteredproviders.md) - [Get all setups.](https://docs.api.bluestonepim.com/reference/getallcolumnsetups.md) - [This endpoint allows you to create column setup.](https://docs.api.bluestonepim.com/reference/createcolumnssetupofanyuser.md) - [This endpoint allows you to get column setup by id.](https://docs.api.bluestonepim.com/reference/getcolumnsetupbyidofanyuser.md) - [This endpoint allows you to update column setup by id.](https://docs.api.bluestonepim.com/reference/updatesetupbyidofanyuser.md) - [This endpoint allows you to delete column setup by id.](https://docs.api.bluestonepim.com/reference/deletecolumnsetupbyidofanyuser.md)