Skip to main content
GET
/
api
/
v1
/
records
/
{collection}
List Records
curl --request GET \
  --url https://api.example.com/api/v1/records/{collection}
{
  "items": [
    {
      "id": "<string>",
      "account_id": "<string>",
      "created_at": "<string>",
      "created_by": "<string>",
      "updated_at": "<string>",
      "updated_by": "<string>",
      "account_name": "<string>"
    }
  ],
  "total": 123,
  "skip": 123,
  "limit": 123
}

Headers

authorization
string | null

Path Parameters

collection
string
required

Query Parameters

skip
integer
default:0
Required range: x >= 0
limit
integer
default:30
Required range: 1 <= x <= 100
sort
string
default:-created_at
fields
string | null

Response

Successful Response

Response for listing records.

items
RecordResponse · object[]
required

List of records

total
integer
required

Total number of records matching filter

skip
integer
required

Number of records skipped

limit
integer
required

Number of records returned