JUMP TOGet bearer tokenGenerate tokenpostPIMCatalog nodesCreate new catalog or category.postList all catalog nodes that use the attribute definition.getDescribe catalog nodes.postDelete catalog node structure.deleteDescribe catalog node.getUpdate catalog node.putList catalog node child nodes.getMove catalog node to new parent.putChange category order.putList catalog node path to root.getList catalog node products.getAdd product to the catalog node.postRemove product from the catalog node.deleteProduct policyGet policy by category node id.getAdd policy to products for category node id.postDelete policy from products for category node id.deleteGet policy by category id.getAdd policy to products for category id.postDelete policy from products for category id.deleteGet catalog node by policy id.getGet categories by policy id.getMaintenance[DEPRECATED; EOL 2025-04-23] undefinedpostCatalog node attributesList all category level attributes.getList only catalog node attributes attached to given node.getDelete catalog node attribute from node.deleteUpdate category level attribute and schedule propagation task.patchCreate catalog node attribute and schedule propagation task.postCreate catalog node column attribute and schedule propagation task.postUpdate category level column attribute and schedule propagation task.putCreate catalog node compound attribute and schedule propagation task.postCreate catalog node dictionary attribute and schedule propagation task.postSet values for dictionary attribute and schedule propagation task.postCreate catalog node matrix attribute and schedule propagation task.postUpdate category level matrix attribute and schedule propagation task.putBulkGet async task status.getDelete products attributes.delete[DEPRECATED; EOL 2024-10-31] This endpoint is deprecated and will be removed soon.postAttribute groupsList all attribute groups.getCreate new attribute group.postList definitions that are not in any group.getChange order strategy for definitions without group.putChange attribute's order.putGet attribute root group.getDelete attribute group.deleteChange group's order.putList definitions in attribute group.getChange order strategy for definitions in group.putChange attribute's order in group.putRename attribute group.putChange attribute group number.putAttribute definition policiesGet policies by attribute definition id.getAdd policy to attribute definition.postDelete policy for attribute definition.deleteGet attribute definitions by policy id.getProducts categoriesAdds products as a children of category.postList of category id the product is a child of.getAdds product as a child of categories.postRemoves product as a child of category.deleteValidationValidates attribute definitions.postValidates list of products.postValidates attribute value.postCatalogsList catalogs in the system.getArchive catalog.deleteUnarchive catalog.putList all nodes from catalog.getProducts bundlesCreate product bundle.postDelete product from bundle.deleteAdd complementary product to bundle.postUpdate product bundle quantity.putChange products's order in the bundle.putProducts[DEPRECATED; EOL 2024-10-31] This endpoint is deprecated and will be removed soon.getCreate new product.postThis endpoint is available only for organizations migrated to new sync.putCreate a copy of product.post[DEPRECATED; EOL 2024-10-31] Disabled request filters: assetFilters, scoreFilter, scoreRequirementResultFilters.postDisabled request filters: assetFilters, scoreFilter, scoreRequirementResultFilters.postShow list of products filtered by asset ids with details from given views.postShow list of products filtered by ids with details from given views.postShow list of products views filtered by numbers.postThis endpoint is available only for organizations not migrated to the new sync.postThis endpoint is available only for organizations migrated to new sync.putShow product details.getUpdate product details, supports partial update.patch[DEPRECATED; EOL 2024-10-31] This endpoint is deprecated and will be removed soon.putCreate a copy of product.postShow product filtered by id with view.postThis endpoint is available only for organizations not migrated to the new sync.postProducts templatesList all product templates.getDelete product template.deleteShow details of product template.getCreate product template.postUpdate product template.putProducts assetsList assets associated with product.getAssociate assets to product.postSet assets for product.putDisassociate asset from product.deleteAssociate asset with product.postChange asset's order.putProducts attributesAdd attribute values in given set of products.postUpsert attribute values in given set of products.postUpdate attribute values in given set of products.putAppend dictionary value to products.postDeduct dictionary value from products.postAppend select/multiselect values to products.postDeduct select/multiselect values from products.postGet product attributes.getAdd product attribute.postUpdate or set many attributes on product.putAdd column attribute.postUpdate column attribute.putAdd dictionary attribute.postSet values for dictionary attribute.postAdd matrix attribute.postUpdate matrix attribute.putDelete product attribute.deleteUpdate product attribute.putGet grouped product attributes.getProducts connectionsShow all relations with directions for product.getShow all connections for categories.getCreate new connection between products and categories.postDelete connection between products and categories.deleteCreate new connection between products.postUpdate related products relation sorting order source.putDelete all connections between products based on a given relation.deleteRetrieve related products for given product and relation.getCreate new connections between products.postRemove multiple connections from the given product.deleteUpdate order product relations.putDelete connection between products.deleteUpdate order product connections.putUpdate connection quantity.putCategory policyGet policies by category node id.getAdd policy to category node.postDelete policy by category node and policy id.deleteGet policies by category id.getAdd policy to category.postDelete policy by category and policy id.deleteGet categories by policy id.getGet categories node by policy id.getCompound attribute definitionsLists details of compound attribute definition.getCreate compound attribute definition.postList all compound attributes that use the attribute definition.getDelete compound attribute definition.deleteShow details of compound attribute definition.getUpdate compound attribute definition.putProducts labelsRemove label from the set of products.deleteAdd label to the set of products.postShow list of associated product's label ids.getAssociate given labels with product.postRemove associated labels from product.deleteAttribute definitionsList all attribute definitions.getCreate attribute definition.postCreate attribute definition.postUpdate attribute definition.putShow number of elements affected by the attribute definition update operation.putCreate dictionary attribute definition.post[DEPRECATED; EOL 2024-10-31] This endpoint is deprecated and will be removed soon.deleteUpdate selected items limit for dictionary attribute definition.patchUpdate dictionary attribute definition.putDelete dictionary parent from dictionary definition.deleteSet dictionary parent for filtering dictionary values.postCreate dictionary attribute.postCount dictionary attributes for given dictionary definition.postList filtered dictionary attributes.postList filtered dictionary attributes with given definition id.postDelete dictionary attribute.deleteShow details of dictionary attribute.getUpdate dictionary attribute.patchDelete dictionary value filter.deleteCreate dictionary value filter.postList filtered attribute definitions.postCreate attribute definition.postUpdate attribute definition.putShow number of elements affected by the attribute definition update operation.putList simple attribute definitions.getDelete attribute definition.deleteShow details of attribute definition.getUpdate attribute definition.patchUpdate attribute definition.putShow number of elements affected by the attribute definition delete operation.deleteShow number of elements affected by the attribute definition update operation.putList all products that use the simple attribute definition.getRelation policyGet relation by policy id.getGet relation policies.getAdd policy to the relation.postDelete policy.deleteRelationsShow all relations.getCreate new relation.postFilter relations.postDelete relation.deleteShow relation details.getUpdate relation.putShow all categories connections using relation.getUpdate relation order.putShow all product connections using relation.getProduct variantsCreate variant group.postGet product variant attribute.getUpdate product variant attribute.putUnassign given product variant from variant group.deleteAssign product as a variant of parent product.putChange variant's order.putCatalog node assetsList categories associated with asset.getList assets associated with category.getDisassociate asset from category.deleteAssociate asset with category.postChange asset's order.putTechnicalShow service version.getMedia bankTechnicalShow service version.getHealth checks.getLabelsLists labels.getCreate a custom type of media label.postCreate a specified type of media label.postGet label with given id.getUpdate a custom type of media label.putDelete a custom type of media label.deleteUpdate a specified type of media label.putDelete a specified type of media label.deleteList specified type of media labels.postUploadComplete asset creation. The asset will be moved to \assets path.postLists assets in upload phase for current user.getCreate new empty asset. The asset will not be available for other users until done operation is completed.post[DEPRECATED; EOL 2025-02-01] Create new empty asset. The asset will not be available for other users until done operation is completed.postUpdate the asset's information to be uploaded.putCreate new version for existing asset. The new asset version will not be available for other users until done operation is completed.postCancel asset's creation. Any uploaded file and asset will be removed.deleteAsset attributesAssign attribute to asset.postUnassign attribute from asset.deleteGet list of attributes associated to asset.getSet values to dictionary asset's attributeputSet values to select asset's attributeputSet value to simple asset's attributeputAssetsSets the assets labels attribute.putAdds labels to asset's labels.postBulk add assets label.postBulk delete assets label.deleteBulk update of asset published flag.putDescribe asset.getMark current asset as deleted.deleteDescribe working asset versions.get[DEPRECATED; EOL 2025-02-01] Describe working assets. Search enabled with query parameters.get[DEPRECATED; EOL 2025-02-01] Describe working assets. Search enabled with query parameters.postDuplicate the asset.postGenerate fixed link for latest version of asset. Full url follows the scheme: [pms-host]/latest/{url}put[DEPRECATED; EOL 2025-02-01] Get list of all system media file extensions.getDescribe working assets. Search enabled by assetIds with paging.postDescribe working assets. Search enabled with query parameters.post[DEPRECATED; EOL 2025-02-01] Describe working assets total count.post[DEPRECATED; EOL 2025-02-01] Describe working assets. Search enabled with query parameters and cursor.postList working asset using cursor.post[DEPRECATED; EOL 2025-02-01] Publish asset to be available for external usage. The asset will be available in published container.postRemoves given label from the asset's labels.deleteBulk delete operation for list of assets.deleteRevert version of asset.postUpdate asset alpha channel flag.putUpdate asset description.put[DEPRECATED; EOL 2025-02-01] Updates asset attribute.patchUpdate asset clipping path.putUpdate asset internal flag.putUpdate asset name.putUpdate asset number.putUpdate asset published flag.put[DEPRECATED; EOL 2025-02-01] Updates assets list attribute.patchSearchFull-text searchExecute the search query.getSearchSearch for products using an Elasticsearch query.postSearch for products using an Elasticsearch query and scroll.postCount for products using an Elasticsearch query.postSearch for assets using an Elasticsearch query.postCount for assets using an Elasticsearch query.postLabelsLabelsGet a label.getUpdate a label.putDelete a label.deleteList labels.getCreate a new label.postList labels by ids.postGlobal settingsFiltersGrant or update filter permission to user.putRevoke filter permission from user.deleteList public and private filters using filtering criteria.postList filters using filtering criteria.postCreate new filter.postGet filter by using id.getDelete filter using id.deleteUpdate filter using id.patchDelete filter of any user.deleteUpdate public and private filterpatchLists users with filter permission.getContextsGet context definition.getUpdate context definition.putArchive context definition.deleteList all context definitions.getCreate context definition.postHistoryHistoryRetrieve history events.getRetrieve history events for given entity type.getRetrieve history events for given entity.get[DEPRECATED; EOL 2024-08-01] This endpoint is deprecated and will be removed soon.getRetrieve history events for given entity type with cursor. Recommended for retrieving large sets of results.getRetrieving the history of events for a given type of entities that have a value from the query.getRetrieve history events for given entity that have a value from the query.getSyncTechnicalShow service version.getDiffGet difference for product from requested sync.getMetadataList metadata providers.getAdd metadata provider.postGet metadata provider.getUpdate metadata provider.putRemove metadata provider.deleteReportGet reports of analysing product states in PIM and PAPI.getGet attribute groups.getGet category details.getGet categories.getExclude all products.postExclude category.postExclude product.postGet attribute group details.getInclude all products. Does not apply to invalid products.postInclude category.postInclude product.postGet product details.getGet products.getGet relation details.getGet Relations.getGet report summary.getStateGet service state.getSyncGet sync.getCancel sync process.deleteGet sync processes in chronological order.getInitiate sync process. If successful report creation is started.postGet sync affected products.getGet sync metrics.getPublish data to public API.postAsset statesSearch asset state.postSynchronise asset state during next sync.postProduct statesSearch product state.postSynchronise product state during next sync.postAllows to republish product without making in it any changes. It triesto update the product state last update date. If product is not found, it's justskipped.putTasksTechnicalShow service version.getTask commentsList all comments with replies for given task.getAdd a comment for given taskpostAdd a comment reply for given task comment.postTasks remindersGet reminders for task.getCreate reminder for task (max 5 allowed per task).postUpdate reminder config.putDelete reminder config.deleteTasksAssign products to task.postAssign task.putComplete product in scope of a task.putList all tasks for organization.getCreate new task.postDelete product from task scope.deleteList all/archived/assigned/created tasks for user.getList all/archived/assigned tasks for user group.getGet single task by id.getUpdate task data.putList archived tasks for organization.getList folders of tasks for user.getMark product as incomplete in scope of a task.putUser tasksComplete task by id of logged in user.putGet tasks of logged in user.getGet tasks assigned to logged in user.getGet task by id of logged in user.getSet task as important by id of logged in user.putSet task as unimportant by id of logged in user.putRevoke task by id of logged in user.putQuery builderProductsSearch for products for given query.postGet number of products for given query.postScroll products for given query.postCreate a new persisted product query.postUpdate persisted product query.putDelete persisted product query.deleteList persisted product queries.postSearch for persisted queries for given product.postsavedViewValidate passed viewpostPublic API syncProductsList product states.postChange product states.postSession syncClose session.putCancel session.putAdd products to session.postCreate a new sync session.postGet sync session.getCategoriesResync category states.postList category states.postSession reportCreate products report file.postGet products by issue type for the session.postGet assets by issue type for the session.postCreate entities report file.postCreate assets report file.postGet products report link.getGet products issues for the session.getGet entities issues for the session.getGet assets issues for the session.getGet entities report link.getGet assets report link.getGet a session report.getPublic APIProducts/products/listpostShow list of products filtered by ids.postShow list of products filtered by numbers.post/products/cursor/allpost/products/{id}getCategories/categoriesget/categories/{categoryId}/ancestorsget/categories/scanget/categories/{categoryId}get/categories/{categoryId}/productsgetSyncsRetrieves a collection of publish info for given tenant.getRetrieves the information about given PublishInfo environment.getDifferences/differences/productsget/differences/sync/{id}/productsget/differences/categoriesget/differences/sync/{id}/categoriesget/differences/attributesget/differences/sync/{id}/attributesget/differences/relationsget/differences/sync/{id}/relationsgetContextslists currently available publicationsgetHealth/healthgetRelations/relationsgetAttributes/attributesgetIDPAdditional user propertiesReturns list of additional user properties.getConsentsReturns the latest agreement.getCheck if user has approved latest agreement.getAccept agreement with given id.postAPI Clients[DEPRECATED; EOL 2025-03-24] Returns list of registered API Clients.get[DEPRECATED; EOL 2025-03-24] Get APIClient.getReturns list of registered API Clients.getReturns list of registered API Clients names and ids.getDependent permissionsReturns list of all dependent permissions for a permissions.getManaged rolesReturns list of managed roles.getReturns managed role.getMeReturns simplified list of UI permissions in account from token.getOrganizationsReturns list of user organizations.getReturn organization.getPermissionsReturns list of permissions.getReturn permission.getPluginsReturns ids of assigned plugins for organization from token.getReturn permissions for specific plugin in organization.getPoliciesReturns list of policies.getCreate new policy.postReturn policy.getUpdate policy.putArchive policy.deleteRolesReturns list of roles.getCreate new role.postReturns role.getArchive role.deleteEdit role.putAssign permissions by ids to role by id.postRevoke permissions by ids of role by id.postGet permissions for plugin.getUpdate permissions for plugin.putAssign plugin permissions to plugin.postRevoke plugin permissions from plugin.postGet default role.getSet default role.postClear default role.deleteUserGroupsCreate new user group.postReturns list of user groups.getReturns total number of user groups.getReturns user group.getUpdate user group.patchDelete user group.delete/userGroups/{id}/duplicatepostAdd role to user group.putRemove role from user group.putAssign policy to user groupputUnassign policy from user groupputAdd managed role to user group.putRemove managed role from user group.putUsersReturns list of users.getCreate new user.postReturns user.getUpdate user.putUpload user picture.putChange user password.putResend join email.putSet user status.putUpdate user type.putGrant role.putRevoke role.putGrant policy.putRevoke policy.deleteGrant managed role.putRevoke managed role.deleteGrant additional properties.putRevoke additional properties.putAssign user group to user.putUnassign user group from user.deleteExternal notificationsSubscriptions webhookUnsubscribe for given events for given webhook.deleteGet all events subscriptions enabled for given webhook.getSubscribe for given events for given webhook.putWebhooksCreate webhook.postSearch webhook.postDelete webhook.deleteGet webhook.get[ASYNCHRONOUS ENDPOINT] Update webhook.putSubscriptions emailGet user aggregation configuration for given entity type.getModify user aggregation configuration for given entity type.putUnsubscribe for given events for email channel.deleteGet all events subscriptions enabled for email channel.getSubscribe for given events for email channel.putSubscriptions in-appUnsubscribe for given events for in-app channel.deleteGet all events subscriptions enabled for in-app channel.getSubscribe for given events for in-app channel.putWebhook messagesPing webhook.postGet messages for a given webhook.postMessages in-appGet in-app messages.postGet in-app user messages.postMark all messages as read.putMark message as read.putMark message as unread.putEmail messagesGet email messages.postGet email message.getSubscriptions apps queue webhookGet info about apps queue webhook.getUpdate apps queue for the given webhook.putSubscriptions watchUnsubscribe watch for given entities.deleteGet all entities watched for given eventType.getSubscribe watch for given entities.putUser configurationGet general user configuration.getModify general user configuration.patchCompleteness scoreRequirementsUpdate requirement.putDelete requirement.deleteAdd included category to requirement.putRemove included category to requirement.deleteAdd excluded category to requirement.putRemove excluded category to requirement.deleteCreate requirement.postList requirements.postCount requirements.postGet requirements for single entity.getScoresGet scores.postGet category scores.postStop ongoing calculation.postStart new calculation.postRecalculate score for entities.postInvalidate scores.postGet detailed scores for single entity.getGet calculation status.getValidationValidate product attribute.postValidate definition value.postGet validation issues for product.getPowered by Get single task by id.get https://api-us.bluestonepim.com/tasks/tasks/{taskId}
