Alerts

List alerts for the instance or for one account, employee or labour, and retrieve one alert.

Alerts flag records that need attention. You can list every alert, list the alerts of one account, employee or labour, and retrieve a single alert. This area has 5 endpoints, and all seven SDKs call every one.

At a glance

Endpoint	Method	Path	What it does
List alerts	GET	/alerts	Lists the alerts on your instance, one page at a time.
Retrieve an alert	GET	/alerts/{alert_id}	Retrieves one alert by its id.
List an account’s alerts	GET	/alerts/account/{account_id}	Lists the alerts raised for one account.
List an employee’s alerts	GET	/alerts/employee/{employee_id}	Lists the alerts raised for one employee.
List a labour’s alerts	GET	/alerts/labour/{labour_id}	Lists the alerts raised for one labour.

Before you call

Register your API credentials once when your app starts, as shown in Authentication. Every SDK sample on these pages then gets its client in one line. With cURL, send the access token in an Authorization header: Authorization: Bearer $ACCESS_TOKEN.

Things to know

• Alerts are read only. You can list them for the instance or for one account, employee or labour, and read one by id.
• Employees and labours are identified by their code. An account is named by its id, such as ACC0001.
• Every list has the same shape. Alerts sit under data beside object, url and pagination, and an empty data means no alerts.
• Listings page by cursor. Records sit under data; pass pagination.next_cursor as cursor to read the next page, and stop when pagination.has_more is false.