API docs
  • Introduction
  • Authorization
  • Collective Labour Agreement
  • Inquiry Pay Equity
  • Invitation
  • Customer

Customer

  • URL: https://caoloon.com/portal/customer/
  • HTTP Methods: GET, POST

Query filters

PropertyTypeDescription
pageSizeIntSize of the pages to return.
pageIntWhich page to return.
statusString arrayAn array of statuses to filter on.
onlyHelpedBooleanReturn only those offered help.
onlyFavoritesBooleanReturn only favorited entries.
archivedBooleanReturn archived entries.
updatedFromUnix timestampReturn entries which have been updated since given timestamp.
updatedToUnix timestampReturn entries which have not been updated since given timestamp.
containsStringReturn entries with given string in one of the following attributes: contact, companyName, cocNumber, invitedBy.

Listing Customers

Request

fetch('https://caoloon.com/portal/customer/?pageSize=2', {
  method: 'GET',
})
  .then((response) => response.json())
  .then((json) => console.log(json));

Response

Expand
{
  "models": [
    {
      "companyName": "",
      "coc": null,
      "invitedBy": "testuitlener@caoloon.com",
      "contact": "testmail1@caoloon.com",
      "updatedAt": "2025-10-02T14:32:33.541494+02:00",
      "status": "Uitgenodigd",
      "guid": "75ec49ab-664a-4669-bf8d-00ed3b580271",
      "href": "https://test.caolooin.com/portal/customer/75ec49ab-664a-4669-bf8d-00ed3b580271/"
    },
    {
      "companyName": "",
      "coc": null,
      "invitedBy": "testuitlener@caoloon.com",
      "contact": "testmail2@caoloon.com",
      "updatedAt": "2025-10-02T12:06:50.130832+02:00",
      "status": "Uitgenodigd",
      "guid": "421a7581-231a-4798-9d77-306fa50dc21a",
      "href": "https://caoloon.com/portal/customer/421a7581-231a-4798-9d77-306fa50dc21a/"
    }
  ],
  "nextPage": 2,
  "total": 63,
  "pageSize": 2,
  "page": 1
}

Fetching a specific Customer

Request

fetch('http://caoloon.com/portal/customer/421a7581-231a-4798-9d77-306fa50dc21a/', {
  method: 'GET',
})
  .then((response) => response.json())
  .then((json) => console.log(json));

Response

Expand
{
  "companyName": "",
  "coc": null,
  "invitedBy": "testuitlener@caoloon.com",
  "contact": "testmail2@caoloon.com",
  "updatedAt": "2025-10-02T12:06:50.130832+02:00",
  "status": "Uitgenodigd",
  "guid": "421a7581-231a-4798-9d77-306fa50dc21a",
  "href": "http://caoloon.com/portal/customer/421a7581-231a-4798-9d77-306fa50dc21a/"
}
Prev
Invitation