Get conversation templates via the Perform & Engage 365 API

The Perform & Engage 365 API enables you to:

• Get a list of conversation templates.
• Get the details of a particular conversation template by its ID.

Get a list of conversation templates

GET /api/v2/conversation_templates/

This request enables you to get a list of conversation templates based on the search parameters.

Optional query parameters

• name (string). The conversation template name.
• name_icontains (string). The case-insensitive conversation template name or a part of its name.
• limit (integer). The maximum number of conversation templates in the response.
• offset (integer). The initial index from which the results are returned in the response.

Request example

GET /api/v2/conversation_templates/?name=360%20Feedback

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 conversation templates. Each conversation template has these parameters:
  • api_id (string). The conversation template ID. You can use this ID to get more details about the conversation template.
  • name (string). The conversation template name.
  • active (boolean). States whether the conversation template is active (true) or not (false).
  • draft (boolean). States whether the conversation template is in the draft status (true) or not (false).
  • deleted (boolean). States whether the conversation template is deleted (true) or not (false).
  • created_date (string). The conversation template creation date and time.
  • updated_date (string). The date and time of the last conversation template update.

Response body example

The successful 200 response returns the body similar to this:

{
 "count": 1,
 "next": null,
 "previous": null,
 "results": [
   {
     "api_id": "580:58fe72fa-3553-4169-8e03-602568927908",
     "name": "360 Feedback",
     "active": false,
     "draft": true,
     "deleted": false,
     "created_date": "2025-04-04T12:19:58.162985+01:00",
     "updated_date": "2025-04-09T16:28:05.104675+01:00"
   }
 ]
}

Get the details of a particular conversation template by its ID

GET api/v2/conversation_templates/{api_id}/

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

Required path parameter

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

Request example

GET /api/v2/conversation_templates/580%3A55a31458-d71a-4962-841a-048439073239/

Response body parameters

The response body includes:

• api_id (string). The conversation template ID.
• name (string). The conversation template name.
• active (boolean). States whether the conversation template is active (true) or not (false).
• draft (boolean). States whether the conversation template is in the draft status (true) or not (false).
• deleted (boolean). States whether the conversation template is deleted (true) or not (false).
• created_date (string). The conversation template creation date and time.
• updated_date (string). The date and time of the last conversation template update.
• sections (array). The list of sections of the conversation template. Each section contains its api_id, title, description, order, and the elements array.

Response body example

The successful 200 response returns the body similar to this:

{
 "api_id": "580:55a31458-d71a-4962-841a-048439073239",
 "name": "Engagement Survey",
 "active": false,
 "draft": true,
 "deleted": false,
 "created_date": "2021-05-26T12:28:59.961760+01:00",
 "updated_date": "2021-05-26T15:15:54.920102+01:00",
 "sections": [
   {
     "api_id": null,
     "title": "Engagement Feedback",
     "description": "",
     "elements": [
       {
         "api_id": null,
         "title": "Please take a couple of minutes to complete this survey. 
         Your answers to the following questions and statements are important 
         so please answer honestly.",
         "element_type": "paragraph",
         "identifier": null,
         "initial_value": null,
         "range_low": null,
         "range_high": null,
         "increments": 1,
         "required": false,
         "order": 0,
         "allow_comment": false
       }
       ],
"order": 0
   }
 ]
}