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

Invitation

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

Query filters

PropertyTypeDescription
pageSizeIntSize of the pages to return.
pageIntWhich page to return.

Listing Invitations

Request

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

Response

Expand
{
  "models": [
    {
      "href": "http://caoloon.com/portal/invitation/3d44dc59-1c82-46c2-a89c-18336b79e257/",
      "guid": "3d44dc59-1c82-46c2-a89c-18336b79e257",
      "sentAt": "2025-10-02T14:32:33.541494+02:00",
      "sentToEmail": "leon+112@caoloon.com",
      "sentBy": "leon+2@caoloon.com"
    },
    {
      "href": "https://caoloon.com/portal/invitation/f4e850fe-4bf9-4c34-8e4b-2f54a9b3d2ab/",
      "guid": "f4e850fe-4bf9-4c34-8e4b-2f54a9b3d2ab",
      "sentAt": "2025-10-02T14:29:40.586247+02:00",
      "sentToEmail": "leon+92@caoloon.com",
      "sentBy": "leon+2@caoloon.com"
    }
  ],
  "nextPage": 2,
  "total": 53,
  "pageSize": 2,
  "page": 1
}

Inviting a customer to share their IPE

Request

fetch('https://caoloon.com/portal/invitation/', {
  method: 'POST',
  body: JSON.stringify([
    { "email": "testmail1@caoloon.com", "offerHelp": true, "sentBy": "leon1@caoloon.com" },
    { "email": "testmail2@caoloon.com", "offerHelp": false, "sentBy": "leon2@caoloon.com" }
  ]),
})
  .then((response) => response.json())
  .then((json) => console.log(json));

Response

Expand
{
    "sent": ["testmail1@caoloon.com", "testmail2@caoloon.com"]
}
Prev
Inquiry Pay Equity
Next
Customer