curl '{backend_url}/admin/views/{entity}/configurations/{id}' \
-H 'Authorization: Bearer {jwt_token}'{
"view_configuration": {
"id": "<string>",
"entity": "<string>",
"name": "<string>",
"user_id": "<string>",
"is_system_default": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"configuration": {
"visible_columns": [
"<string>"
],
"column_order": [
"<string>"
],
"column_widths": {},
"filters": {},
"sorting": {
"id": "<string>",
"desc": true
},
"search": "<string>"
}
}
}Get View Configuration
Retrieve a view configuration for an entity. An admin user can only retrieve their own configurations.
curl '{backend_url}/admin/views/{entity}/configurations/{id}' \
-H 'Authorization: Bearer {jwt_token}'{
"view_configuration": {
"id": "<string>",
"entity": "<string>",
"name": "<string>",
"user_id": "<string>",
"is_system_default": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"configuration": {
"visible_columns": [
"<string>"
],
"column_order": [
"<string>"
],
"column_widths": {},
"filters": {},
"sorting": {
"id": "<string>",
"desc": true
},
"search": "<string>"
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The entity to retrieve its view configurations (for example, orders)
The ID of the view configuration to retrieve.
Query Parameters
Comma-separated fields that should be included in the returned data. If a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. Without prefix it will replace the entire default fields.
Response
OK
The details of a view configuration.
The details of a view configuration.
Show child attributes
Show child attributes
The view configuration's ID.
The entity the view configuration belongs to.
The view configuration's name.
The ID of the user the view configuration belongs to. If null, the view configuration is a system default.
Whether the view configuration is the system default.
The date the view configuration was created.
The date the view configuration was updated.
The view's configuration.
Show child attributes
Show child attributes
The configuration's visible columns.
The visible column's name.
The columns in the order they should be displayed.
The column's name.
The column widths in the view.
The filters applied to the view.
The configuration's search.