BizKitHub
DocsAPI ReferenceData Grid/bff/grid-view/list
getData GridAdmin BFF

/bff/grid-view/list

Views shared with the organisation followed by the caller's private views, for one grid.

DataGridgetBffGrid-viewList

Parameters

1 query

Query parameters

· 1
gridstringRequired

Grid identifier chosen by the admin screen (kebab-case), e.g. order.

Length: 1–64
Exampleorder

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
idnumberRequired

core__grid_view.id.

namestringRequired
isSharedbooleanRequired

Visible to every member of the organisation.

isOwnbooleanRequired

The viewer created the view.

canEditbooleanRequired

The viewer may rename, overwrite or delete the view (owner or org root).

ownerNamestringRequired

Display name of the owner.

filtersobjectRequired

Flat filter state replayed when the view tab is clicked. Same keys as the grid's list endpoint.

sortOrdernumberRequired
itemCountnumberRequired

Response example

application/json
{
  "items": [
    {
      "id": 0,
      "name": "example_name",
      "isShared": false,
      "isOwn": false,
      "canEdit": false,
      "ownerName": "example_ownerName",
      "filters": {},
      "sortOrder": 0
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/grid-view/list

get
curl -X GET "https://api.bizkithub.com/bff/grid-view/list?grid=order" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key