Get recognitions via the Perform & Engage 365 API

The Perform & Engage 365 API enables you to:

• Get a list of recognitions.
• Get the details of a particular recognition by its ID.

Get a list of recognitions

GET /api/v2/recognition/

This request enables you to get a list of recognitions.

Optional query parameters

• author_email (string). The recognition author’s email address.
• author_name (string). The recognition author’s full name.
• mentioned_email (string). The email address of the employee mentioned in the recognition.
• mentioned_name (string). The full name of the employee mentioned in the recognition.
• limit (integer). The maximum number of recognitions in the response.
• offset (integer). The initial index from which the results are returned in the response.

Request example

GET /api/v2/recognition/?author_name=Leslie%20Davies&
mentioned_name=Raymond%20Armstrong

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 recognitions. Each recognition has these parameters:
  • api_id (string). The recognition ID. You can use this ID to get more details about the recognition.
  • question_api_id (string). The question ID. You can use this ID to get more details about the question.
  • question_text (string). The question text.
  • response_api_id (string). The response ID. You can use this ID to get more details about the response.
  • response_text (string). The response text.
  • author_api_id (string). The recognition author’s ID.
  • author_name (string). The recognition author’s full name.
  • author_email (string). The recognition author’s email address.
  • mentioned_api_id (string). The ID of the employee mentioned in the response.
  • mentioned_name (string). Full name of the employee mentioned in the recognition.
  • mentioned_email (string). The email address of the employee mentioned in the recognition.

Response body example

The successful 200 response returns the body similar to this:

{
 "count": 1,
 "next": null,
 "previous": null,
 "results": [
   {
     "api_id": "580:792db414-5369-4364-86a2-7fd572e9ba4f",
     "question_api_id": "580:9e5a1d83-a22d-4673-91a9-6d17d723ab71",
     "question_text": "Has someone done a great job this week? ",
     "response_api_id": "580:13728691-a484-4bdb-83cf-05977af05fc2",
     "response_text": "@(Raymond Armstrong) and @(Mohammed Bennett) 
     have both been really good this week helping me with all the 
     campaign activity I have in flight.",
     "author_api_id": "580:e42eda47-8818-45b1-8d89-8b8b92bc9559",
     "author_name": "Leslie Davies",
     "author_email": "contact+LeslieDavies@weekly10.net",
     "mentioned_api_id": "580:2bad1838-8b72-4ceb-b1d5-cee795b94b7e",
     "mentioned_name": "Raymond Armstrong",
     "mentioned_email": "contact+RaymondArmstrong@weekly10.net"
   }
]
}

Get the details of a particular recognition by its ID

GET api/v2/recognition/{api_id}/

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

Required path parameter

• api_id (string). The recognition ID you can get by sending the GET /api/v2/recognition/ request.

Request example

GET /api/v2/questions/580%3A396cd5f1-d52b-4cfc-bcc6-610e17697a86

Response body parameters

The GET api/v2/recognition/{api_id}/ response includes the same parameters as the results array in the GET /api/v2/recognition/ response.

Response body example

The successful 200 response returns the body similar to this:

{
 "api_id": "580:792db414-5369-4364-86a2-7fd572e9ba4f",
 "question_api_id": "580:9e5a1d83-a22d-4673-91a9-6d17d723ab71",
 "question_text": "Has someone done a great job this week? ",
 "response_api_id": "580:13728691-a484-4bdb-83cf-05977af05fc2",
 "response_text": "@(Raymond Armstrong) and @(Mohammed Bennett) 
 have both been really good this week helping me with all the 
 campaign activity I have in flight.",
 "author_api_id": "580:e42eda47-8818-45b1-8d89-8b8b92bc9559",
 "author_name": "Leslie Davies",
 "author_email": "contact+LeslieDavies@weekly10.net",
 "mentioned_api_id": "580:2bad1838-8b72-4ceb-b1d5-cee795b94b7e",
 "mentioned_name": "Raymond Armstrong",
 "mentioned_email": "contact+RaymondArmstrong@weekly10.net"
}