curl '{backend_url}/admin/views/{entity}/configurations' \
-H 'Authorization: Bearer {jwt_token}'{
"limit": 123,
"offset": 123,
"count": 123,
"view_configurations": [
{
"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>"
}
}
],
"estimate_count": 123
}List View Configurations
Retrieve a list of view configurations of an entity. The configurations can be filtered by fields like id. The configurations can also be paginated. An admin user can only retrieve their own configurations.
curl '{backend_url}/admin/views/{entity}/configurations' \
-H 'Authorization: Bearer {jwt_token}'{
"limit": 123,
"offset": 123,
"count": 123,
"view_configurations": [
{
"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>"
}
}
],
"estimate_count": 123
}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)
Query Parameters
The number of items to skip when retrieving a list.
Limit the number of items returned in the list.
The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.
Whether to include deleted records in the result.
Filter by a view configuration ID.
Filter by an entity.
Filter by a view's name.
Filter by the ID of the user who owns the view.
Filter by whether the view is a system default. Whether the view is a system default.
Filter by a view configuration's creation date.
Show child attributes
Show child attributes
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
Filter by an exact match.
Filter by values not equal to this parameter.
Filter by values in this array.
Filter by values in this array.
Filter by values not in this array.
Filter by values not in this array.
Filter by values not matching the conditions in this parameter.
Filter by values greater than this parameter. Useful for numbers and dates only.
Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
Filter by values less than this parameter. Useful for numbers and dates only.
Filter by values less than or equal to this parameter. Useful for numbers and dates only.
Apply a like filter. Useful for strings only.
Apply a regex filter. Useful for strings only.
Apply a case-insensitive like filter. Useful for strings only.
Filter to apply on full-text properties.
Filter arrays that have overlapping values with this parameter.
Filter arrays that have overlapping values with this parameter.
Filter arrays that contain some of the values of this parameter.
Filter arrays that contain some of the values of this parameter.
Filter arrays that contain all values of this parameter.
Filter arrays that contain all values of this parameter.
Filter by whether a value for this parameter exists (not null).
Filter by a view configuration's update date.
Show child attributes
Show child attributes
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
Filter by an exact match.
Filter by values not equal to this parameter.
Filter by values in this array.
Filter by values in this array.
Filter by values not in this array.
Filter by values not in this array.
Filter by values not matching the conditions in this parameter.
Filter by values greater than this parameter. Useful for numbers and dates only.
Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
Filter by values less than this parameter. Useful for numbers and dates only.
Filter by values less than or equal to this parameter. Useful for numbers and dates only.
Apply a like filter. Useful for strings only.
Apply a regex filter. Useful for strings only.
Apply a case-insensitive like filter. Useful for strings only.
Filter to apply on full-text properties.
Filter arrays that have overlapping values with this parameter.
Filter arrays that have overlapping values with this parameter.
Filter arrays that contain some of the values of this parameter.
Filter arrays that contain some of the values of this parameter.
Filter arrays that contain all values of this parameter.
Filter arrays that contain all values of this parameter.
Filter by whether a value for this parameter exists (not null).
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.
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
Response
OK
The list of view configurations. The list of view configurations.
The maximum number of returned items.
The number of items skipped before retrieving the returned items.
The total number of items.
The list of view configurations.
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.
The estimated count retrieved from the PostgreSQL query planner, which may be inaccurate.