Get conversation plans via the Perform & Engage 365 API

The Perform & Engage 365 API enables you to:

• Get a list of conversation plans.
• Get the details of a particular conversation plan by its ID.

Get a list of conversation plans

GET /api/v2/conversation_plans/

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

Optional query parameters

• name (string). The conversation plan name.
• template_name (string). The conversation template name.
• limit (integer). The maximum number of conversation plans in the response.
• offset (integer). The initial index from which the results are returned in the response.

Request example

GET /api/v2/conversation_plans/?name=Engagement%20survey&
template_name=Engagement%20Survey

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 plans. Each conversation plan has these parameters:
  • name (string). The conversation plan name.
  • api_id (string). The conversation plan ID. You can use this ID to get more details about the conversation plan.
  • template_name (string). The conversation template name.
  • template_api_id (string). The conversation template ID. You can use this ID to get more details about the conversation template.
  • status (string). The conversation plan status. The possible statuses are draft and active.
  • frequency (string). If the conversation plan is recurring, the frequency shows how often the conversation plan takes place.

Response body example

The successful 200 response returns the body similar to this:

{
 "count": 1,
 "next": null,
 "previous": null,
 "results": [
   {
     "name": "Engagement survey",
     "api_id": "580:58f96337-f9c3-4ea0-88ed-7ad612670078",
     "template_name": "Engagement Survey",
     "template_api_id": "580:55a31458-d71a-4962-841a-048439073239",
     "status": "draft",
     "frequency": "Every 4 weeks"
   }
 ]
}

Get the details of a particular conversation plan by its ID

GET api/v2/conversation_plans/{api_id}/

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

Required path parameter

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

Request example

GET /api/v2/conversation_plans/580%3A58f96337-f9c3-4ea0-88ed-7ad612670078/

Response body parameters

The response body includes:

• name (string). The conversation plan name.
• api_id (string). The conversation plan ID.
• template_name (string). The conversation template name.
• template_api_id (string). The conversation template ID. You can use this ID to get more details about the conversation template.
• status (string). The conversation plan status. The possible statuses are draft and active.
• frequency (string). If the conversation plan is recurring, the frequency shows how often the conversation plan takes place.
• assigned_users (array). The list of users assigned to the conversation plan. Each user has these parameters:
  • api_id (string). The user’s ID.
  • name (string). The user’s full name.
  • email (string). The user’s email address.
• assigned_departments (string). The list of departments assigned to the conversation plan. Each department has these parameters:
  • api_id (string). The department ID.
  • name (string). The department name.

Response body example

The successful 200 response returns the body similar to this:

{
 "name": "Engagement survey",
 "api_id": "580:58f96337-f9c3-4ea0-88ed-7ad612670078",
 "template_name": "Engagement Survey",
 "template_api_id": "580:55a31458-d71a-4962-841a-048439073239",
 "status": "draft",
 "frequency": null,
 "assigned_users": [
   {
     "api_id": "582:8a1fc17e-d1f5-4d6b-924e-dea3912814e3",
     "name": "Joanne Stefani",
     "email": "jstefani@test.com"
   }
],
 "assigned_departments": [ 
  { 
     "api_id": "442:8a1fc17e-d1f5-4d6b-924e-dea3912814e3",
     "name": "Senior Developers" 
  } 
]
}