v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

List notifications

get/notifications

Query parameters

companystring

Return notifications for this company.

topicstring

Return notifications of the given notification topic.

start_datestring date

Return notifications created on or after the provided date (format: YYYY-MM-DD)

end datestring date

Return notifications created on or before the provided date (format: YYYY-MM-DD)

recipient_typestring

Return notifications created for this recipient type (company, employee, contractor).

recipientstring

Return notifications created for this recipient.

Response

200

{"stackTrail":"paths:/notifications:get:responses:200:content:application/json:schema:properties:next","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/notifications:get:responses:200:content:application/json:schema:properties:previous","oasType":"schema","type":"unknown"}

Example response

{
  "results": [
    {
      "id": "ntf_MrFrw0F82NSJjyw10Erk",
      "topic": "ready_for_payroll",
      "company": "com_zH8Gq33iBkFj5o0GKjTw",
      "recipient_type": "company",
      "recipient": "com_zH8Gq33iBkFj5o0GKjTw",
      "email_communication": "cmn_MrFrw0F82NSJjyw10Erk",
      "created_at": "2024-01-19 17:04:15+00"
    }
  ]
}