Skip to main content

List chats page

Gets the chats from a collection by its ID.

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

Path params​

  • collectionId: The ID of the collection that has the record to be found.

Query params​

  • pageNumber: The page number to retrieve. Starts at 0. Defaults to 0.
  • pageSize: The number of results per page. Defaults to 10.
  • fieldId: The ID of the chat field to filter by.
  • recordId: The ID of the record to filter by

Response body​

  • pageNumber: The number of the current page of chats. Starts at 0.
  • pageSize: The number of results per page.
  • totalSize: The total number of chats matching the filters on the collection.
  • data: An array of the chat objects.

Example JSON response​

{
  "data": [
    {
      "id": "a42666d9-98b1-43d4-a997-4e0543a3d824",
      "fieldId": "eb070e5e-8dce-42a4-89d1-200bab77a97d",
      "recordId": "1cd13c46-c053-4bc6-94ee-28327fff5886"
    },
    {
      "id": "831d276b-11fd-49b7-8eee-dafe88407697",
      "fieldId": "eb070e5e-8dce-42a4-89d1-200bab77a97d",
      "recordId": "4685da73-bd54-42d2-b587-4b3486e3e619"
    }
  ],
  "pageNumber": 0,
  "pageSize": 10,
  "totalSize": 2,
}