Get check-ins via the Perform & Engage 365 API

The Perform & Engage 365 API enables you to:

• Get a list of check-ins.
• Get the details of a particular check-in by its ID.

Get a list of check-ins

GET /api/v2/checkins/

This request enables you to get a list of check-ins based on the search parameters.

Optional query parameters

• date_from (string). The check-in submission date starting from which the results are returned. The format is yyyy-mm-dd.
• date_to (string). The check-in submission date by which the results are returned. The format is yyyy-mm-dd.
• department (string). The department to which the employee belongs.
• manager_email (string). The email address of the employee’s manager.
• manager_name (string). The full name of the employee’s manager.
• person_email (string). The employee’s email address.
• person_name (string). The employee’s full name.
• limit (integer). The maximum number of check-ins in one response.
• offset (integer). The initial index from which the results are returned in the response.

Request example

GET /api/v2/checkins/?date_from=2025-01-25&department=Research%20and%20Development
&manager_name=Joanne%20Stefani&person_name=Michael%20Test'

Response body parameters

The response body includes:

• count (integer). The number of results.
• next and previous (strings). URLs to the next and previous pages (if you used pagination in the original request).
• results (array). The list of check-ins. Each check-in has these parameters:
  • api_id (string). The check-in ID. You can use this ID to get more details about the check-in.
  • deadline_date (string). The check-in deadline date and time.
  • submission_date (string). The check-in submission date and time.
  • overdue (boolean). States whether the check-in is overdue (true) or not (false).
  • on_vacation (boolean). States whether the employee was on vacation (true) or not (false) during the check-in due date.
  • is_adhoc (boolean). States whether the check-in was ad hoc (true) or scheduled (false).

Response body example

The successful 200 response returns the body similar to this:

{
 "count": 2,
 "next": null,
 "previous": null,
 "results": [
   {
     "api_id": "580:ce417c60-30ca-4e39-967e-b258d496be30",
     "deadline_date": "2025-04-12T00:59:59+01:00",
     "submission_date": "2025-04-11T12:06:00.882601+01:00",
     "overdue": false,
     "on_vacation": false,
     "is_adhoc": true
   },
   {
     "api_id": "580:c9b26b5e-f9b5-4b5f-8525-5b706ce891ba",
     "deadline_date": "2025-04-11T12:00:00+01:00",
     "submission_date": "2025-04-11T12:19:00.405628+01:00",
     "overdue": false,
     "on_vacation": false,
     "is_adhoc": false
   }
 ]
}  

Get the details of a particular check-in by its ID

GET api/v2/checkins/{api_id}/

After getting the check-in api_id in the response to the previous request, you can use this ID to get more information about the check-in.

Required path parameter

• api_id (string). The check-in ID you can get by sending the GET /api/v2/checkins/ request.

Request example

GET /api/v2/checkins/580%3Ace417c60-30ca-4e39-967e-b258d496be30/

Response body parameters

The response body includes:

• api_id (string). The check-in ID.
• deadline_date (string). The check-in deadline date and time.
• submission_date (string). The check-in submission date and time.
• overdue (boolean). States whether the check-in is overdue (true) or not (false).
• on_vacation (boolean). States whether the employee was on vacation (true) or not (false) during the check-in due date.
• is_adhoc (boolean). States whether the check-in was ad hoc (true) or scheduled (false).
• responses (array). This array includes a list of responses to the check-in. Each response includes:
  • api_id (string). The response ID.
  • response_date (string). The response date and time.
  • person_name (string). The employee’s full name.  
  • person_api_id (string). The employee’s ID.
  • person_email (string). The employee’s email address.
  • person_department (string). The department to which the employee belongs.
  • person_properties (array). The array contains the employee’s properties as the name and value pair of string parameters. For example, it could be the employee’s role at the company.

Response body example

The successful 200 response returns the body similar to this:

{
 "api_id": "580:ce417c60-30ca-4e39-967e-b258d496be30",
 "deadline_date": "2025-04-12T00:59:59+01:00",
 "submission_date": "2025-04-11T12:06:00.882601+01:00",
 "overdue": false,
 "on_vacation": false,
 "is_adhoc": true,
 "responses": [
   {
     "api_id": "580:62a8f61c-88ba-40b6-816a-bf2625db106a",
     "response_date": "2025-04-11T12:06:01.046509+01:00",
     "person_name": "Michael Test",
     "person_api_id": "580:f88ab8b9-4e41-4025-ad77-519006ba855f",
     "person_email": "mtest@test.com",
     "person_department": "Research and Development",
     "person_properties": []
   }
 ]
}