Links

List

allows you to list and filer all the records for a given resource
Endpoint: /api/resources/[RESOURCE-ID]/actions/list
Method: GET
Request params:
  • direction - sorting direction, possible values asc,desc
  • sortBy - name of the sorting column
  • page - requested page number
  • perPage - number of records per page (max 500)
  • filers.[field_name] - filters applied
Response:
  • meta
    • total - total number of records in the resource
    • perPage - number of records in a single page
    • page - number of requested page
    • direction- sorting direction, possible values asc,desc
    • sortBy- id of the sorting column
  • records - list of records with resource metadata
Example
{
"meta":{
"total":1,
"perPage":10,
"page":1,
"direction":"desc",
"sortBy":"_id"
},
"records":[
{
"params":{
"_id":"62d50386c2d13cd087a10e3a",
"email":"[email protected]",
"password":"$argon2id$v=19$m=4096,t=3,p=1$PFUAZpgSO1XwfnksafaV2Q$+vJ1hrmDAY70Us5iz5bNttDRCOAxLGIAOFaol0KrcjI",
"__v":0
},
"populated":{
},
"baseError":null,
"errors":{
},
"id":"62d50386c2d13cd087a10e3a",
"title":"[email protected]",
"recordActions":[
{
"name":"show",
"actionType":"record",
"icon":"Screen",
"label":"Show",
"resourceId":"Admin",
"guard":"",
"showFilter":false,
"showResourceActions":true,
"showInDrawer":false,
"hideActionHeader":false,
"containerWidth":1,
"layout":null,
"variant":"default",
"parent":null,
"hasHandler":true,
"custom":{
}
}
],
"bulkActions":[
]
}
]
}
Last modified 7mo ago