Jump to Content

Environment: Test Environment: Production Environment: Production US

Home Guides API Reference

Environment: Test Environment: Production Environment: Production US

API Reference

Home Guides API Reference

Get bearer token

Generate tokenpost

PIM

Catalog nodes
Product policy
Maintenance
- [DEPRECATED; EOL 23/4/2025] undefinedpost
Catalog node attributes
Bulk
Attribute groups
Attribute definition policies
Products categories
Validation
Catalogs
Products bundles
Products
Products templates
Products assets
Products attributes
Products connections
Category policy
Compound attribute definitions
Products labels
Attribute definitions
Relation policy
Relations
Product variants
Catalog node assets
Technical
- Show service version.get

Media bank

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

Search

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

Labels

Labels

Global settings

Filters
Contexts

History

History

Sync

Technical
- Show service version.get
Diff
- Get difference for product from requested sync.get
Metadata
Report
State
- Get service state.get
Sync
Asset states
- Search asset state.post
- Synchronise asset state during next sync.post
Product states

Tasks

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

Query builder

Products
savedView
- Validate passed viewpost

Public API sync

Products
- List product states.post
- Change product states.post
Session sync
Categories
- Resync category states.post
- 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
- /attributesget

IDP

Additional user properties
- Returns list of additional user properties.get
Consents
API Clients
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
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
UserGroups
Users

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

Powered by

Get bearer token

Generate tokenpost

PIM

Catalog nodes
Product policy
Maintenance
- [DEPRECATED; EOL 23/4/2025] undefinedpost
Catalog node attributes
Bulk
Attribute groups
Attribute definition policies
Products categories
Validation
Catalogs
Products bundles
Products
Products templates
Products assets
Products attributes
Products connections
Category policy
Compound attribute definitions
Products labels
Attribute definitions
Relation policy
Relations
Product variants
Catalog node assets
Technical
- Show service version.get

Media bank

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

Search

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

Labels

Labels

Global settings

Filters
Contexts

History

History

Sync

Technical
- Show service version.get
Diff
- Get difference for product from requested sync.get
Metadata
Report
State
- Get service state.get
Sync
Asset states
- Search asset state.post
- Synchronise asset state during next sync.post
Product states

Tasks

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

Query builder

Products
savedView
- Validate passed viewpost

Public API sync

Products
- List product states.post
- Change product states.post
Session sync
Categories
- Resync category states.post
- 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
- /attributesget

IDP

Additional user properties
- Returns list of additional user properties.get
Consents
API Clients
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
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
UserGroups
Users

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

Powered by

Returns list of policies.

get https://api-us.bluestonepim.com/idp/policies

Language

Authorization

OAuth2

Bearer

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