Get a notification

get/notifications/{notification}

Request

Base URL
https://sandbox.checkhq.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/checkhq/apis/check-api/docs/notifications/:notification/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

notificationstring required

ID of the notification to return

Response

200

idstring

topicstring

companystring

recipient_typestring

recipientstring

email_communicationunknown

created_atstring

Example response

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

Changes

No recorded changes to this operation across all 2 revisions of this API.