Skip to main content
GET
/
admin
/
views
/
{entity}
/
configurations
cURL
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

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
entity
string
required

The entity to retrieve its view configurations (for example, orders)

Query Parameters

​
offset
number

The number of items to skip when retrieving a list.

​
limit
number

Limit the number of items returned in the list.

​
order
string

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 -.

​
with_deleted
boolean

Whether to include deleted records in the result.

​
id

Filter by a view configuration ID.

​
entity

Filter by an entity.

​
name

Filter by a view's name.

​
user_id

Filter by the ID of the user who owns the view.

​
is_system_default
boolean

Filter by whether the view is a system default. Whether the view is a system default.

​
created_at
created_at · object

Filter by a view configuration's creation date.

​
updated_at
updated_at · object

Filter by a view configuration's update date.

​
fields
string

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.

​
$and
$and · object[]

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

​
$or
$or · object[]

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.

​
limit
number
required

The maximum number of returned items.

​
offset
number
required

The number of items skipped before retrieving the returned items.

​
count
number
required

The total number of items.

​
view_configurations
object[]
required

The list of view configurations.

​
estimate_count
number

The estimated count retrieved from the PostgreSQL query planner, which may be inaccurate.