This API allows clients to export data from Conversations in Perform & Engage 365 (such as Performance Reviews or 1:1s).
Throughout the API an 'api_id' for employees is used. This can be specified by the client when creating a new employee/user via the API, if one is not specified during creation or a user is created via a different method (i.e. the user interface) then the API ID can be obtained by querying the API.
Users can be created and managed using the Directory API: User endpoints.
GET /conversation/plan/
List all available conversation plans for this organisation
Response
Returns an object including a list of available plans.
[
{
plan_id: string,
plan_name: integer,
plan_trigger: adhoc|scheduled|recurring|employee_start_date,
is_active: boolean,
created_date: datetime
}.....
]
GET /conversation/plan/{ api_id }
List specific plan.
Response
Returns an object including the requested plan.
{
plan_id: string,
plan_name: integer,
plan_trigger: adhoc|scheduled|recurring|employee_start_date,
is_active: boolean,
created_date: datetime
}
GET /conversation/review/
List all reviews.
Response
Returns an object including a list of instances of this conversation plan.
[
{
api_id: string,
plan: string, // Plan API ID
start_date: datetime,
end_date: datetime,
status: draft|complete,
workflow_stage: string, // Stage name
person: string, // Employee API ID
reviewer: string, // Reviewers API ID
second_reviewer: string, // Second Reviewers API ID
}....
]
GET /conversation/review/{ api_id }/
Get specific instance of a conversation review.
Response
Returns an object including the review detail.
{
api_id: string,
plan: string, // Plan API ID
start_date: datetime,
end_date: datetime,
status: draft|complete,
workflow_stage: string, // Stage name
person: string, // Employee API ID
reviewer: string, // Reviewers API ID
second_reviewer: string, // Second Reviewers API ID
}
GET /conversation/review/{ api_id }/review_data
Get all data related to a specific instance of a conversation review.
Response
Returns an object including the review data detail.
{
api_id: string,
review: string, // Review API ID
value_type: string, // Type of data (i.e. text_box, selectbox etc)
key: string, // Label for Section Element
index: int, // Index in relation to this key (if occurs more than once)
value: string, // Value
value_2: string, // Secondary value (if applicable to value_type)
comment: string, // Comment (if configured for the value_type)
}