# Bluestone PIM - Test Environment Documentation

> Documentation for Bluestone PIM - Test Environment

## Guides: API Access and Lifecycle
- [Authentication](https://docs.api.test.bluestonepim.com/docs/authentication.md)
- [Environments](https://docs.api.test.bluestonepim.com/docs/environments.md)
- [Deprecated endpoints](https://docs.api.test.bluestonepim.com/docs/deprecated-endpoints.md)
- [Migrate product clients for FAMILY and response changes](https://docs.api.test.bluestonepim.com/docs/migrate-product-clients-for-family-and-response-changes.md): Prepare MAPI and PAPI integrations for the FAMILY product type, new hierarchy fields, and removal of legacy Sync fields.
- [Migrate from deprecated Media Bank asset endpoints](https://docs.api.test.bluestonepim.com/docs/migrate-from-deprecated-media-bank-asset-endpoints.md): Migrate clients from deprecated Media Bank asset endpoints to the view-based replacements before 20 October 2026.

## Guides: Build with the API
- [Generate SDKs and client code from OpenAPI](https://docs.api.test.bluestonepim.com/docs/generate-sdks-and-client-code-from-openapi.md)
- [Work with product families, groups, and variants](https://docs.api.test.bluestonepim.com/docs/product-families-groups-and-variants.md): Model three-level product structures and manage FAMILY-to-GROUP relationships with the Bluestone PIM API.
- [Rate limits, retries, and backoff](https://docs.api.test.bluestonepim.com/docs/rate-limits-retries-and-backoff.md)
- [Webhook events and delivery](https://docs.api.test.bluestonepim.com/docs/webhook-events-and-delivery.md)
- [Build reliable AI agents on Bluestone PIM](https://docs.api.test.bluestonepim.com/docs/build-reliable-ai-agents-on-bluestone-pim.md)
- [Use the Bluestone PIM docs MCP server](https://docs.api.test.bluestonepim.com/docs/use-the-bluestone-pim-docs-mcp-server.md)

## Guides: Bluestone PIM MCP
- [Bluestone PIM MCP overview](https://docs.api.test.bluestonepim.com/docs/bluestone-pim-mcp-overview.md): Understand the operational Bluestone PIM MCP server, how it differs from the docs MCP server, and where to start.
- [Connect and authenticate](https://docs.api.test.bluestonepim.com/docs/bluestone-pim-mcp-connect-and-authenticate.md): Connect a Streamable HTTP MCP client and sign in securely through Bluestone OAuth.
- [Permissions and safe operation](https://docs.api.test.bluestonepim.com/docs/bluestone-pim-mcp-permissions-and-safe-operation.md): Apply least privilege, explicit confirmation, and verification to product-MCP operations.
- [Common workflows](https://docs.api.test.bluestonepim.com/docs/bluestone-pim-mcp-common-workflows.md): Follow safe patterns for inspection, controlled updates, job monitoring, history, tasks, and platform guidance.
- [Bluestone PIM MCP tool reference](https://docs.api.test.bluestonepim.com/docs/bluestone-pim-mcp-tool-reference.md): Browse the 89 Test product MCP tools, grouped by capability.
- [Troubleshooting and limitations](https://docs.api.test.bluestonepim.com/docs/bluestone-pim-mcp-troubleshooting-and-limitations.md): Diagnose OAuth, permission, context, tool-discovery, job, client, and environment problems.

## API Reference: Get bearer token
- [Generate token](https://docs.api.test.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.

## API Reference: PIM
- Catalog nodes
  - [Create a catalog node (category) or a top-level catalog.](https://docs.api.test.bluestonepim.com/reference/createcategory.md): Creates a node in the catalog tree and returns its generated ID in the `resource-id` response header. Set the request body `parentId` to place the node under an existing node; omit `parentId` to…
  - [List all catalog nodes/categories that use the attribute definition in a Category Level Attribute (CLA).](https://docs.api.test.bluestonepim.com/reference/findbycategorylevelattributes.md): Returns the paginated basic data of the categories the attribute definition is assigned on - not the CLA values, and not the categories that merely inherit it through propagation. Use it to see where…
  - [Describe catalog nodes/categories.](https://docs.api.test.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…
  - [Delete a catalog node (category) and its entire subtree.](https://docs.api.test.bluestonepim.com/reference/deletecategorynode.md): Deletes the node identified by `id` together with all of its descendant nodes, and unassigns every product from the deleted node and its descendants (the products themselves are not deleted).…
  - [Describe catalog node/category.](https://docs.api.test.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…
  - [Partially update a catalog node's (category's) main details.](https://docs.api.test.bluestonepim.com/reference/partialupdatecatalognode.md): Updates only the fields present in the request body (name, number, description); omitted fields are left unchanged. Use this for a partial edit. To replace all of a node's details in one call, use…
  - [Update catalog node/category.](https://docs.api.test.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…
  - [List the direct child nodes (categories) of a catalog node.](https://docs.api.test.bluestonepim.com/reference/getcatalognodechildren.md): Returns a paginated list of the immediate children of the node identified by `id` (one level down, not the full subtree). To list top-level catalogs instead of a node's children, use find_catalogs.
  - [Move catalog node/category to new parent.](https://docs.api.test.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…
  - [Change category order.](https://docs.api.test.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…
  - [List catalog node/category path to root.](https://docs.api.test.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…
  - [List catalog node/category products.](https://docs.api.test.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…
  - [Add product to the catalog node/category.](https://docs.api.test.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…
  - [Remove product from the catalog node/category.](https://docs.api.test.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…
- Product policy
  - [Get policy by category node id.](https://docs.api.test.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…
  - [Add policy to products for category node id.](https://docs.api.test.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…
  - [Delete policy from products for category node id.](https://docs.api.test.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…
  - [Get policy by category id.](https://docs.api.test.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…
  - [Add policy to products for category id.](https://docs.api.test.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…
  - [Delete policy from products for category id.](https://docs.api.test.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…
  - [Get catalog node by policy id.](https://docs.api.test.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…
  - [Get categories by policy id.](https://docs.api.test.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…
- Bulk
  - [Read the status of a background task.](https://docs.api.test.bluestonepim.com/reference/getjobstatus.md): Returns the task's `status`, the number of items it has processed so far in `count`, and `errorMessage` when it ended in an error. `status` is `WAITING` before the task starts and `EXECUTING` while…
  - [Delete products attributes.](https://docs.api.test.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…
- Attribute definition policies
  - [Get policies by attribute definition ID.](https://docs.api.test.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…
  - [Add policy to attribute definition.](https://docs.api.test.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…
  - [Delete policy for attribute definition.](https://docs.api.test.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…
  - [Get attribute definitions by policy ID.](https://docs.api.test.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…
  - [Delete policy from attribute definitions.](https://docs.api.test.bluestonepim.com/reference/bulkdeletepolicyfromattributedefinitions.md): Removes the specified policy from all listed attribute definitions at once. Both READ and WRITE markers for the policy are removed in a single call.  The operation is idempotent — attribute…
  - [Add a policy to multiple attribute definitions.](https://docs.api.test.bluestonepim.com/reference/addpolicytoattributedefinitions.md): Assigns a single policy to a set of attribute definitions in one request, replacing the need to call `POST /definitions/{id}/policy` once per attribute.  The operation is an upsert driven by…
- Products categories
  - [Add products as children of category.](https://docs.api.test.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…
  - [List of category IDs the product resides in.](https://docs.api.test.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…
  - [Assigns an existing product to one or more existing catalog categories.](https://docs.api.test.bluestonepim.com/reference/addproducttocategories.md): This links the product to each listed category; it does not create categories or modify their contents, and categories not listed here keep their current products. A category the product already…
  - [Unassigns a product from a single catalog category.](https://docs.api.test.bluestonepim.com/reference/removeproductfromcategory.md): This removes only the link between the product and that one category; the product, the category, and the product's other category assignments are left intact. Fails if the product is not currently…
- Validation
  - [Validates attribute definitions.](https://docs.api.test.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.test.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…
  - [Validates attribute value.](https://docs.api.test.bluestonepim.com/reference/validatevalue.md): This endpoint allows you to validate a single attribute value for a product.
- Category attributes
  - [List all Catalog or Category attributes.](https://docs.api.test.bluestonepim.com/reference/getattributesassociatedtocategory.md)
  - [Unassigns an attribute from Catalog/Category.](https://docs.api.test.bluestonepim.com/reference/unassigndefinitionfromcategory.md)
  - [Assigns an attribute to Catalog/Category.](https://docs.api.test.bluestonepim.com/reference/assigndefinitiontocategory.md)
  - [Sets the value of a dictionary Catalog or Category attribute.](https://docs.api.test.bluestonepim.com/reference/setdictionarydefinitionvalue.md)
  - [Sets the value of a select/multiselect Catalog or Category attribute.](https://docs.api.test.bluestonepim.com/reference/setselectdefinitionvalue.md)
  - [Sets the value of a simple Catalog or Category attribute.](https://docs.api.test.bluestonepim.com/reference/setsimpledefinitionvalue.md)
- Products
  - [Create new product.](https://docs.api.test.bluestonepim.com/reference/createproduct.md): Creates a single new product and returns its generated internal ID in the `resource-id` response header. Fails if a product with the given number already exists, or if the organization's product…
  - [Archive products by IDs.](https://docs.api.test.bluestonepim.com/reference/archiveproductsbyids.md): Archives the products with the given IDs, moving them to the archived state so they no longer appear as active. This endpoint only archives; to restore previously archived products use the separate…
  - [Create a copy of product.](https://docs.api.test.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 products using cursor with details from given views.](https://docs.api.test.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…
  - [Show list of products filtered by type with details from given views.](https://docs.api.test.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…
  - [Show list of products filtered by asset ids with details from given views.](https://docs.api.test.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`…
  - [Show list of products filtered by ids with details from given views.](https://docs.api.test.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…
  - [Show list of products filtered by numbers with details from given views.](https://docs.api.test.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…
  - [Unarchive products by ids.](https://docs.api.test.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…
  - [Show product details.](https://docs.api.test.bluestonepim.com/reference/getproduct.md): Returns the full details of a single product by its internal ID, including its metadata, attributes, categories, relations and assets. Fails if no product with the specified ID exists. For a lighter…
  - [Update product main details, supports partial update.](https://docs.api.test.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…
  - [Create a copy of product.](https://docs.api.test.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…
  - [Show product filtered by id with view.](https://docs.api.test.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…
  - [Show product overview.](https://docs.api.test.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.…
- Products templates
  - [List all product templates.](https://docs.api.test.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…
  - [Delete product template.](https://docs.api.test.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…
  - [Show details of product template.](https://docs.api.test.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…
  - [Create product template.](https://docs.api.test.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…
  - [Update product template name.](https://docs.api.test.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…
- Products relations
  - [List the relation definitions a product participates in, each with its direction(s).](https://docs.api.test.bluestonepim.com/reference/getproductrelations.md): Returns one entry per relation definition attached to the product, each carrying the relation definition ID and the direction(s) it applies in (`DIRECT`, `REVERSE`, or both). This lists which…
  - [Relate a product to another product under a relation definition.](https://docs.api.test.bluestonepim.com/reference/createproductconnection.md): Creates a single relation from the source product `id` to another product, using the relation definition (relation type) given in the request body. Fails if the source product, the target product, or…
  - [Update a product relations sorting order source.](https://docs.api.test.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…
  - [Remove every relation of one relation definition from a product.](https://docs.api.test.bluestonepim.com/reference/deleteproductconnectionsbyrelation.md): Deletes all relations that link the product `id` to other products under the relation definition `relationId`, in a single call. Use this to clear a whole relation type at once. To remove only…
  - [Retrieve related products for given product and relation.](https://docs.api.test.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…
  - [Relate a product to several other products at once under one relation definition.](https://docs.api.test.bluestonepim.com/reference/createproductconnections.md): Creates relations from the source product `id` to every target product listed in the request body, all under the relation definition `relationId`. Use this to add many related products in a single…
  - [Remove multiple product relations from a specified product and relation.](https://docs.api.test.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…
  - [Update the order of relation definitions on product.](https://docs.api.test.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…
  - [Delete relation between two products.](https://docs.api.test.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…
  - [Update the order of products in a product relation.](https://docs.api.test.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…
  - [Update connection quantity.](https://docs.api.test.bluestonepim.com/reference/updateconnectionquantity.md)
- Products attributes
  - [Add attribute values in given set of products.](https://docs.api.test.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…
  - [Upsert the values of one attribute across many products in a single bulk operation.](https://docs.api.test.bluestonepim.com/reference/upsertattributesbyids.md): For every product listed in the request (selected by ID, max 100) this sets the given values for the one attribute definition: products that already have the attribute get their values updated,…
  - [Update attribute values in given set of products.](https://docs.api.test.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…
  - [Append dictionary value to products.](https://docs.api.test.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…
  - [Deduct dictionary value from products.](https://docs.api.test.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…
  - [Append select/multiselect values to products.](https://docs.api.test.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…
  - [Deduct select/multiselect values from products.](https://docs.api.test.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…
  - [Retrieve the attributes associated with a product.](https://docs.api.test.bluestonepim.com/reference/getproductattributes.md): Returns the attribute values set on a single product, each keyed by its attribute definition ID. Fails if no product with the given ID exists.
  - [Add an attribute to a product.](https://docs.api.test.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 several attributes on one product in a single call.](https://docs.api.test.bluestonepim.com/reference/updateproductattributes.md): For each attribute in the request body (identified by its attribute definition ID, up to 100 per call) this sets the given value on the product: if the product already has that attribute its value is…
  - [Add column attribute to product.](https://docs.api.test.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…
  - [Update column attribute of product.](https://docs.api.test.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,…
  - [Add dictionary attribute to product.](https://docs.api.test.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.test.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.test.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.test.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.test.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.test.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…
  - [Get grouped product attributes.](https://docs.api.test.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…
- Category level attributes
  - [List Category Level Attributes (CLA) across all catalog nodes/categories.](https://docs.api.test.bluestonepim.com/reference/list.md): Returns one paginated entry per assignment - the category it is assigned on, the attribute definition and the current value - so shared values can be reviewed catalog-wide without opening one…
  - [List the Category Level Attributes (CLA) of one catalog node/category.](https://docs.api.test.bluestonepim.com/reference/listattributesattachedtogivennode.md): Returns every attribute that applies to the category: the ones assigned on it, plus the ones assigned on a parent category with propagation switched on. An attribute assigned on a parent without…
  - [Delete Category Level Attribute (CLA) from catalog node/category.](https://docs.api.test.bluestonepim.com/reference/deleteattributefromnode.md): Removes the assignment from this category only: the attribute definition itself is untouched, products keep the values already propagated to them, and subcategories stop inheriting the attribute. An…
  - [Update the value or the propagation, lock and mandatory flags of a Category Level Attribute (CLA) and schedule
propagation task.](https://docs.api.test.bluestonepim.com/reference/updatenodeattributevalue.md): At least one of `attributeValue`, `copyAttribute`, `locked` and `mandatory` must be sent. This is the only operation that sets the three flags, whatever the definition type: `copyAttribute` switches…
  - [Create a simple Category Level Attribute (CLA) and schedule propagation task.](https://docs.api.test.bluestonepim.com/reference/createcatalognodeattribute.md): Handles simple attribute definitions - text, date, numeric, boolean, single-select and multi-select. For the other definition types use the `/column`, `/matrix`, `/dictionary` or `/compound` variants…
  - [Create column Category Level Attribute (CLA) and schedule propagation task.](https://docs.api.test.bluestonepim.com/reference/createcatalognodeattributecolumn.md): Handles column attribute definitions only - for simple definitions use `POST /catalogs/nodes/{id}/attributes/{attributeDefinitionId}` - and fails when the category already has this attribute…
  - [Update column Category Level Attribute (CLA) and schedule propagation task.](https://docs.api.test.bluestonepim.com/reference/updatenodeattributecolumnvalue.md): Expects the complete set of column values: columns left out of `column` are cleared, so send every column that should keep its value. Works both on a column attribute assigned to this category and on…
  - [Create compound Category Level Attribute (CLA) and schedule propagation task.](https://docs.api.test.bluestonepim.com/reference/createcatalognodeattributecompound.md): Attaches a compound attribute definition together with all of its sub-attributes in one call; sub-attributes the category already has are left untouched. No value and no flags are set here - set each…
  - [Create dictionary Category Level Attribute (CLA) and schedule propagation task.](https://docs.api.test.bluestonepim.com/reference/createcatalognodeattributedictionary.md): Attaches a dictionary attribute definition to the category with no values selected yet. Values are selected with `POST /catalogs/nodes/{id}/attributes/{attributeDefinitionId}/dictionary/values`,…
  - [Set values for dictionary Category Level Attribute (CLA) and schedule propagation task.](https://docs.api.test.bluestonepim.com/reference/setdictionaryattributevaluesforcategory.md): Replaces the selected dictionary values with exactly the set sent in the body: values left out are unselected and an empty list clears the selection. The attribute is attached to the category first…
  - [Create matrix Category Level Attribute (CLA) and schedule propagation task.](https://docs.api.test.bluestonepim.com/reference/createcatalognodeattributematrix.md): Handles matrix attribute definitions only - for simple definitions use `POST /catalogs/nodes/{id}/attributes/{attributeDefinitionId}` - and fails when the category already has this attribute…
  - [Update matrix Category Level Attribute (CLA) and schedule propagation task.](https://docs.api.test.bluestonepim.com/reference/updatenodeattributematrixvalue.md): Expects the complete set of matrix values: cells left out of `matrix` are cleared, so send every cell that should keep its value. Works both on a matrix attribute assigned to this category and on one…
- Compound attribute definitions
  - [Lists details of compound attribute definition.](https://docs.api.test.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…
  - [Create compound attribute definition.](https://docs.api.test.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…
  - [List all compound attributes that use the attribute definition.](https://docs.api.test.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…
  - [Delete compound attribute definition.](https://docs.api.test.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 -…
  - [Show details of compound attribute definition.](https://docs.api.test.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…
  - [Update compound attribute definition.](https://docs.api.test.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…
- Relations
  - [Show all relation definitions.](https://docs.api.test.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…
  - [Create new relation definition.](https://docs.api.test.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…
  - [Filter relation definitions.](https://docs.api.test.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…
  - [Delete relation definition.](https://docs.api.test.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 >…
  - [Show relation definition details.](https://docs.api.test.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…
  - [[DEPRECATED; EOL 2027-06-09] Update relation definition.](https://docs.api.test.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…
  - [Update relation definition order.](https://docs.api.test.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…
  - [Show all product relations using relation definition.](https://docs.api.test.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…
  - [Partially update relation definition.](https://docs.api.test.bluestonepim.com/reference/partialupdaterelation.md): Updates only the fields present in the request body (`name`, `reverseName`, `description`, `number`, `direction`, `quantityEnabled`); omitted fields are left unchanged. Use this for a partial edit.…
  - [Update relation definition direction.](https://docs.api.test.bluestonepim.com/reference/updaterelationdirection.md): Switch the relation's direction between `ONE_WAY` and `TWO_WAY`. The change is processed by a background task that reconciles product connections for the relation. Switching from `TWO_WAY` to…
- Product groups
  - [Assign multiple product variants groups to a variant family.](https://docs.api.test.bluestonepim.com/reference/addproductgroups.md): Assigns the specified products as groups of the parent variant family product.
  - [Create variant family.](https://docs.api.test.bluestonepim.com/reference/converttoproductfamily.md): Converts a SINGLE product to a FAMILY product type. This operation creates a new hierarchy level that allows variant groups to be organized under a common family.
  - [Retrieve group level attribute.](https://docs.api.test.bluestonepim.com/reference/getproductgroupattribute.md): Retrieve the details of a specific group level attribute set in a variant family product. Group Level Attribute is a product attribute used to manage product group variations.
  - [Update group level attribute (VLA).](https://docs.api.test.bluestonepim.com/reference/updateproductgroupattribute.md): Updates the specified group level attribute for a variant family.  **Group Attribute Configuration Validation**  Variant-defining attributes must be properly configured to be propagated to groups.…
  - [Unassign product group from variant family.](https://docs.api.test.bluestonepim.com/reference/unassignproductgroup.md): Unassigns the specified GROUP product from the given FAMILY product. The GROUP product will remain a GROUP type.
  - [Update product group order.](https://docs.api.test.bluestonepim.com/reference/moveproductgroup.md): Updates the order of the specified GROUP within a FAMILY product. This operation helps in organizing product groups and maintaining accurate product hierarchies.
  - [Update group level attribute (VLA) for multiple products.](https://docs.api.test.bluestonepim.com/reference/updateproductgroupsattributevlasettings.md): Sets the VLA settings of the given attribute on every listed FAMILY product and propagates the attribute down to their assigned GROUP products. The bulk twin of `PUT…
- Product variants
  - [Assign multiple product variants to a variant group.](https://docs.api.test.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…
  - [Create variant group.](https://docs.api.test.bluestonepim.com/reference/setproductgroup.md): Promotes the specified product to a variant group (changes its type from SINGLE to GROUP) so other products can later be assigned to it as variants. This only turns the product into a group; it does…
  - [Retrieve variant level attribute (VLA).](https://docs.api.test.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…
  - [Update variant level attribute (VLA).](https://docs.api.test.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…
  - [Unassign product variant.](https://docs.api.test.bluestonepim.com/reference/unassignproductvariant.md): Detaches a variant from its variant group. The product is not deleted — it is disconnected from the group and reverts to a standalone SINGLE product.  Fails if the group product is not a variant…
  - [Assign product variant.](https://docs.api.test.bluestonepim.com/reference/addproductvariant.md): Attaches an existing product to a variant group as one of its variants, and propagates the group's variant level attributes (VLAs) down to the newly assigned variant. The target group must already be…
  - [Update product variant order.](https://docs.api.test.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…
  - [Update variant level attribute (VLA) for multiple products.](https://docs.api.test.bluestonepim.com/reference/updateproductvariantsattributevlasettings.md): Sets the VLA settings of the given attribute on every listed GROUP product and propagates the attribute down to their assigned VARIANT products. The bulk twin of `PUT…
- Attribute groups
  - [List all attribute groups.](https://docs.api.test.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…
  - [Create new attribute group.](https://docs.api.test.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…
  - [List definitions that are not in any group.](https://docs.api.test.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…
  - [Change order strategy for definitions without group.](https://docs.api.test.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…
  - [Change attribute's order.](https://docs.api.test.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…
  - [Get attribute root group.](https://docs.api.test.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…
  - [Delete attribute group.](https://docs.api.test.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…
  - [Change group's order.](https://docs.api.test.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…
  - [List definitions in attribute group.](https://docs.api.test.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…
  - [Change order strategy for definitions in group.](https://docs.api.test.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…
  - [Change attribute's order in group.](https://docs.api.test.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…
  - [Rename attribute group.](https://docs.api.test.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,…
  - [Change attribute group number.](https://docs.api.test.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…
- Catalogs
  - [List top-level catalogs.](https://docs.api.test.bluestonepim.com/reference/listcatalogs.md): Returns a paginated list of the catalogs (the root of each catalog tree), not the nodes inside them. To list a node's child nodes use find_catalog_node_children; to get a whole catalog's category…
  - [Archive catalog.](https://docs.api.test.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…
  - [Unarchive catalog.](https://docs.api.test.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,…
  - [List all nodes/categories from catalog.](https://docs.api.test.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…
  - [Get categories with view and cursor

Retrieve a paginated list of child categories from the specified catalog using cursor-based pagination and
view filtering.](https://docs.api.test.bluestonepim.com/reference/getcategoryview.md): This endpoint allows you to efficiently browse large category trees by specifying a cursor position and view configuration, supporting filtering by archive state and context.  For more detailed…
- Products bundles
  - [Create product bundle.](https://docs.api.test.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…
  - [Delete product from bundle.](https://docs.api.test.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.test.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…
  - [Update the quantity of a product included in a bundle.](https://docs.api.test.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…
  - [Change a product's position in a bundle.](https://docs.api.test.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…
- Products assets
  - [Retrieve the IDs of the assets associated with a product, in their display order and paginated.](https://docs.api.test.bluestonepim.com/reference/getproductassets.md): Returns the asset IDs currently attached to the product; the asset content itself lives in the media bank and is not included. Fails if the product does not exist.  For more information on assets in…
  - [Attach several existing assets to a product in one call.](https://docs.api.test.bluestonepim.com/reference/associateassets.md): Each asset must already exist in the media bank; this only links them to the product. Existing associations on the product are preserved, and the new assets are added on top rather than replacing…
  - [Set assets for a product.](https://docs.api.test.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.…
  - [Detach an asset from a product, removing only the link between them.](https://docs.api.test.bluestonepim.com/reference/disassociateassetfromproduct.md): The asset itself is not deleted and remains in the media bank; only its association with this product is removed. Fails if the product does not exist or the asset is not associated with it.  For more…
  - [Attach a single existing asset to a product, identified by asset ID in the path.](https://docs.api.test.bluestonepim.com/reference/associateassetwithproduct.md): The asset must already exist in the media bank; this only links it to the product. Existing associations on the product are kept, and the asset is appended to the end. Fails if the product or the…
  - [Move an asset within a product.](https://docs.api.test.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…
- Category policy
  - [Get policies by category node id.](https://docs.api.test.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…
  - [Add policy to category node.](https://docs.api.test.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…
  - [Delete policy by category node and policy id.](https://docs.api.test.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…
  - [Get policies by category id.](https://docs.api.test.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…
  - [Add policy to category.](https://docs.api.test.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…
  - [Delete policy by category and policy id.](https://docs.api.test.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…
  - [Get categories by policy id.](https://docs.api.test.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…
  - [Get categories node by policy id.](https://docs.api.test.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…
- Products labels
  - [Remove product label from the set of products.](https://docs.api.test.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 product label to the set of products.](https://docs.api.test.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…
  - [Remove a set of labels from a product.](https://docs.api.test.bluestonepim.com/reference/removelabelsfromproduct.md): Detaches the given labels from the product in one call; any listed label that is not currently assigned is ignored (it does not fail). Other labels on the product are left in place. Fails if the…
  - [Retrieve product labels.](https://docs.api.test.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…
  - [Add product labels to a product.](https://docs.api.test.bluestonepim.com/reference/addlabelstoproduct.md): Appends the given labels to the product's existing labels; labels already assigned are left unchanged, so this never removes or replaces the current set. Fails if the product or any of the given…
  - [Remove product label from product.](https://docs.api.test.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.
- Attribute definitions
  - [List all attribute definitions.](https://docs.api.test.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)…
  - [Create a new simple attribute definition.](https://docs.api.test.bluestonepim.com/reference/createattributedefinition.md): Creates a basic (single-value) attribute definition and returns its generated ID in the `resource-id` response header (for example `664cc80da825236207fe01a7`). This endpoint handles simple attributes…
  - [Create column attribute definition.](https://docs.api.test.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:…
  - [Update column attribute definition.](https://docs.api.test.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…
  - [Show number of elements affected by the column attribute definition update operation.](https://docs.api.test.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…
  - [Create dictionary attribute definition.](https://docs.api.test.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:…
  - [Update selected items limit for dictionary attribute definition.](https://docs.api.test.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…
  - [Update dictionary attribute definition.](https://docs.api.test.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.  **Note:**…
  - [Delete dictionary parent from dictionary definition.](https://docs.api.test.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…
  - [Set dictionary parent for filtering dictionary values.](https://docs.api.test.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…
  - [Create dictionary attribute value.](https://docs.api.test.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…
  - [Count dictionary attribute values for given dictionary attribute definition.](https://docs.api.test.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…
  - [List filtered dictionary attribute definitions.](https://docs.api.test.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…
  - [List filtered dictionary attribute values.](https://docs.api.test.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…
  - [Delete dictionary attribute value.](https://docs.api.test.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 -…
  - [Show details of dictionary attribute value.](https://docs.api.test.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…
  - [Update dictionary attribute value.](https://docs.api.test.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 -…
  - [Delete dictionary attribute value parent/child filter.](https://docs.api.test.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…
  - [Create dictionary attribute value parent/child filter.](https://docs.api.test.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…
  - [Search attribute definitions by a filter and return the matching ones as a paged list.](https://docs.api.test.bluestonepim.com/reference/findfilteredattributedefinitions.md): Each filter in the request body selects definitions whose number matches one of the given values (`NUMBER_IN`) or whose ID matches one of the given values (`ID_IN`); an empty or omitted filter list…
  - [Create matrix attribute definition.](https://docs.api.test.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:…
  - [Update matrix attribute definition.](https://docs.api.test.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…
  - [Show number of elements affected by the matrix attribute definition update operation.](https://docs.api.test.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…
  - [List simple attribute definitions.](https://docs.api.test.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…
  - [Delete simple attribute definition.](https://docs.api.test.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…
  - [Show details of attribute definition.](https://docs.api.test.bluestonepim.com/reference/getattributedefinition.md): This operation allows users to access metadata associated with an attribute definition such as its name and description. Fails if no attribute definition with the specified ID exists.  For more…
  - [Update attribute definition metadata.](https://docs.api.test.bluestonepim.com/reference/updatemetadata.md): This endpoint allows you to modify the name and other metadata of the attribute definition within the specified context.  It applies to attribute definitions of every type (simple, dictionary,…
  - [Update simple attribute definition.](https://docs.api.test.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…
  - [Switch the context-awareness of an attribute definition.](https://docs.api.test.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…
  - [Show number of elements affected by the attribute definition delete operation.](https://docs.api.test.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.…
  - [Show number of elements affected by the attribute definition update operation.](https://docs.api.test.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…
  - [List all products that use the simple attribute definition.](https://docs.api.test.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.
  - [Add a new select value to a `single_select` or `multi_select` attribute definition.](https://docs.api.test.bluestonepim.com/reference/createselectvalue.md): The newly created `valueId` is returned in the `resource-id` response header.
  - [Remove a select value from a `single_select` or `multi_select` attribute definition.](https://docs.api.test.bluestonepim.com/reference/deleteselectvalue.md): This is a **destructive** operation — removing a value also removes it from all products and categories that currently use it. Cleanup of products and categories is performed asynchronously by a…
  - [Update an existing select value within a `single_select` or `multi_select` attribute definition.](https://docs.api.test.bluestonepim.com/reference/updateselectvalue.md): Only the fields present in the request body are updated; omitted fields retain their current values.
  - [Move a select value to a specific position within the attribute definition's value list.](https://docs.api.test.bluestonepim.com/reference/reorderselectvalue.md): The value is moved to the specified zero-based position; all remaining values shift automatically.  **Example:** Given order `[A, B, C, D]`, moving `C` to position `0` results in `[C, A, B, D]`.
- Relation policy
  - [Get relations by policy ID.](https://docs.api.test.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…
  - [Get relation policies.](https://docs.api.test.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…
  - [Add policy to the relation.](https://docs.api.test.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…
  - [Delete policy.](https://docs.api.test.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…
- Catalog node assets
  - [List categories associated with asset.](https://docs.api.test.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…
  - [List assets associated with category.](https://docs.api.test.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…
  - [Disassociate asset from category.](https://docs.api.test.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.test.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.test.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.
- Technical
  - [Show service version.](https://docs.api.test.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…

## API Reference: Media bank
- Technical
  - [Show service version.](https://docs.api.test.bluestonepim.com/reference/presentversion.md)
  - [Health checks.](https://docs.api.test.bluestonepim.com/reference/checkstatuses.md)
- Labels
  - [Lists labels.](https://docs.api.test.bluestonepim.com/reference/describe.md)
  - [Create a custom type of media label.](https://docs.api.test.bluestonepim.com/reference/create.md): The created label is always of type CUSTOM; the type cannot be chosen.
  - [Create a specified type of media label.](https://docs.api.test.bluestonepim.com/reference/createtype.md)
  - [Get label with given id.](https://docs.api.test.bluestonepim.com/reference/getlabelbyid.md)
  - [Update a custom type of media label.](https://docs.api.test.bluestonepim.com/reference/update.md)
  - [Delete a custom type of media label.](https://docs.api.test.bluestonepim.com/reference/delete-1.md)
  - [Update a specified type of media label.](https://docs.api.test.bluestonepim.com/reference/updatetype.md)
  - [Delete a specified type of media label.](https://docs.api.test.bluestonepim.com/reference/deletetype.md)
  - [List specified type of media labels.](https://docs.api.test.bluestonepim.com/reference/list-1.md)
- Upload
  - [Complete asset creation. The asset will be moved to \assets path.](https://docs.api.test.bluestonepim.com/reference/completeasset.md): Second step of the two-step upload: finalizes a draft asset (from POST /upload) once its file has been uploaded, making it visible in the asset library.
  - [Lists assets in upload phase for current user.](https://docs.api.test.bluestonepim.com/reference/describeassetuploads.md)
  - [Start a new asset upload.](https://docs.api.test.bluestonepim.com/reference/createasset.md): First step of the two-step upload: creates a draft asset and returns its id plus an actionUrl (and form parameters) to POST the file to. The asset stays invisible until the file is uploaded and you…
  - [Update the asset's information to be uploaded.](https://docs.api.test.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.test.bluestonepim.com/reference/createversionasset.md)
  - [Cancel asset's creation. Any uploaded file and asset will be removed.](https://docs.api.test.bluestonepim.com/reference/deleteassetupload.md)
- Asset attributes
  - [Assign attribute to asset.](https://docs.api.test.bluestonepim.com/reference/assignattributetoasset.md): Attaches the attribute definition to the asset without setting a value; use the /simple, /select or /dictionary endpoints afterwards to set the value. Fails if the attribute is already assigned to…
  - [Unassign attribute from asset.](https://docs.api.test.bluestonepim.com/reference/unassignattributefromasset.md)
  - [Get list of attributes associated to asset.](https://docs.api.test.bluestonepim.com/reference/getassetattributes.md)
  - [Set values to dictionary asset's attribute](https://docs.api.test.bluestonepim.com/reference/updateassetdictionaryattributevalues.md): For a simple attribute use the /simple endpoint; for a select attribute use the /select endpoint.
  - [Set values to select asset's attribute](https://docs.api.test.bluestonepim.com/reference/updateassetselectattributevalues.md): For a simple attribute use the /simple endpoint; for a dictionary attribute use the /dictionary endpoint.
  - [Set value to simple asset's attribute](https://docs.api.test.bluestonepim.com/reference/updateassetsimpleattributevalue.md): For a select attribute use the /select endpoint; for a dictionary attribute use the /dictionary endpoint.
  - [Append select/multiselect values to assets.](https://docs.api.test.bluestonepim.com/reference/appendselectvalues-1.md)
  - [Deduct select/multiselect values from assets.](https://docs.api.test.bluestonepim.com/reference/deductselectvalues-1.md)
  - [Unassign attribute from assets.](https://docs.api.test.bluestonepim.com/reference/deleteassetattributes.md)
  - [Add attribute to assets. In case of a quota exceeded error, a partial update is possible.](https://docs.api.test.bluestonepim.com/reference/addattributetoassets.md)
  - [Upsert assets attribute.  In case of a quota exceeded error, a partial update is possible.](https://docs.api.test.bluestonepim.com/reference/addattributetoassets_1.md)
  - [Update assets attribute.](https://docs.api.test.bluestonepim.com/reference/updateassetsattribute.md)
  - [Append values to dictionary asset's attribute](https://docs.api.test.bluestonepim.com/reference/appendassetdictionaryattributevalues.md)
  - [Deduct values to dictionary asset's attribute](https://docs.api.test.bluestonepim.com/reference/deductassetdictionaryattributevalues.md)
- Assets
  - [Replace the asset's labels.](https://docs.api.test.bluestonepim.com/reference/setlabelstoasset.md): Replaces the whole label set — this is not an append. To remove a single label instead, use DELETE /assets/{id}/labels/{labelId}.
  - [Adds labels to asset's labels.](https://docs.api.test.bluestonepim.com/reference/addlabelstoasset.md)
  - [Bulk add assets label.](https://docs.api.test.bluestonepim.com/reference/bulkaddassetslabels.md)
  - [Bulk delete assets label.](https://docs.api.test.bluestonepim.com/reference/bulkdeleteassetslabels.md)
  - [Bulk update of asset published flag.](https://docs.api.test.bluestonepim.com/reference/bulkupdateassetpublished.md)
  - [[DEPRECATED; EOL 2026-07-30] Describe asset.](https://docs.api.test.bluestonepim.com/reference/describeasset.md): This endpoint is deprecated and will be removed soon. Instead, please use these endpoints:  <br/> <br/> POST /assets/{id}/views <br/>
  - [Mark current asset as deleted.](https://docs.api.test.bluestonepim.com/reference/deleteasset.md)
  - [Describe working asset versions.](https://docs.api.test.bluestonepim.com/reference/describeassetversions.md)
  - [Duplicate the asset.](https://docs.api.test.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.test.bluestonepim.com/reference/generatefixedlink.md)
  - [[DEPRECATED; EOL 2026-07-30] Describe working assets. Search enabled by assetIds with paging.](https://docs.api.test.bluestonepim.com/reference/listassetsbyids.md): This endpoint is deprecated and will be removed soon. Instead, please use these endpoints:  <br/> <br/> POST /assets/views/by-ids <br/>
  - [Describe working assets. Search enabled with query parameters.](https://docs.api.test.bluestonepim.com/reference/listassetsbynumbers.md)
  - [List working asset using cursor.](https://docs.api.test.bluestonepim.com/reference/listworkingassetswithcursor.md)
  - [Removes given label from the asset's labels.](https://docs.api.test.bluestonepim.com/reference/removelabelfromasset.md): Removes only this one label; the asset's other labels are kept. To replace the whole set at once, use PUT /assets/{id}/labels.
  - [[DEPRECATED; EOL 2027-01-03] Bulk delete operation for list of assets.](https://docs.api.test.bluestonepim.com/reference/removelistofassets.md)
  - [Revert version of asset.](https://docs.api.test.bluestonepim.com/reference/revertasset.md)
  - [Update asset alpha channel flag.](https://docs.api.test.bluestonepim.com/reference/updateassetalphachannel.md)
  - [Update asset clipping path.](https://docs.api.test.bluestonepim.com/reference/updateassetclippingpath.md)
  - [Update asset description.](https://docs.api.test.bluestonepim.com/reference/updateassetdescription.md)
  - [Update asset internal flag.](https://docs.api.test.bluestonepim.com/reference/updateassetinternal.md)
  - [Update asset name.](https://docs.api.test.bluestonepim.com/reference/updateassetname.md)
  - [Update asset number.](https://docs.api.test.bluestonepim.com/reference/updateassetnumber.md)
  - [Update asset published flag.](https://docs.api.test.bluestonepim.com/reference/updateassetpublished.md)
  - [Retrieve a single asset together with the requested views.](https://docs.api.test.bluestonepim.com/reference/getassetviewsbyid.md): To fetch several assets at once, use POST /assets/views/by-ids.
  - [Retrieve multiple assets together with the requested views.](https://docs.api.test.bluestonepim.com/reference/listassetviewsbyids.md): To fetch a single asset, use POST /assets/{id}/views.
  - [Generate presigned download URLs for assets.](https://docs.api.test.bluestonepim.com/reference/generatedownloadurls.md): Generate temporary download URLs for private assets. The endpoint returns presigned URLs for the original stored file for each requested asset. The URLs are generated when the endpoint is called and…
  - [Bulk delete assets by IDs.](https://docs.api.test.bluestonepim.com/reference/removeassetsbyids.md)

## API Reference: Search
- Full-text search
  - [Execute the search query.](https://docs.api.test.bluestonepim.com/reference/find.md)
- Search
  - [Search for products using an Elasticsearch query.](https://docs.api.test.bluestonepim.com/reference/productssearch.md)
  - [Search for products using an Elasticsearch query and scroll. Prefer using POST products/cursor instead.](https://docs.api.test.bluestonepim.com/reference/productssearchwithscroll.md)
  - [Count for products using an Elasticsearch query.](https://docs.api.test.bluestonepim.com/reference/productscount.md)
  - [Search for assets using an Elasticsearch query.](https://docs.api.test.bluestonepim.com/reference/assetssearch.md)
  - [Count for assets using an Elasticsearch query.](https://docs.api.test.bluestonepim.com/reference/assetscount.md)
  - [Search for assets using cursor-based pagination.](https://docs.api.test.bluestonepim.com/reference/assetssearchwithcursor.md)
  - [Search for products using cursor-based pagination with default sorting.](https://docs.api.test.bluestonepim.com/reference/productssearchwithcursor.md)

## API Reference: Labels
- Labels
  - [Get a label.](https://docs.api.test.bluestonepim.com/reference/find-1.md)
  - [Update a label.](https://docs.api.test.bluestonepim.com/reference/update-1.md): Replaces a label's name for one context only - the context given by the context header, or your default context if omitted - leaving that label's names in other contexts unchanged. Fails if the label…
  - [Delete a label.](https://docs.api.test.bluestonepim.com/reference/delete-2.md): Permanently deletes a label by id. Fails if the label id does not exist.
  - [List labels.](https://docs.api.test.bluestonepim.com/reference/list-2.md): Lists labels for the current organization, paginated. Each label's name is resolved to the context given by the context header, or your default context if omitted; if no translation exists in that…
  - [Create a new label.](https://docs.api.test.bluestonepim.com/reference/create-1.md): Creates a label in the current organization; the created label's id is returned via resourceId, with no response body otherwise. The name is stored only for the context given by the context header,…
  - [List labels by ids.](https://docs.api.test.bluestonepim.com/reference/findbyids.md)

## API Reference: Global settings
- Filters
  - [Grant or update filter permission to user.](https://docs.api.test.bluestonepim.com/reference/grantpermission.md)
  - [Revoke filter permission from user.](https://docs.api.test.bluestonepim.com/reference/revokepermission.md)
  - [List public and private filters using filtering criteria.](https://docs.api.test.bluestonepim.com/reference/findall.md)
  - [List filters using filtering criteria.](https://docs.api.test.bluestonepim.com/reference/findfilter.md)
  - [Create new filter.](https://docs.api.test.bluestonepim.com/reference/createfilter.md)
  - [Get filter by using id.](https://docs.api.test.bluestonepim.com/reference/getfilter.md)
  - [Delete filter using id.](https://docs.api.test.bluestonepim.com/reference/deletefilter.md)
  - [Update filter using id.](https://docs.api.test.bluestonepim.com/reference/updatefilter.md)
  - [Delete filter of any user.](https://docs.api.test.bluestonepim.com/reference/deletefilterfromall.md)
  - [Update public and private filter](https://docs.api.test.bluestonepim.com/reference/updatepublicfilter.md)
  - [Lists users with filter permission.](https://docs.api.test.bluestonepim.com/reference/getpermissions.md)
- Contexts
  - [Get a single context definition by id.](https://docs.api.test.bluestonepim.com/reference/get.md): Returns the context whether it's active or archived — unlike the list endpoint, no state filter is applied here. Fails if no context with the given id exists in the caller's organization.
  - [Update context definition.](https://docs.api.test.bluestonepim.com/reference/update-2.md)
  - [Archive context definition.](https://docs.api.test.bluestonepim.com/reference/archive-1.md)
  - [List context definitions for the current organization.](https://docs.api.test.bluestonepim.com/reference/find-2.md): Active contexts are returned by default; pass contextState=ARCHIVE to list archived ones instead. To look up contexts by known names rather than by state, use "List context definitions by names"…
  - [Create context definition.](https://docs.api.test.bluestonepim.com/reference/create-2.md)
  - [List context definitions by names.](https://docs.api.test.bluestonepim.com/reference/findbynames.md)

## API Reference: History
- History
  - [Retrieve history events.](https://docs.api.test.bluestonepim.com/reference/list-3.md)
  - [Retrieve history events for given entity type.](https://docs.api.test.bluestonepim.com/reference/list_1.md)
  - [Retrieve the history (audit log) events recorded for one specific entity instance.](https://docs.api.test.bluestonepim.com/reference/list_2.md): Returns a paginated list of history events for the entity identified by entityType and id, optionally narrowed with the query parameters below. Use GET /history/{entityType} to list events for all…
  - [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.test.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…
  - [Count events for given entity.](https://docs.api.test.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.test.bluestonepim.com/reference/search-1.md)
  - [Retrieve history events for given entity that have a value from the query.](https://docs.api.test.bluestonepim.com/reference/search_1.md)

## API Reference: Tasks
- Technical
  - [Show service version.](https://docs.api.test.bluestonepim.com/reference/presentversion-2.md)
- Task comments
  - [List all comments with replies for given task.](https://docs.api.test.bluestonepim.com/reference/listalltaskcomments.md): Fails with the same permission-denied error whether the task does not exist or you simply lack comment access to it — the response does not distinguish the two. To add a new comment use POST…
  - [Add a comment for given task](https://docs.api.test.bluestonepim.com/reference/addtaskcomment.md): Creates a new top-level comment on the task; use POST /comments/{taskId}/{commentId} instead to reply to an existing comment. Fails with the same permission-denied error whether the task does not…
  - [Add a comment reply for given task comment.](https://docs.api.test.bluestonepim.com/reference/addtaskcommentreply.md)
- Tasks reminders
  - [Get reminders for task.](https://docs.api.test.bluestonepim.com/reference/getreminderconfig.md)
  - [Create reminder for task (max 5 allowed per task).](https://docs.api.test.bluestonepim.com/reference/createtasksreminderconfig.md)
  - [Update reminder config.](https://docs.api.test.bluestonepim.com/reference/updatereminderconfig.md)
  - [Delete reminder config.](https://docs.api.test.bluestonepim.com/reference/deletereminderconfig.md)
- Tasks
  - [Assign products to task.](https://docs.api.test.bluestonepim.com/reference/assignproducts.md): Associates one or more existing products with the task so they show up in its product scope; products already associated with the task are silently skipped rather than causing an error. Fails…
  - [Assign task.](https://docs.api.test.bluestonepim.com/reference/assigntask.md): Reassigns an existing task to a different user or user group; use POST /tasks to set the initial assignee when creating a task. Callable by the task's creator, its current assignee, or a user holding…
  - [Complete product in scope of a task.](https://docs.api.test.bluestonepim.com/reference/completetaskproduct.md): Marks a product that is already assigned to the task as completed; use PUT /tasks/{taskId}/products/{productId}/revoke to undo this. Fails if the product is not currently associated with the task —…
  - [List all tasks for organization.](https://docs.api.test.bluestonepim.com/reference/listtasks.md)
  - [Create new task.](https://docs.api.test.bluestonepim.com/reference/createtask.md): Use to create a brand-new task. To modify an existing task's title, description, due date, or context use PUT /tasks/{taskId}; to reassign it use PUT /tasks/{taskId}/assign instead.
  - [Delete product from task scope.](https://docs.api.test.bluestonepim.com/reference/deletetaskproduct.md): Removes the product-task association entirely, dropping the product out of the task's scope; use the complete/revoke endpoints instead if you only want to change its completion status without…
  - [List all/archived/assigned/created tasks for user.](https://docs.api.test.bluestonepim.com/reference/fetchtasks.md)
  - [List all/archived/assigned tasks for user group.](https://docs.api.test.bluestonepim.com/reference/fetchtasksforusergroup.md)
  - [Get single task by id.](https://docs.api.test.bluestonepim.com/reference/getsingletask.md)
  - [Update task data.](https://docs.api.test.bluestonepim.com/reference/updatetask.md): Modifies an existing task's title, description, due date, or context. This is a partial update: any field left blank or omitted keeps its current value rather than being cleared. Fails if the task…
  - [List archived tasks for organization.](https://docs.api.test.bluestonepim.com/reference/listarchivedtasksv2.md)
  - [List folders of tasks for user.](https://docs.api.test.bluestonepim.com/reference/listfolders.md)
  - [Mark product as incomplete in scope of a task.](https://docs.api.test.bluestonepim.com/reference/revoketaskproduct.md)
- User tasks
  - [Complete task by id of logged in user.](https://docs.api.test.bluestonepim.com/reference/completeusertask.md): Marks the entire task as done. This differs from PUT /tasks/{taskId}/products/{productId}/complete, which completes a single product within the task's scope — the task itself stays open until this…
  - [Get tasks of logged in user.](https://docs.api.test.bluestonepim.com/reference/getallusertasks.md)
  - [Get tasks assigned to logged in user.](https://docs.api.test.bluestonepim.com/reference/getassignedusertasks.md)
  - [Get task by id of logged in user.](https://docs.api.test.bluestonepim.com/reference/getusertask.md)
  - [Set task as important by id of logged in user.](https://docs.api.test.bluestonepim.com/reference/setimportantusertask.md)
  - [Set task as unimportant by id of logged in user.](https://docs.api.test.bluestonepim.com/reference/setunimportantusertask.md)
  - [Revoke task by id of logged in user.](https://docs.api.test.bluestonepim.com/reference/uncompleteusertask.md)

## API Reference: Query builder
- savedView
  - [Validate passed view](https://docs.api.test.bluestonepim.com/reference/getvalidview.md)
- Products
  - [Search for products for given query.](https://docs.api.test.bluestonepim.com/reference/search-2.md)
  - [Get number of products for given query.](https://docs.api.test.bluestonepim.com/reference/getcount.md)
  - [Scroll products for given query.](https://docs.api.test.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…
  - [Create a new persisted product query.](https://docs.api.test.bluestonepim.com/reference/createpersistedproductquery.md)
  - [Update persisted product query.](https://docs.api.test.bluestonepim.com/reference/updatepersistedproductquery.md)
  - [Delete persisted product query.](https://docs.api.test.bluestonepim.com/reference/deletepersistedproductquery.md)
  - [List persisted product queries.](https://docs.api.test.bluestonepim.com/reference/listpersistedproductqueries.md)
  - [Search for persisted queries for given product.](https://docs.api.test.bluestonepim.com/reference/searchpersistedproductqueries.md)
- Organization
  - [/organization](https://docs.api.test.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.

## API Reference: Public API sync
- Session sync
  - [Close session.](https://docs.api.test.bluestonepim.com/reference/closesession.md): Despite the name, this is what actually starts the sync — it does not just close the session for bookkeeping. Call it once all products have been added with add_products_to_publish_session; it stops…
  - [Cancel session.](https://docs.api.test.bluestonepim.com/reference/cancelsession.md)
  - [Add products to session.](https://docs.api.test.bluestonepim.com/reference/addproductstosession.md): Queues products to be synced once the session is closed with complete_publish_session. Call this as many times as needed (each call holds at most 100 products) while the session is still CREATED; it…
  - [Create a new sync session.](https://docs.api.test.bluestonepim.com/reference/createsession.md): Creates an empty session that acts as a container for one publish/unpublish run, scoped to the given contexts. It does not accept product ids or start syncing by itself: add products with…
  - [Get sync session.](https://docs.api.test.bluestonepim.com/reference/getsession.md): Use this to poll a session's progress after closing it. A session moves through CREATED (open for adding products) -> INITIALIZED -> IN_PROGRESS -> a terminal status: PUBLISHED, PUBLISHED_WITH_ISSUES…
- Products
  - [List product states.](https://docs.api.test.bluestonepim.com/reference/searchproductstatebyids.md)
  - [Change product states.](https://docs.api.test.bluestonepim.com/reference/changeproductstate.md): Records the target publish state (PUBLISH or UNPUBLISH) for a batch of products in one context; it does not push anything live by itself. To actually publish or unpublish the products, create a…
- Categories
  - [List category states.](https://docs.api.test.bluestonepim.com/reference/searchcategorystatebyids.md)
- Session report
  - [Create products report file.](https://docs.api.test.bluestonepim.com/reference/createsessionreportproductsfile.md)
  - [Get products by issue type for the session.](https://docs.api.test.bluestonepim.com/reference/getproductidsbyissuetype.md)
  - [Create entities report file.](https://docs.api.test.bluestonepim.com/reference/createsessionreportfile.md)
  - [Create assets report file.](https://docs.api.test.bluestonepim.com/reference/createsessionreportassetfile.md)
  - [Get products report link.](https://docs.api.test.bluestonepim.com/reference/getsessionreportproductslink.md)
  - [Get products issues for the session.](https://docs.api.test.bluestonepim.com/reference/getsessionproductsissues.md): Lists the individual products that failed or were skipped while syncing this session, grouped by issue type (e.g. version conflicts from a stale lastUpdate, or products that could not be published).…
  - [Get entities issues for the session.](https://docs.api.test.bluestonepim.com/reference/getsessionentitiesissues.md): Lists the per-entity problems (e.g. categories or other non-product/asset entities) that went wrong while syncing this session, grouped by issue type. Use it to explain a PUBLISHED_WITH_ISSUES result…
  - [Get assets issues for the session.](https://docs.api.test.bluestonepim.com/reference/getsessionassetsissues.md): Lists the individual assets (e.g. images or files) that failed while syncing this session, grouped by issue type. Use it to explain a PUBLISHED_WITH_ISSUES result at the asset level, once…
  - [Get entities report link.](https://docs.api.test.bluestonepim.com/reference/getsessionreportlink.md)
  - [Get assets report link.](https://docs.api.test.bluestonepim.com/reference/getsessionreportassetlink.md)
  - [Get a session report.](https://docs.api.test.bluestonepim.com/reference/getsessionreport.md): Returns running totals for the session and can be called at any time, including while it is still IN_PROGRESS — counts simply reflect what has been processed so far. metrics/categoriesMetrics stay…
  - [Get assets by issue type for the session.](https://docs.api.test.bluestonepim.com/reference/getassetidsbyissuetype.md)

## API Reference: Public API
- Products
  - [/products/list](https://docs.api.test.bluestonepim.com/reference/findproducts-1.md): Find products in PAPI. Note: For large-scale operations please use the '/products/cursor/all' endpoint.
  - [Show list of products filtered by ids.](https://docs.api.test.bluestonepim.com/reference/findproductsbyids.md)
  - [Show list of products filtered by numbers.](https://docs.api.test.bluestonepim.com/reference/findproductsbynumbers.md)
  - [/products/cursor/all](https://docs.api.test.bluestonepim.com/reference/findproductsbycursor.md)
  - [/products/{id}](https://docs.api.test.bluestonepim.com/reference/getproduct-1.md): Get the product with given id
- Categories
  - [/categories](https://docs.api.test.bluestonepim.com/reference/getcategories.md): Describe the root categories available in the system.  <br><b>name</b> - category contains a name  <br><b>itemsOnPage</b> - items to be displayed on page.  <br><b>pageNo</b> - page number to display.
  - [/categories/{categoryId}/ancestors](https://docs.api.test.bluestonepim.com/reference/getancestors.md): Describe categories associated with given category. <br><b>deep</b> - deepness of sub categories to be retrieved. default 10.
  - [/categories/scan](https://docs.api.test.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.test.bluestonepim.com/reference/getcategorybyid.md): Describe categories associated with given category. <br><b>deep</b> - deepness of sub categories to be retrieved. default 10. <br>This endpoint is deprecated and will be removed soon. Instead, please…
  - [/categories/{categoryId}/products](https://docs.api.test.bluestonepim.com/reference/getproducts.md): Get a list of products for given category. <br><b>subCategories</b> - default false. Set to true provides products for all sub categories. <br><b>withLabels</b> - format "label1;label2" a set of…
  - [Show list of categories filtered by numbers.](https://docs.api.test.bluestonepim.com/reference/findcategoriesbynumbers.md)
- Syncs
  - [Retrieves a collection of publish info for given tenant.](https://docs.api.test.bluestonepim.com/reference/getpublishinfos.md)
  - [Retrieves the information about given PublishInfo environment.](https://docs.api.test.bluestonepim.com/reference/getpublishinfo.md)
- Differences
  - [/differences/products](https://docs.api.test.bluestonepim.com/reference/getproductdifferences.md): Return a set of differences done during last sync operation.  <br><b>diffType</b> - filter returned values on difference type.  <br><b>itemsOnPage</b> - items to be displayed on page.…
  - [/differences/sync/{id}/products](https://docs.api.test.bluestonepim.com/reference/getproductdifferencesonsyncdeletes.md): Return a set of changed products with given sync  <br><b>id</b> - sync id for which differences should be retrieved.  <br><b>diffType</b> - filter returned values on difference type.…
  - [/differences/categories](https://docs.api.test.bluestonepim.com/reference/getcategorydifferences.md): Return a set of changed categories during last publish  <br><b>diffType</b> - filter returned values on difference type.  <br><b>itemsOnPage</b> - amount of items to be retrieved.  <br><b>pageNo</b>…
  - [/differences/sync/{id}/categories](https://docs.api.test.bluestonepim.com/reference/getcategorydifferencesonsyncdeletes.md): Return a set of differences done with a given sync.  <br><b>id</b> - sync id for which differences should be retrieved.  <br><b>itemsOnPage</b> - items to be displayed on page.  <br><b>pageNo</b> -…
  - [/differences/attributes](https://docs.api.test.bluestonepim.com/reference/getattributedifferences.md): Return a set of differences done during last sync operation.  <br><b>diffType</b> - filter returned values on difference type.  <br><b>itemsOnPage</b> - items to be displayed on page.…
  - [/differences/sync/{id}/attributes](https://docs.api.test.bluestonepim.com/reference/getattributedifferencesonsyncdeletes.md): Return a set of changed attributes with given sync  <br><b>id</b> - sync id for which differences should be retrieved.  <br><b>diffType</b> - filter returned values on difference type.…
  - [/differences/relations](https://docs.api.test.bluestonepim.com/reference/getrelationdifferences.md): Return a set of differences done during last sync operation.  <br><b>diffType</b> - filter returned values on difference type.  <br><b>itemsOnPage</b> - items to be displayed on page.…
  - [/differences/sync/{id}/relations](https://docs.api.test.bluestonepim.com/reference/getrelationdifferencesonsyncdeletes.md): Return a set of changed relations with given sync  <br><b>id</b> - sync id for which differences should be retrieved.  <br><b>diffType</b> - filter returned values on difference type.…
- Contexts
  - [lists currently available publications](https://docs.api.test.bluestonepim.com/reference/getsegmentinfo.md)
- Health
  - [/health](https://docs.api.test.bluestonepim.com/reference/gethealth.md): A Health check for PAPI service.
- Relations
  - [/relations](https://docs.api.test.bluestonepim.com/reference/getrelations.md): Describe the relations available in the system.
- Attributes
  - [/attributes](https://docs.api.test.bluestonepim.com/reference/getattributes.md): Describe the attributes available in the system.  <br><b>id</b> - attribute id.  <br><b>itemsOnPage</b> - items to be displayed on page.  <br><b>pageNo</b> - page number to display.
  - [/attributes/dictionary/{attributeDefinitionId}/values/cursor/all](https://docs.api.test.bluestonepim.com/reference/finddictionaryvaluesbycursor.md)
  - [/attributes/by-numbers](https://docs.api.test.bluestonepim.com/reference/findpattributesbynumbers.md)

## API Reference: IDP
- Additional user properties
  - [Returns list of additional user properties.](https://docs.api.test.bluestonepim.com/reference/getadditionaluserproperties.md)
- Consents
  - [Returns the latest agreement.](https://docs.api.test.bluestonepim.com/reference/getlatestagreement.md)
  - [Check if user has approved latest agreement.](https://docs.api.test.bluestonepim.com/reference/getadditionalconsentproperties.md)
  - [Accept agreement with given id.](https://docs.api.test.bluestonepim.com/reference/acceptagreement.md)
- API Clients
  - [Returns list of registered API Clients.](https://docs.api.test.bluestonepim.com/reference/getallapiclients.md)
  - [Returns list of registered API Clients names and ids.](https://docs.api.test.bluestonepim.com/reference/getallapiclientsname.md)
- Dependent permissions
  - [Returns list of all dependent permissions for a permissions.](https://docs.api.test.bluestonepim.com/reference/getdependentpermissionsforallpermissions.md): Dependent permissions are returned sorted by creation date, oldest first.
- Managed roles
  - [Returns list of managed roles.](https://docs.api.test.bluestonepim.com/reference/getallmanagedroles.md)
  - [Returns managed role.](https://docs.api.test.bluestonepim.com/reference/getmanagedrolewithid.md)
- Me
  - [Returns simplified list of UI permissions in account from token.](https://docs.api.test.bluestonepim.com/reference/getuseruipermissions.md)
  - [Reset MFA secret for currently logged in user.](https://docs.api.test.bluestonepim.com/reference/resetmfa.md)
- Organizations
  - [Returns list of user organizations.](https://docs.api.test.bluestonepim.com/reference/getuserorganizations.md)
  - [Return organization.](https://docs.api.test.bluestonepim.com/reference/getorganizationwithid.md)
- Permissions
  - [Returns list of permissions.](https://docs.api.test.bluestonepim.com/reference/getallpermissions.md): Permissions are returned sorted by creation date, oldest first.
  - [Return permission.](https://docs.api.test.bluestonepim.com/reference/getpermissionwithid.md)
- Plugins
  - [Returns ids of assigned plugins for organization from token.](https://docs.api.test.bluestonepim.com/reference/getallpluginpermissions.md)
  - [Return permissions for specific plugin in organization.](https://docs.api.test.bluestonepim.com/reference/getpluginpermissionwithid.md)
- Policies
  - [Returns list of policies.](https://docs.api.test.bluestonepim.com/reference/getallpolicies.md)
  - [Create new policy.](https://docs.api.test.bluestonepim.com/reference/createpolicy.md)
  - [Return policy.](https://docs.api.test.bluestonepim.com/reference/getpolicywithid.md)
  - [Update policy.](https://docs.api.test.bluestonepim.com/reference/updatepolicywithid.md)
  - [Archive policy.](https://docs.api.test.bluestonepim.com/reference/archivepolicywithid.md)
- Roles
  - [Returns list of roles.](https://docs.api.test.bluestonepim.com/reference/getallroles.md)
  - [Create new role.](https://docs.api.test.bluestonepim.com/reference/createrole.md)
  - [Returns role.](https://docs.api.test.bluestonepim.com/reference/getrolewithid.md)
  - [Archive role.](https://docs.api.test.bluestonepim.com/reference/archiverolewithid.md)
  - [Edit role.](https://docs.api.test.bluestonepim.com/reference/updaterolewithid.md)
  - [Assign permissions by ids to role by id.](https://docs.api.test.bluestonepim.com/reference/assignrolepermissionswithid.md)
  - [Revoke permissions by ids of role by id.](https://docs.api.test.bluestonepim.com/reference/revokerolepermissionswithid.md)
  - [Get permissions for plugin.](https://docs.api.test.bluestonepim.com/reference/getpluginpermissions.md)
  - [Update permissions for plugin.](https://docs.api.test.bluestonepim.com/reference/updatepluginpermissions.md)
  - [Assign plugin permissions to plugin.](https://docs.api.test.bluestonepim.com/reference/assignpluginpermissions.md)
  - [Revoke plugin permissions from plugin.](https://docs.api.test.bluestonepim.com/reference/revokepluginpermissions.md)
  - [Get default role.](https://docs.api.test.bluestonepim.com/reference/getdefaultrole.md)
  - [Set default role.](https://docs.api.test.bluestonepim.com/reference/setdefaultrole.md)
  - [Clear default role.](https://docs.api.test.bluestonepim.com/reference/cleardefaultrole.md)
- Services
  - [Returns list of registered API Clients names and ids.](https://docs.api.test.bluestonepim.com/reference/getallservicesids.md)
- SSO Providers
  - [Returns list of SSO provider configurations for the authenticated organization.](https://docs.api.test.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.test.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.
- UserGroups
  - [Create new user group.](https://docs.api.test.bluestonepim.com/reference/createusergroup.md)
  - [Returns list of user groups.](https://docs.api.test.bluestonepim.com/reference/getusergroupslist.md)
  - [Returns total number of user groups.](https://docs.api.test.bluestonepim.com/reference/getusergroupscount.md)
  - [Returns user group.](https://docs.api.test.bluestonepim.com/reference/getusergroupwithid.md)
  - [Update user group.](https://docs.api.test.bluestonepim.com/reference/updateusergroup.md)
  - [Delete user group.](https://docs.api.test.bluestonepim.com/reference/deleteusergroup.md)
  - [/userGroups/{id}/duplicate](https://docs.api.test.bluestonepim.com/reference/duplicateusergroup.md)
  - [Add role to user group.](https://docs.api.test.bluestonepim.com/reference/addroletousergroup.md)
  - [Remove role from user group.](https://docs.api.test.bluestonepim.com/reference/removerolefromusergroup.md)
  - [Assign policy to user group](https://docs.api.test.bluestonepim.com/reference/assignpolicytousergroup.md)
  - [Unassign policy from user group](https://docs.api.test.bluestonepim.com/reference/unassignpolicyfromusergroup.md)
  - [Add managed role to user group.](https://docs.api.test.bluestonepim.com/reference/addmanagedroletousergroup.md)
  - [Remove managed role from user group.](https://docs.api.test.bluestonepim.com/reference/removemanagedrolefromusergroup.md)
- Users
  - [Returns the list of users in the caller's organization.](https://docs.api.test.bluestonepim.com/reference/getusers.md)
  - [Create new user.](https://docs.api.test.bluestonepim.com/reference/createuser.md)
  - [Returns the user. Fails if no user with that id exists in the caller's organization.](https://docs.api.test.bluestonepim.com/reference/getuserwithid.md)
  - [Update user.](https://docs.api.test.bluestonepim.com/reference/updateuser.md)
  - [Upload user picture.](https://docs.api.test.bluestonepim.com/reference/uploaduserpicture.md)
  - [Change user password.](https://docs.api.test.bluestonepim.com/reference/changeuserpassword.md)
  - [Resend join email.](https://docs.api.test.bluestonepim.com/reference/resendjoinemail.md)
  - [Set user status.](https://docs.api.test.bluestonepim.com/reference/setuserstatus.md)
  - [Update user type.](https://docs.api.test.bluestonepim.com/reference/updateusertype.md)
  - [Grant role.](https://docs.api.test.bluestonepim.com/reference/grantrole.md)
  - [Revoke role.](https://docs.api.test.bluestonepim.com/reference/revokerole.md)
  - [Grant policy.](https://docs.api.test.bluestonepim.com/reference/grantpolicy.md)
  - [Revoke policy.](https://docs.api.test.bluestonepim.com/reference/revokepolicy.md)
  - [Grant managed role.](https://docs.api.test.bluestonepim.com/reference/grantmanagedrole.md)
  - [Revoke managed role.](https://docs.api.test.bluestonepim.com/reference/revokemanagedrole.md)
  - [Grant additional properties.](https://docs.api.test.bluestonepim.com/reference/assignpropertiestouser.md)
  - [Revoke additional properties.](https://docs.api.test.bluestonepim.com/reference/removepropertiesfromuser.md)
  - [Assign user group to user.](https://docs.api.test.bluestonepim.com/reference/assignusergrouptouser.md)
  - [Unassign user group from user.](https://docs.api.test.bluestonepim.com/reference/unassignusergroupfromuser.md)
  - [Reset MFA secret for user.](https://docs.api.test.bluestonepim.com/reference/resetmfaforuser.md)

## API Reference: External notifications
- Subscriptions webhook
  - [Unsubscribe for given events for given webhook.](https://docs.api.test.bluestonepim.com/reference/unsubscribe.md)
  - [Get all events subscriptions enabled for given webhook.](https://docs.api.test.bluestonepim.com/reference/findwebhook.md)
  - [Subscribe for given events for given webhook.](https://docs.api.test.bluestonepim.com/reference/subscribe.md)
- Webhooks
  - [Create webhook.](https://docs.api.test.bluestonepim.com/reference/create-3.md)
  - [Search webhook.](https://docs.api.test.bluestonepim.com/reference/search-3.md)
  - [Delete webhook.](https://docs.api.test.bluestonepim.com/reference/delete-3.md)
  - [Get webhook.](https://docs.api.test.bluestonepim.com/reference/get-1.md)
  - [[ASYNCHRONOUS ENDPOINT] Update webhook.](https://docs.api.test.bluestonepim.com/reference/update-3.md)
- Subscriptions email
  - [Get user aggregation configuration for given entity type.](https://docs.api.test.bluestonepim.com/reference/findconfiguration.md)
  - [Modify user aggregation configuration for given entity type.](https://docs.api.test.bluestonepim.com/reference/updateemailfrequency.md)
  - [Unsubscribe for given events for email channel.](https://docs.api.test.bluestonepim.com/reference/unsubscribeemail.md)
  - [Get all events subscriptions enabled for email channel.](https://docs.api.test.bluestonepim.com/reference/findemail.md)
  - [Subscribe for given events for email channel.](https://docs.api.test.bluestonepim.com/reference/subscribeemail.md)
- Subscriptions in-app
  - [Unsubscribe for given events for in-app channel.](https://docs.api.test.bluestonepim.com/reference/unsubscribeinapp.md)
  - [Get all events subscriptions enabled for in-app channel.](https://docs.api.test.bluestonepim.com/reference/findinapp.md)
  - [Subscribe for given events for in-app channel.](https://docs.api.test.bluestonepim.com/reference/subscribeinapp.md)
- Webhook messages
  - [Ping webhook.](https://docs.api.test.bluestonepim.com/reference/pingwebhook.md)
  - [Get messages for a given webhook.](https://docs.api.test.bluestonepim.com/reference/getmessages.md)
- Messages in-app
  - [Get in-app messages.](https://docs.api.test.bluestonepim.com/reference/getinappmessage.md)
  - [Get in-app user messages.](https://docs.api.test.bluestonepim.com/reference/getinappusermessage.md)
  - [Mark all messages as read.](https://docs.api.test.bluestonepim.com/reference/markallmessagesasread.md)
  - [Mark message as read.](https://docs.api.test.bluestonepim.com/reference/markmessageasread.md)
  - [Mark message as unread.](https://docs.api.test.bluestonepim.com/reference/markmessageasunread.md)
- Email messages
  - [Get email messages.](https://docs.api.test.bluestonepim.com/reference/getemailmessages.md)
  - [Get email message.](https://docs.api.test.bluestonepim.com/reference/getemailmessage.md)
- Subscriptions apps queue webhook
  - [Get info about apps queue webhook.](https://docs.api.test.bluestonepim.com/reference/getuseappsqueue.md)
  - [Update apps queue for the given webhook.](https://docs.api.test.bluestonepim.com/reference/updateappsqueue.md)
- Subscriptions watch
  - [Unsubscribe watch for given entities.](https://docs.api.test.bluestonepim.com/reference/unsubscribefromentity.md)
  - [Get all entities watched for given eventType.](https://docs.api.test.bluestonepim.com/reference/findwatchedentities.md)
  - [Subscribe watch for given entities.](https://docs.api.test.bluestonepim.com/reference/subscribetoentity.md)
- User configuration
  - [Get general user configuration.](https://docs.api.test.bluestonepim.com/reference/finduserconfig.md)
  - [Modify general user configuration.](https://docs.api.test.bluestonepim.com/reference/upsert.md)

## API Reference: Completeness score
- Requirements
  - [Update requirement.](https://docs.api.test.bluestonepim.com/reference/update-4.md)
  - [Delete requirement.](https://docs.api.test.bluestonepim.com/reference/delete-4.md)
  - [Add included category to requirement.](https://docs.api.test.bluestonepim.com/reference/addincludedcategory.md)
  - [Remove included category to requirement.](https://docs.api.test.bluestonepim.com/reference/removeincludedcategory.md)
  - [Add excluded category to requirement.](https://docs.api.test.bluestonepim.com/reference/addexcludedcategory.md)
  - [Remove excluded category to requirement.](https://docs.api.test.bluestonepim.com/reference/removeexcludedcategory.md)
  - [Create requirement.](https://docs.api.test.bluestonepim.com/reference/create-4.md)
  - [List requirements.](https://docs.api.test.bluestonepim.com/reference/list-4.md): Returns a paged list of requirement definitions configured for the organization, optionally filtered by id and/or requirement type. Each result includes the requirement's weight, its type-specific…
  - [Count requirements.](https://docs.api.test.bluestonepim.com/reference/count.md)
  - [Get requirements for single entity.](https://docs.api.test.bluestonepim.com/reference/getrequirementsforsingleentity.md): Returns the computed completeness score for one entity in one context, plus the pass/fail/invalid result for every requirement evaluated — the same payload as GET /scores/{entityId}/{context}, not…
  - [Add included product type to requirement.](https://docs.api.test.bluestonepim.com/reference/addincludedproducttype.md)
  - [Remove included product type to requirement.](https://docs.api.test.bluestonepim.com/reference/removeincludedproducttype.md)
- Scores
  - [Get scores.](https://docs.api.test.bluestonepim.com/reference/getscores.md): Returns a paged list of computed completeness scores (score value, validation status, last update dates), optionally filtered by context and/or entity id. Use for bulk retrieval across entities; for…
  - [Get category scores.](https://docs.api.test.bluestonepim.com/reference/getcategoryscores.md)
  - [Stop ongoing calculation.](https://docs.api.test.bluestonepim.com/reference/stopcalculation.md)
  - [Start new calculation.](https://docs.api.test.bluestonepim.com/reference/startcalculation.md)
  - [Recalculate score for entities.](https://docs.api.test.bluestonepim.com/reference/recalculateforentity.md)
  - [Invalidate scores.](https://docs.api.test.bluestonepim.com/reference/scoresinvalidation.md)
  - [Get detailed scores for single entity.](https://docs.api.test.bluestonepim.com/reference/getdetailedscoresforsingleentity.md): Returns the computed completeness score for one entity in one context, plus the pass/fail/invalid result for every requirement evaluated. Use for a single entity; for many entities at once use…
  - [Get calculation status.](https://docs.api.test.bluestonepim.com/reference/getcalculationstatus.md)
- Validation
  - [Validate product attribute.](https://docs.api.test.bluestonepim.com/reference/validateproductattribute.md)
  - [Validate definition value.](https://docs.api.test.bluestonepim.com/reference/validatedefinitionvalue.md)
  - [Get validation issues for product.](https://docs.api.test.bluestonepim.com/reference/getvalidationissues.md)
- Validation
  - [Get validation issues for products by ids.](https://docs.api.test.bluestonepim.com/reference/getbulkvalidationissues.md): Returns validation results only for entities that exist.

## API Reference: Metadata
- Metadata
  - [Get metadata for given provider using cursor with details from given views.](https://docs.api.test.bluestonepim.com/reference/findprovidermetadatawithcursorandviewsbyproviderid.md)
  - [Get metadata for entities for given provider.](https://docs.api.test.bluestonepim.com/reference/getmetadataforentities.md)
  - [Upsert metadata for given provider.](https://docs.api.test.bluestonepim.com/reference/upsertmetadata.md)
  - [Delete metadata for given provider.](https://docs.api.test.bluestonepim.com/reference/deletemetadata.md)
  - [Delete metadata for given provider by ids.](https://docs.api.test.bluestonepim.com/reference/deleteprovidermetadatabyids.md)
- Provider
  - [List providers by numbers.](https://docs.api.test.bluestonepim.com/reference/listproviders-1.md)
  - [Get providers for organization.](https://docs.api.test.bluestonepim.com/reference/getregisteredproviders.md)

## API Reference: UI settings
- Columns setups
  - [Get all setups.](https://docs.api.test.bluestonepim.com/reference/getallcolumnsetups.md)
  - [This endpoint allows you to create column setup.](https://docs.api.test.bluestonepim.com/reference/createcolumnssetupofanyuser.md)
  - [This endpoint allows you to get column setup by id.](https://docs.api.test.bluestonepim.com/reference/getcolumnsetupbyidofanyuser.md)
  - [This endpoint allows you to update column setup by id.](https://docs.api.test.bluestonepim.com/reference/updatesetupbyidofanyuser.md)
  - [This endpoint allows you to delete column setup by id.](https://docs.api.test.bluestonepim.com/reference/deletecolumnsetupbyidofanyuser.md)

## API Reference: Bulk Operations
- Products
  - [Bulk upsert product attributes by numbers](https://docs.api.test.bluestonepim.com/reference/upsertattributesbynumbers.md)
  - [Get job details by ID](https://docs.api.test.bluestonepim.com/reference/getjobstatus-1.md)