Jump to Content
Developers
Home
Quable Guide
Recipes
API & Cookbook
v5-EN
v5-FR
Developers
Log In
API & Cookbook
Log In
Guide en français
Home
Quable Guide
Recipes
API & Cookbook
2. Get documents and options
All
Pages
Start typing to search…
JUMP TO
Quable PIM API documentation v5
API Reference: Version v5
Data Model
Asset
This endpoint provides a paginated list of Asset
get
Create a new Asset. Warning: This is a beta endpoint, the payload/response can change
post
Provide a single resource - Asset
get
Update an Asset. Warning: This is a beta endpoint, the payload/response can change
put
Remove an Asset
del
This endpoint provides a list of thumbnail profiles, it can be paginated with the pagination=true parameter
get
This creates a new thumbnail profile
post
Provide a single resource - thumbnail profile
get
Remove the thumbnail profile from the database
del
Classification & Catalog
This endpoint provides a paginated list of Catalogs, it can be paginated with the pagination=true parameter
get
Create a new Catalog in the datamodel
post
Provide a single resource - Catalog
get
Update a single resource - Catalog
put
Remove the Catalog from the PIM
del
Provide a list of Classifications in a tree-like representation of a Catalog resource
get
Provide a paginated list of Classifications
get
Create a new Classification. Warning : This is a beta endpoint, the payload / response can change
post
Provide a single resource - Classification
get
Update a Classification. Warning : This is a beta endpoint, the payload / response can change
put
Remove a Classification
del
Data Enhancement
This endpoint provides a list of completeness settings, it can be paginated with the pagination=true parameter
get
This creates a new completeness setting
post
Provide a single resource - completeness
get
Do update the setting
put
Remove the setting from the database
del
This endpoint provides a list of Tags
get
Provide a single resource - Tag
get
This endpoint provides a list of Workflow Steps, it can be paginated with the pagination=true parameter
get
Provide a single resource - Workflow Step
get
This endpoint provides a list of Workflow Transitions, it can be paginated with the pagination=true parameter
get
This endpoint provides a list of Workflows, it can be paginated with the pagination=true parameter
get
This creates a new Workflow
post
Provide a single resource - Workflow
get
Update a single resource - Workflow
put
Remove a single resource - Workflow
del
Data Flow
This endpoint provides a list of ExportProfiles, it can be paginated with the pagination=true parameter
get
Create a new ExportProfile in the datamodel
post
Provide a single resource - ExportProfile
get
Update a single resource - ExportProfile
put
Remove the ExportProfile from the PIM
del
This endpoint provides a list of ImportProfiles, it can be paginated with the pagination=true parameter
get
Create a new ImportProfile in the datamodel
post
Provide a single resource - ImportProfile
get
Update a single resource - ImportProfile
put
Remove the ImportProfile from the PIM
del
This endpoint provides a paginated list of ExportSchedules
get
This endpoint creates a new ExportSchedule
post
Provide a single resource - ExportSchedule
get
Update a single resource - ExportSchedule
put
Remove a single resource - ExportSchedule
del
This endpoint provides a paginated list of ImportSchedules
get
This endpoint creates a new ImportSchedule
post
Provide a single resource - ImportSchedule
get
Update a single resource - ImportSchedule
put
Remove a single resource - ImportSchedule
del
Document
Provide a paginated list of Documents
get
Create a new Document. Warning: This is a beta endpoint, the payload / response can change
post
Provide a single resource - Document
get
Update a Document. Warning: This is a beta endpoint, the payload / response can change
put
Remove a Document
del
Provide a paginated list of Links
get
Create a new Link. Warning : This is a beta endpoint, the payload / response can change
post
Provide a single resource - Link
get
Update a Link. Warning : This is a beta endpoint, the payload / response can change
put
Remove a Link
del
Provide a paginated list of Variants
get
Create a new Variant. Warning: This is a beta endpoint, the payload / response can change
post
Duplicate a Variant
post
Provide a single resource - Variant
get
Update a Variant. Warning: This is a beta endpoint, the payload / response can change
put
Remove a Variant
del
Utility
Create a File
post
Provide a paginated list of Files
get
Provide a single resource - File
get
This endpoint provides a paginated list of key/values
get
Create a key/value
post
Get a key/value
get
Edit a key/value
put
Delete a key/value
del
This endpoint provides a list of the customer subscription values
get
Provide a single resource - Subscription
get
Update a single resource - Subscription
put
This endpoint provides a paginated list of TaskCategories
get
This creates a new TaskCategory
post
Provide a single resource - TaskCategory
get
Update the TaskCategory
put
Remove the TaskCategory from the database
del
Integration
This endpoint provides a paginated list of tokens
get
Retrieves a AccessControlToken resource.
get
Provide a paginated list of event
get
Provide a single resource - Event
get
This endpoint provides a list of Quable Apps
get
Create a new Quable App
post
Provide a single resource - Quable App
get
Update a Quable App
put
Remove a Quable App
del
This endpoint provides a list of Webhooks
get
Create a new Webhook
post
Provide a single resource - Webhook
get
Update a Webhook
put
Remove a Webhook
del
User & Permission
This endpoint provides a list of Catalog Permissions, it can be paginated with the pagination=true parameter
get
Create new Catalog Permission
post
Provide a single resource - Catalog Permission
get
Update a single resource - Catalog Permission
put
Remove the Catalog Permission
del
This endpoint provides a list of Feature Permissions, it can be paginated with the pagination=true parameter
get
This creates a new Feature Permission
post
Provide a single resource - Feature Permission
get
Update a single resource - Feature Permission
put
Remove the Feature Permission
del
This endpoint provides a list of Field Permissions, it can be paginated with the pagination=true parameter
get
Create new Field Permission
post
Provide a single resource - Field Permission
get
Update the Field Permission
put
Remove the Field Permission
del
This endpoint provides a paginated list of Users
get
Create a new User
post
Provide a single resource - User
get
Update a single resource - User
put
Activity
This endpoint provides a paginated list of Processes
get
Provide a single resource - Process
get
Data Model
This endpoint provides a paginated list of AITemplates
get
Create a new AITemplate in the datamodel
post
Provide a single resource - AITemplate
get
Update a single resource - AITemplate
put
This endpoint provides a list of AttributeGroups
get
Create a new AttributeGroup
post
Provide a single resource - AttributeGroup
get
Update an AttributeGroup
put
Provide a paginated list of AttributeSets
get
Create a new AttributeSet in the datamodel
post
Provide a single resource - AttributeSet
get
Update a single resource - AttributeSet
put
Remove the AttributeSet configuration from the PIM
del
This endpoint provides a paginated list of Attributes
get
Create a new Attribute in the datamodel
post
Provide a single resource - Attribute
get
Update a single resource - Attribute
put
Remove a single resource - Attribute
del
This endpoint provides a paginated list of DocumentTypes
get
Provide a single resource - DocumentTypes
get
Provide a list of Attributes in a tree-like representation of a DocumentType resource
get
This endpoint provides a list of LinkTypes, it can be paginated with the pagination=true parameter
get
Create a new LinkType in the datamodel
post
Provide a single resource - LinkType
get
Update a single resource - LinkType
put
Remove the LinkType configuration from the PIM
del
Provide a paginated list of Locale
get
Provide a single resource - Locale
get
Update a single resource - Locale
put
This endpoint provides a paginated list of PredefinedValues
get
Create a new PredefinedValue in the datamodel
post
Provide a single resource - PredefinedValue
get
Update a single resource - PredefinedValue
put
Remove the PredefinedValue from the PIM
del
WorkflowTransition
Provide a single resource - Workflow Transition
get
Quable PIM:DAM API v4
API Reference: Version v4 (old)
Token & Auth
/sessions
get
/sessions
post
/sessions
del
Settings
/settings
get
/settings/{id}
get
/settings/{id}
put
/settings/{id}
post
/settings/{id}
del
Data Model
/attribute_sets/code/{code}
put
/eav-values
post
/eav-values/{id}
put
/eav-attributes
get
/eav-attributes
post
/eav-attributes/{id}
put
/eav_attributes/{entity}/fields
get
/eav-attribute-groups/tree/{entity}
get
Documents
/documents
get
/documents
post
/documents/{code}
get
/documents/{code}
put
/documents/{code}
del
/documents/{code}/tags/{workflow_step_code}
post
/documents/{code}/tags/{workflow_step_code}
del
/articles/orphelins
get
/documents/{code}/links/{link_type_code}
post
Variants
/variants
get
/variants
post
/variants/{code}
get
/variants/{code}
put
/variants/{code}
del
/variants/{code}/links/{link_type_code}
post
Workflows
Classifications
/classifications
post
/classifications/{code}
put
/classifications/{code}
get
/classifications/{code}
del
/classifications/{code}/classifications
get
/classifications/{code}/links/{link_type_code}
post
Channels
/catalog-views/{code}/classifications
get
Assets
/assets
post
/assets
get
/assets/{code}
put
/assets/{code}
get
/assets/{code}
del
Downloads
/downloads
get
/downloads/{download_item_id}
get
Tickets
/tickets
get
/tickets
post
Notifications
/notifications
post
Links
Powered by
2. Get documents and options
Ask AI
