Skip to main content

List records

Gets a list of records in a collection.

GET https://api.cogfy.com/collections/:collectionId/records

Path params​

  • collectionId: The ID of the collection to retrieve records from.

Query params​

  • pageNumber: The page number to retrieve. Starts at 0. Defaults to 0.
  • pageSize: The number of results per page. Defaults to 10.

Response​

Example JSON response:

{
  "data": [
    {
      "id": "25d9e43c-a72a-48ca-98fe-971f8a6b68f5",
      "properties": {
        "249f76ee-08fd-4b2d-b089-166048deefce": {
          "type": "text",
          "text": {
            "value": "Foo"
          }
        },
        "03b132be-6d07-41ef-b466-a7584ec44cd6": {
          "type": "text",
          "text": {
            "value": "Bar"
          }
        }
      }
    },
    {
      "id": "363d27b7-7f21-4027-9fb5-6beec576c792",
      "properties": {}
    }
  ],
  "pageNumber": 0,
  "pageSize": 50,
  "totalSize": 2
}