Jump to Content

Environment: Production Environment: Production US Environment: Test

Home Guides API Reference

Environment: Production Environment: Production US Environment: Test

API Reference

Home Guides API Reference

All

Pages

Start typing to search…

Get bearer token

Generate tokenpost

PIM

Catalog nodes
Product policy
Bulk
- Get async task status.get
- Delete products attributes.del
Attribute definition policies
Products categories
Validation
Category attributes
Products
Products templates
Products relations
Products attributes
Category level attributes
Compound attribute definitions
Relations
Product variants
Attribute groups
Catalogs
Products bundles
Products assets
Category policy
Products labels
Attribute definitions
Relation policy
Catalog node assets
Technical
- Show service version.get

Media bank

Technical
- Show service version.get
- Health checks.get
Labels
Upload
Asset attributes
Assets

Search

Full-text search
- Execute the search query.get
Search

Labels

Labels

Global settings

Filters
Contexts

History

History

Tasks

Technical
- Show service version.get
Task comments
Tasks reminders
Tasks
User tasks

Query builder

savedView
- Validate passed viewpost
Products
Organization
- /organizationdel

Public API sync

Products
- List product states.post
- Change product states.post
Session sync
Categories
- List category states.post
Session report

Public API

Products
Categories
Syncs
- Retrieves a collection of publish info for given tenant.get
- Retrieves the information about given PublishInfo environment.get
Differences
Contexts
- lists currently available publicationsget
Health
- /healthget
Relations
- /relationsget
Attributes

IDP

Additional user properties
- Returns list of additional user properties.get
Consents
API Clients
- Returns list of registered API Clients.get
- Returns list of registered API Clients names and ids.get
Dependent permissions
- Returns list of all dependent permissions for a permissions.get
Managed roles
- Returns list of managed roles.get
- Returns managed role.get
Me
- Returns simplified list of UI permissions in account from token.get
- Reset MFA secret for currently logged in user.put
Organizations
- Returns list of user organizations.get
- Return organization.get
Permissions
- Returns list of permissions.get
- Return permission.get
Plugins
- Returns ids of assigned plugins for organization from token.get
- Return permissions for specific plugin in organization.get
Policies
Roles
Services
- Returns list of registered API Clients names and ids.post
UserGroups
Users
SSO Providers
- Returns list of SSO provider configurations for the authenticated organization.get
- Update client secret for a specific SSO provider.post

External notifications

Subscriptions webhook
Webhooks
Subscriptions email
Subscriptions in-app
Webhook messages
- Ping webhook.post
- Get messages for a given webhook.post
Messages in-app
Email messages
- Get email messages.post
- Get email message.get
Subscriptions apps queue webhook
- Get info about apps queue webhook.get
- Update apps queue for the given webhook.put
Subscriptions watch
User configuration
- Get general user configuration.get
- Modify general user configuration.patch

Completeness score

Requirements
Scores
Validation

Metadata

Metadata
Task
- This operation allows users to retrieve the status of an asynchronous task using its unique task ID. It is useful for monitoring the progress of long-running or background tasks.get
Provider
- List providers by numbers.post
- Get providers for organization.get

UI settings

Columns setups

Powered by

Upsert metadata for given provider.

post

https://api-us.bluestonepim.com/metadata/metadata/{providerId}

Language

Credentials

OAuth2

Bearer

Log in to use your API keys

Click Try It! to start a request and see the response here!