/
PI
pimcore
/
Studio Backend API
Search skmtc…
⌘K
Changes
Docs
Sign in
Docs
History
Schema
Filter operations
Asset Grid
9
Asset Thumbnails
12
Assets
41
Authorization
3
Bundle Application Logger
4
Bundle Asset Metadata Class Definitions
9
Bundle Backend Power Tools
60
Bundle CMF
53
Bundle Copilot
37
Bundle Custom Reports
11
Bundle Data Hub
12
Bundle Data Hub File Export
10
Bundle Data Hub Simple Rest
6
Bundle Data Hub Webhooks
3
Bundle Data Importer
20
Bundle Data Quality Management
4
Bundle Direct Edit
5
Bundle Ecommerce
26
Bundle Enterprise Subscription Tools
1
Bundle Headless Documents
17
Bundle OpenID Connect
6
Bundle Personalization
11
Bundle Portal Engine
25
Bundle Seo
12
Bundle Statistics Explorer
3
Bundle Studio Dashboards
18
Bundle Translations Provider Interfaces
19
Bundle Web To Print
10
Bundle Workflow Automation Integration
5
Bundle Workflow Designer
10
Cache
3
Class Definition
68
get
/pimcore-studio/api/class/definition/available-visible-fields
Get available visible fields for classes
get
/pimcore-studio/api/class/bulk-export/available
Get available items for bulk export
post
/pimcore-studio/api/class/bulk-export
Bulk export class definitions
post
/pimcore-studio/api/class/bulk-import/{fileId}
Bulk import class definitions asynchronously
delete
/pimcore-studio/api/class/bulk-import/{fileId}
Delete a prepared bulk import file
post
/pimcore-studio/api/class/bulk-import/prepare
Prepare a bulk import from an uploaded file
get
/pimcore-studio/api/class/collection
Get class definitions collection
get
/pimcore-studio/api/class/collection/creatable
Get collection of all class definitions that can be created.
get
/pimcore-studio/api/class/custom-layout/collection
Get custom layout collection for data object class
get
/pimcore-studio/api/class/all-layouts
Get all available class layouts
get
/pimcore-studio/api/class/custom-layout/{customLayoutId}
Get custom layout by given id
put
/pimcore-studio/api/class/custom-layout/{customLayoutId}
Update custom layout by given ID
post
/pimcore-studio/api/class/custom-layout/{customLayoutId}
Create custom layout
delete
/pimcore-studio/api/class/custom-layout/{customLayoutId}
Delete custom layout by given id
get
/pimcore-studio/api/class/custom-layout/editor/collection/{objectId}
Get custom layout collection for the data object
get
/pimcore-studio/api/class/custom-layout/export/{customLayoutId}
Export custom layout by given id as JSON
get
/pimcore-studio/api/class/custom-layout/identifier-data/{classDefinitionId}
Get identifier data for new custom layout
post
/pimcore-studio/api/class/custom-layout/import/{customLayoutId}
Import custom layout
get
/pimcore-studio/api/class/definition/configuration-view/detail/{id}/brick-fields
Get object brick fields for the class definition
get
/pimcore-studio/api/class/definition/configuration-view/detail/{id}/bricks
Get object bricks usage data for the class definition
post
/pimcore-studio/api/class/definition/configuration-view/detail/create
Create a new class definition configuration
get
/pimcore-studio/api/class/definition/configuration-view/detail/{id}
Get class definition data by ID
put
/pimcore-studio/api/class/definition/configuration-view/detail/{id}
Update class definition configuration by given ID
delete
/pimcore-studio/api/class/definition/configuration-view/detail/{id}
Delete a class definition configuration
get
/pimcore-studio/api/class/definition/configuration-view/detail/{id}/export
Export a class definition configuration as JSON
get
/pimcore-studio/api/class/definition/configuration-view/identifier-data
Get identifier data for new class
post
/pimcore-studio/api/class/definition/configuration-view/detail/{id}/import
Import a class definition configuration from JSON file
get
/pimcore-studio/api/class/definition/configuration-view/detail/{id}/layout
Get layout definitions for the class definition
get
/pimcore-studio/api/class/definition/configuration-view/detail/{id}/selected-visible-fields
Get selected visible fields for a class relation field
get
/pimcore-studio/api/class/definition/configuration-view/text-layout/preview
Get text layout preview for the class definition
get
/pimcore-studio/api/class/definition/configuration-view/tree
Get class definition tree data
get
/pimcore-studio/api/class/field-collection/collection
Get all field collection configurations
post
/pimcore-studio/api/class/field-collection
Create a new field collection definition
get
/pimcore-studio/api/class/field-collection/{key}
Get field collection by key
put
/pimcore-studio/api/class/field-collection/{key}
Update field collection definition by given key
delete
/pimcore-studio/api/class/field-collection/{key}
Delete a field collection definition
get
/pimcore-studio/api/class/field-collection/{key}/export
Export a field collection definition as JSON
post
/pimcore-studio/api/class/field-collection/{key}/import
Import a field collection definition from JSON file
get
/pimcore-studio/api/class/field-collection/{objectId}/object/layout
Get all layouts from the field collection for an given object
get
/pimcore-studio/api/class/field-collection/{key}/layout
Get field collection layout definition by key
get
/pimcore-studio/api/class/field-collection/tree
Get field collection tree
get
/pimcore-studio/api/class/field-collection/{key}/usages
Get field collection usage data
get
/pimcore-studio/api/class/definition/fields-by-type
Get class definition fields by type
get
/pimcore-studio/api/class/folder/{folderId}
Get list of all data object classes in a folder
get
/pimcore-studio/api/class/definition/{dataObjectClass}
Get class definition for data object class
get
/pimcore-studio/api/class/object-brick/classes
Get class definitions with ObjectBricks fields
get
/pimcore-studio/api/class/object-brick/collection
Get all object brick definitions
post
/pimcore-studio/api/class/object-brick
Create a new object brick definition
get
/pimcore-studio/api/class/object-brick/{key}/custom-layout/{customLayoutId}
Get object brick custom layout
put
/pimcore-studio/api/class/object-brick/{key}/custom-layout/{customLayoutId}
Update object brick custom layout
delete
/pimcore-studio/api/class/object-brick/{key}/custom-layout/{customLayoutId}
Delete object brick custom layout
get
/pimcore-studio/api/class/object-brick/{key}/custom-layout/{customLayoutId}/export
Export object brick custom layout as JSON
post
/pimcore-studio/api/class/object-brick/{key}/custom-layout/{customLayoutId}/import
Import object brick custom layout from JSON
get
/pimcore-studio/api/class/object-brick/{key}
Get object brick definition by key
put
/pimcore-studio/api/class/object-brick/{key}
Update an object brick definition by key
delete
/pimcore-studio/api/class/object-brick/{key}
Delete an object brick definition by key
get
/pimcore-studio/api/class/object-brick/{key}/export
Export an object brick definition as JSON
post
/pimcore-studio/api/class/object-brick/{key}/import
Import an object brick definition from JSON
get
/pimcore-studio/api/class/object-brick/{objectId}/object/layout
Get all layouts from the object bricks for an given object
get
/pimcore-studio/api/class/object-brick/{key}/layout
Get object brick layout definition by key
get
/pimcore-studio/api/class/object-brick/tree
Get object brick tree
get
/pimcore-studio/api/class/object-brick/{key}/usages
Get usages of an object brick definition
post
/pimcore-studio/api/class/select-option
Create a new select option configuration
get
/pimcore-studio/api/class/select-option/{id}
Get select option configuration by ID
put
/pimcore-studio/api/class/select-option/{id}
Update a select option configuration
delete
/pimcore-studio/api/class/select-option/{id}
Delete a select option configuration
get
/pimcore-studio/api/class/select-option/tree
Get select options tree data
get
/pimcore-studio/api/class/select-option/{id}/usages
Get usages of a select option configuration
Classification Store
29
Data Object Grid
13
Data Objects
13
Dependencies
1
Documents
28
E-Mails
12
Elements
14
Execution Engine
3
Export
10
GDPR Data Extractor
3
Mercure
1
Metadata
6
Notes
5
Notifications
10
Ownership Management
4
Perspectives
11
Properties
5
Recycle Bin
4
Role Management
12
Schedule
5
Search
14
Settings
7
Settings Admin
3
Tags
5
Tags for Element
4
Telemetry
2
Translation
11
Units
9
User Management
24
Versions
9
Website Settings
5
Workflows
5
Class Definition
Copy Markdown
Copied
Copy failed
Changes to Get field collection by key
get
/pimcore-studio/api/class/field-collection/{key}
Sep 2, 2026
81b097a1505f
Revision changes
info
endpoint added