Skip to main content

help center

Pay Suite

Submit a request
Submit a request
  1. beqom PaySuite HelpCenter
  2. APIs
  3. Integration hub

Outbound API

Nolwenn Marjou
  • Last updated:

Outbound API

The Comp Complete application processes large quantity of data, be it related to performance management or to compensation management. To keep track of the history of the data on a specific application tenant, Comp Complete creates, every 24 hours, a record of the data in the tenant database and stores it in a separate database, thus guaranteeing the traceability and recoverability of the data.

This is an note/information message.

The data storage mechanism records only the data that has been changed since the last snapshot. This helps maintain the database at a manageable size, while allowing the system to piece together a full picture of the data a defined date.

It is possible, for each individual customer, to define the exact time at which the Comp Complete application is saving the data record. This information is set in the application back-office. For more information, contact beqom.

To enable you to extract data from the separate database in which this data is stored, a dedicated RESTful API can be called. The data extracted using the API, specifically performance management data, can then be imported into third-party HR tools.

This API, called the Outbound API has a number of endpoints and parameters that will enable you to perform various actions.

This article describes how to retrieve data from the Comp Complete data foundation using the Outbound API and its endpoints.

Authenticating to use the API

The outbound API endpoints are secured using OAuth 2.0, and are protected by an access token. To obtain an access token, you need to call the /connect/token endpoint with your unique client credentials, as illustrated in the following figure:

API authentication call

Where:

  • grant_type: constant value client_credentials.

  • client_secret: client secret; for more information, contact beqom.

  • client_id: id of the client for which the token is requested; corresponds to the ClientName or CompanyName.

  • scope: constant value outboundapi.

The JWT token may contain claims (i.e. access rights/restrictions) regarding countries, legal entities and org items depending on the access rights of the user on the these items. These claims will apply a first layer of filtration on the data retrieved by the outbound API by limiting the retrieved data to only the countries, legal entities and org items that you are authorized to view.

This is a tip message.

To obtain your API connection information and obtain your token, get in touch with our Support team.

API Endpoints

Once you have successfully authenticated, you are ready to use the outbound API endpoints.

This section lists the endpoints available within the Outbound API, their purpose and the data each returns.

Filtering logic

A number of endpoints allow the use of filters (countries, legal entities and org items) in the body of the request. These filters are applied on top of the initial filtering already performed by the claims contained in the authentication JWT token.

The following table details what data is returned based on the presence of claims and filters when using the Outbound API endpoints.

Scenario Returned data
Claims only All the data matching the claims is returned (within the specified date range).
Filters only (no claims) All data matching the request filters is returned (within the specified date range).
No filters, no claims All data within the specified date range is returned.
No filters, claims All data matching the claims are returned, within the specified date range.
Claims + filter (same dimension) If the user has claims on countries for instance and uses the countries filter, the returned data is an intersection of the claims and the filter. This is the most restrictive filtering.
Claims + filter (different dimension) If the user has claims on countries for instance and users the legal entity filter, then each dimension is filtered independently in the returned data.

Retrieving goal data - /integrationapi/v2/data/goals

Method: GET

Endpoint: /integrationapi/v2/data/goals

Parameters:

  • lastModifiedDate>dateFrom: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshot from the specified date.

  • lastModifiedDate>dateTo: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshots until the specified date, including datetime.

  • page: optional, by default 1, integer. Page number to return starting from 1.

  • count: optional, by default 10, integer. Number of records to return per page.

  • countries: optional, string (array). Countries for which the goals for which the goals should be returned. The format to use for this filter is country enum code available in the Country ISO enum of the platform data foundation. For more information, refer to Data foundation enums.

  • legalEntities: optional, string (array). External ID(s) of the legal entities for which the goals should be exported.

  • orgItems: optional, string (array). External ID(s) of the organization items for which the goals should be exported.

Output sample:

Copy
 Value
Schema
[
  {
    "goalId": 0,
    "goalPlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "goalTypeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "goalTypeVId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "goalWorkflowType": "Individual",
    "progressType": "Manual",
    "maxDueDate": "2025-07-04T13:56:53.845Z",
    "minDueDate": "2025-07-04T13:56:53.845Z",
    "population": {
      "isAllCompany": true,
      "includes": [
        {
          "isAllRoles": true,
          "role": "All",
          "isAllCountries": true,
          "countryIds": [
            0
          ],
          "isAllOrgItems": true,
          "orgItemIds": [
            "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          ]
        }
      ],
      "includedUsersIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ],
      "excludes": [
        {
          "isAllRoles": true,
          "role": "All",
          "isAllCountries": true,
          "countryIds": [
            0
          ],
          "isAllOrgItems": true,
          "orgItemIds": [
            "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          ]
        }
      ],
      "excludedUsersIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ]
    },
    "periodsStartDate": "2025-07-04T13:56:53.845Z",
    "periodsEndDate": "2025-07-04T13:56:53.845Z",
    "goalCreatorId": "string",
    "goalOwnerId": "string",
    "publicVisibility": true,
    "status": "New",
    "title": "string",
    "description": "string",
    "dateCreated": "2025-07-04T13:56:53.845Z",
    "dueDate": "2025-07-04T13:56:53.845Z",
    "progress": 0,
    "weight": 0,
    "archived": true,
    "priority": "NotSelected",
    "trackingStatus": "NotSelected",
    "modifiedBy": "string",
    "deliverables": [
      {
        "description": "string",
        "dueDate": "2025-07-04T13:56:53.845Z",
        "isCompleted": true,
        "order": 0
      }
    ],
    "measurementCriterias": [
      {
        "type": "Numeric",
        "description": "string",
        "dueDate": "2025-07-04T13:56:53.845Z",
        "startValue": 0,
        "targetValue": 0,
        "maxValue": 0,
        "minValue": 0,
        "currency": "string",
        "achievedResult": 0,
        "order": 0
      }
    ],
    "attachedTags": [
      "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    ],
    "attachedFeedbackRequests": [
      0
    ],
    "attachedFeedbacks": [
      0
    ],
    "alignedTo": [
      0
    ],
    "alignedGoals": [
      0
    ],
    "sharedWithUsers": [
      "string"
    ],
    "attachments": [
      {
        "id": 0,
        "fileId": "string",
        "fileName": "string",
        "fileSize": 0,
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userExternalId": "string",
        "userName": "string"
      }
    ],
    "lastModifiedDate": "2025-07-04T13:56:53.845Z"
  }
]

Output description

This endpoint returns the data related to goals in the Comp Complete application. The API endpoint will return an array of goals updated within the period defined in the parameters with, for each goal, the following information:

  • Goal ID: unique ID of the goal in the system

  • Goal plan ID: unique ID of the parent goal plan in the system

  • Goal type ID: specific version of Goal type V, unique ID of the parent goal type in the system

  • Goal type V ID: A version identifier for the parent goal type, indicating a specific revision or iteration of the goal type definition.

  • Goal workflow type: type of workflow used for the goal; Individual or Organisational. Defined in the Goal workflow field of the goal type.

  • Progress type: type of progress tracking used for the goal. Possible values are Manual, MeasurementCriteria or Deliverables. Defined in the Progress tracking section of the goal.

  • Population: indicates a population of Organisational goal (it will always be a null for an individual). Defined in the Population step of the goal type configuration wizard when editing an organization goal.

  • Period start date: start date of the goal plan, if it is a fixed period goal plan or start date of the first period, if this is a recurring plan. Defined in the Goal plan details step of the goal plan configuration wizard.

  • Period end date: end date of the goal plan, if it is a fixed-period goal plan or last date of the last period, if this is a recurring plan. Defined in the Goal plan details step of the goal plan configuration wizard.

  • Goal creator ID: ID of the system user who created the goal or owner of a draft goal.

  • Goal owner ID: ID of the system user(s) who own(s) the goal.

  • Progress status: indicates the current state of the goal. Visible in the Details section of the goal configuration wizard.

  • Title: the name of the goal given by the goal's creator. Defined in the Name step of the goal plan configuration wizard.

  • Description: short explanation of the goal purpose provided by the goal's creator. Defined in the Description step of the goal plan configuration wizard.

  • Creation date: the date when the goal was first created.

  • Due date: specific date by which a goal must be completed. Defined in the Due date step of the goal configuration wizard.

  • Progress: The real-time metric indicating how much of a defined goal has been completed in relation to its total target. Defined in the Overall progress step of the goal overview page.

  • Weight:

  • Archived: Indicates whether a goal has been moved to an archive, meaning it is no longer actively used but is retained for historical purposes or future reference.

  • Goal priority: A designation indicating the relative importance or urgency of goal, typically used to determine the order in which goals should be addressed. Defined in the Priority step of the goal overview page.

  • Tracking status: The current state of a goal, showing its progress from initiation to completion and indicating the progress of aligned goals that contribute to the status of the main goal. Defined in the Status step of the goal overview page.

  • Modified by: The user or individual who last made changes or updates to a particular goal.

  • Measurement criteria: The specific standards, metrics, or conditions used to evaluate the success, quality, or completion of goal. Defined in the Measurement criteria section of the goal plan configuration wizard.

  • Attached tags: Keywords or labels associated with a goal to categorize, organize, or provide quick filtering capabilities.

  • Attached feedback requests: Specific inquiries or solicitations for input or evaluation that have been linked to this particular goal.

  • Aligned to: A reference indicating the higher-level entity that a particular goal contributes to or supports.

  • Aligned goals: Specific goals that a current goal directly contributes to achieving, indicating a hierarchical relationship within a goal-setting framework. Defined in the Goal alignment section of the goal plan configuration wizard.

  • Shared with users: s: Specifies the individuals who have been granted access or visibility to a particular goal.

  • Attachments: Files, documents, or other media that are digitally linked or appended to a goal for additional context or reference. Defined in the Attachments section of the goal plan configuration wizard.

  • Last modification date: The most recent calendar date and time when a goal was changed or updated.

Retrieving check-in data - /integrationapi/v2/data/checkins

Method: GET

Endpoint: /integrationapi/v2/data/checkins

Parameters:

  • lastModifiedDate>dateFrom: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshot from the specified date.

  • lastModifiedDate>dateTo: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshots until the specified date, including datetime.

  • page: optional, by default 1, integer. Page number to return starting from 1.

  • count: optional, by default 10, integer. Number of records to return per page.

  • countries: optional, string (array). Countries for which the goals for which the goals should be returned. The format to use for this filter is country enum code available in the Country ISO enum of the platform data foundation. For more information, refer to Data foundation enums.

  • legalEntities: optional, string (array). External ID(s) of the legal entities for which the goals should be exported.

  • orgItems: optional, string (array). External ID(s) of the organization items for which the goals should be exported.

Output sample:

Copy
[
  {
    "checkinId": 0,
    "template": {
      "id": 0,
      "title": "string"
    },
    "type": "ContinuousCheckin",
    "title": "string",
    "agenda": "string",
    "status": "New",
    "createdBy": "string",
    "fromUserId": "string",
    "toUserId": "string",
    "dateCreated": "2025-07-04T14:28:55.779Z",
    "checkInDate": "string",
    "conversationPoints": [
      {
        "fromUserId": "string",
        "title": "string"
      }
    ],
    "comments": [
      {
        "fromUserId": "string",
        "text": "string",
        "dateCreated": "2025-07-04T14:28:55.779Z",
        "isDeleted": true
      }
    ],
    "managerSummaryGoals": {
      "scale": 0,
      "title": "string",
      "comment": "string"
    },
    "managerSummaryBehaviours": {
      "scale": 0,
      "title": "string",
      "comment": "string"
    },
    "managerSummaryOverall": {
      "scale": 0,
      "title": "string",
      "comment": "string"
    },
    "lastModifiedDate": "2025-07-04T14:28:55.779Z"
  }
]

Output description

This endpoint returns the data related to check-ins in the Comp Complete application. The API endpoint will return an array of all check-ins updated within the period defined in the parameters with, the following information:

  • Check-in ID: A unique identifier assigned to a specific check-in.

  • Template: A pre-defined structure used to standardize check-in creation.

    • ID: A generic unique identifier for a mass check-in assignment within the system.

    • Title: The designated name of a check-in. Defined in the Title section of the mass check-in assignment configuration wizard.

  • Check-in type: A classification or category that defines the nature or kind of an item (e.g., a "Check-in" type, "Goal" type, "Feedback" type).

  • Title:

  • Agenda: A list of topics or items to be discussed or addressed during a check-in.

  • Check-in status: The current state or condition of a check-in, indicating its progress or completion phase. Visible in the Status column of the check-in table.

  • Created by: The user who initiated or originally created a particular check-in. Visible in the Details section of the check-in page.

  • From user ID: The unique identifier of the user who created a particular check-in.

  • To user ID: The unique identifier of the user who is the recipient of a check-in.

  • Date created: The specific calendar date and time when a check-in was first generated.

  • Check-in date: The specific calendar date on which a check-in took place or is scheduled to take place. Visible in the Details section of the check-in page.

  • Conversation Points :Key topics, questions, or discussion items covered during a check-in. Defined in the Discussion points section of the check-in configuration wizard.

    • From User ID: The unique identifier of the user who added the conversation points to a particular check-in.

    • Title: The title of conversation points added to a check-in.

  • Comments: Additional notes, remarks, or supplementary information added by participants during or after a check-in. Defined in the Comments section of the check-in page.

    • From User ID: The unique identifier of the user who added a comment to a particular check-in.

    • Text: The input or content provided by participant in a comment.

    • Date Created: The specific calendar date and time when a comment was added to a check-in.

    • Deleted:

  • Manager summary goals: A section where the manager provides a concise overview or assessment of the employee's performance related to their defined goals during the check-in period. Defined in the Goals section of the check-in page.

    • Scale: The range or type of measurement used for rating goals in this section. Defined in the Rating section of the check-in page under Goals .

    • Title: A descriptive label for the overall assessment of goals by the manager.

    • Comment: Written explanatory notes provided by the manager regarding the employee's goal performance. Defined in the Comment section of the check-in page under Goals .

  • Manager summary behaviors: A section where the manager provides a concise overview or assessment of the employee's performance related to their observed behaviors, skills, or competencies during the check-in period.Defined in the Behaviors section of the check-in page.

    • Scale: The range or type of measurement used for rating behaviors in this section. Defined in the Rating section of the check-in page under Behaviors .

    • Title: A descriptive label for the overall assessment of behaviors by the manager.

    • Comment: Written explanatory notes provided by the manager regarding the employee's behavioral performance. Defined in the Comment section of the check-in page under Behaviors .

  • Manager summary overall: A comprehensive, high-level assessment or concluding remarks from the manager regarding the employee's performance during the check-in period. Defined in the Overall performance section of the check-in page.

    • Scale: The range or type of measurement used for the overall performance rating. Defined in the Rating section of the check-in page under Overall performance .

    • Title: A descriptive label for the manager's concluding overall performance assessment.

    • Comment: Written explanatory notes provided by the manager for their overall performance summary. Defined in the Comment section of the check-in page under Overall performance .

  • Last modification date: The most recent timestamp of a specific version record.

Retrieving feedback data - /integrationapi/v2/data/feedbacks

Method: GET

Endpoint: /integrationapi/v2/data/feedbacks

Parameters:

  • lastModifiedDate>dateFrom: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshot from the specified date.

  • lastModifiedDate>dateTo: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshots until the specified date, including datetime.

  • page: optional, by default 1, integer. Page number to return starting from 1.

  • count: optional, by default 10, integer. Number of records to return per page.

  • countries: optional, string (array). Countries for which the goals for which the goals should be returned. The format to use for this filter is country enum code available in the Country ISO enum of the platform data foundation. For more information, refer to Data foundation enums.

  • legalEntities: optional, string (array). External ID(s) of the legal entities for which the goals should be exported.

  • orgItems: optional, string (array). External ID(s) of the organization items for which the goals should be exported.

Output sample:

Copy
[
  {
    "feedbackId": 0,
    "visibility": "Public",
    "fromUserId": "string",
    "toUserId": "string",
    "aboutUserId": "string",
    "dateCreated": "2025-07-04T14:36:36.962Z",
    "isFavourite": true,
    "isLetsMeet": true,
    "isThank": true,
    "comments": [
      "string"
    ],
    "endorsements": [
      "string"
    ],
    "behaviours": [
      0
    ],
    "sharedWithUsers": [
      "string"
    ],
    "lastModifiedDate": "2025-07-04T14:36:36.962Z",
    "isDeleted": true
  }
]

Output description

This endpoint returns the data related to feedback in the Comp Complete application. The API endpoint will return an array of all feedbacks within the period defined in the parameters with, for each goal, the following information:

  • Feedback ID: A unique identifier assigned to a specific feedback within the system

  • Visibility: Defines who can view a particular feedback, determining its privacy level. Defined in the Public section of the feedback configuration wizard.

  • From User ID: The unique identifier of the user who provided or initiated the feedback.

  • To User ID: The unique identifier of the user who is the primary recipient of the feedback

  • About User ID: The unique identifier of the user who is the subject or focus of the feedback (this might be different from "To User ID" if feedback is being given about someone to their manager, for instance).

  • Creation Date: The specific calendar date and time when the feedback item was originally created or submitted in the system.

  • Favorite: A designation indicating that a user has marked this particular piece of feedback as important or noteworthy for quick access or reference. Defined in the Feedback section of the feedback page.

  • Let's Meet: An action or status indicating a request or invitation to discuss the feedback further in a meeting or conversation. Defined in the Feedback section of the feedback page.

  • Thanks: An action or status indicating that the recipient has acknowledged or expressed gratitude for the feedback received. Defined in the Feedback section of the feedback page.

  • Comments: Additional written remarks, thoughts, or responses added by any user with visibility to the feedback item.

  • Endorsement: An action or status indicating formal approval, support, or a positive vote for a piece of feedback, often implying agreement with its content or impact. Defined in the Feedback section of the feedback page.

  • Behaviors: Specific actions, conduct, or demonstrated characteristics that are being observed, evaluated, or referenced within the context of the feedback. Defined in the Behaviors section of the feedback configuration wizard.

  • Shared with: Specifies the individuals, beyond the direct recipient, who have been granted access or visibility to this particular feedback item. Defined in the Share section of the feedback page.

  • Last modification date: The most recent timestamp of a specific version record.

Retrieving feedback requests data - /integrationapi/v2/data/feedback-requests

Method: GET

Endpoint: /integrationapi/v2/data/feedback-requests

Parameters:

  • lastModifiedDate>dateFrom: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshot from the specified date.

  • lastModifiedDate>dateTo: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshots until the specified date, including datetime.

  • page: optional, by default 1, integer. Page number to return starting from 1.

  • count: optional, by default 10, integer. Number of records to return per page.

  • countries: optional, string (array). Countries for which the goals for which the goals should be returned. The format to use for this filter is country enum code available in the Country ISO enum of the platform data foundation. For more information, refer to Data foundation enums.

  • legalEntities: optional, string (array). External ID(s) of the legal entities for which the goals should be exported.

  • orgItems: optional, string (array). External ID(s) of the organization items for which the goals should be exported.

Output sample:

Copy
[
  {
    "feedbackRequestId": 0,
    "replied": true,
    "fromUserId": "string",
    "toUserId": "string",
    "aboutUserId": "string",
    "behaviours": [
      0
    ],
    "repliedFeedbackId": 0,
    "dateCreated": "2025-07-04T14:45:22.338Z",
    "isLetsMeet": true,
    "lastModifiedDate": "2025-07-04T14:45:22.338Z"
  }
]

Output description

This endpoint returns the data related to feedback requests in the Comp Complete application.

  • Feedback request ID: A unique identifier assigned to a specific request for feedback within the system.

  • Replied: A status indicator denoting whether a response has been submitted for this specific feedback request.

  • From User ID: The unique identifier of the user who initiated or sent the feedback request.

  • To User ID: The unique identifier of the user who is the intended recipient of the feedback request (i.e., the person being asked to provide the feedback).

  • About user ID: The unique identifier of the user who is the subject or focus of the feedback being requested (i.e., the feedback is about this specific user).

  • Behaviors: Specific actions, conduct, or demonstrated characteristics that are being observed, evaluated, or referenced within the context of the feedback request. Defined in the Behaviors section of the feedback request page.

  • Replied Feedback ID: The unique identifier of the actual feedback item that was created in response to this particular feedback request, serving as a link between the request and the feedback provided.

  • Creation Date: The specific calendar date and time when the feedback request item was originally created or submitted in the system.

  • Let's Meet: An action or status indicating a request or invitation to discuss the feedback request further in a meeting or conversation. Defined in the My feedback section of the feedback request page.

  • Last Modified: The most recent timestamp of a specific version record.

Retrieving behavior data - /integrationapi/v2/data/behaviours

Method: GET

Endpoint: /integrationapi/v2/data/behaviours

Parameters:

  • lastModifiedDate>dateFrom: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshot from the specified date.

  • lastModifiedDate>dateTo: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshots until the specified date, including datetime.

  • page: optional, by default 1, integer. Page number to return starting from 1.

  • count: optional, by default 10, integer. Number of records to return per page.

Output sample:

Copy
[
  {
    "id": 0,
    "title": "string",
    "isDeleted": "string",
    "lastModifiedDate": "2025-07-04T14:45:58.040Z"
  }
]

Output description

This endpoint returns the data related to behaviors in the Comp Complete application.

  • ID: A unique identifier assigned to a specific behavior definition or instance within the system.

  • Title: The designated name or label given to a particular behavior in a particular language. Visible in the Behavior column in the Behaviors list.

  • Deleted: A status indicator showing whether a behavior definition has been marked as inactive or removed from active use in the system.

  • Last Modified: The most recent timestamp of a specific version record

Retrieving goal tag data - /integrationapi/v2/data/tags

Method: GET

Endpoint: /integrationapi/v2/data/tags

Parameters:

  • lastModifiedDate>dateFrom: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshot from the specified date.

  • lastModifiedDate>dateTo: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshots until the specified date, including datetime.

  • page: optional, by default 1, integer. Page number to return starting from 1.

  • count: optional, by default 10, integer. Number of records to return per page.

Output sample:

Copy
[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "title": "string",
    "isDeleted": "string",
    "lastModifiedDate": "2025-07-04T14:48:15.309Z"
  }
]

Output description

This endpoint returns the data related to goal tags in the Comp Complete application.

  • ID: A unique identifier assigned to a specific goal tag definition or instance within the system.

  • Title: The designated name or label given to a particular goal tag in a particular language.

  • Deleted: A status indicator showing whether a goal tag has been marked as inactive or removed from active use in the system.

  • Last Modified: The most recent timestamp of a specific version record.

Retrieving review template data - /integrationapi/v2/data/review-templates

Method: GET

Endpoint: /integrationapi/v2/data/review-templates

Parameters:

  • lastModifiedDate>dateFrom: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshot from the specified date.

  • lastModifiedDate>dateTo: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshots until the specified date, including datetime.

  • page: optional, by default 1, integer. Page number to return starting from 1.

  • count: optional, by default 10, integer. Number of records to return per page.

  • templateId: string, required. ID of the template(s) to be retrieved.

  • includeHistorical: boolean, required. Default value: false. Specifies whether historical (closed) templates should be included.

Output sample:

Copy
[
  {
    "templateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "Draft",
    "startReviewDateTime": "2025-07-04T14:50:00.329Z",
    "endReviewDateTime": "2025-07-04T14:50:00.329Z",
    "goalsPeriodStartDateTime": "2025-07-04T14:50:00.329Z",
    "goalsPeriodEndDateTime": "2025-07-04T14:50:00.329Z",
    "hideGoalsPeriod": true,
    "defaultLanguage": "string",
    "name": [
      {
        "language": "string",
        "value": "string"
      }
    ],
    "description": [
      {
        "language": "string",
        "value": "string"
      }
    ],
    "ownersIds": [
      "string"
    ],
    "includedUsersIds": [
      "string"
    ],
    "includedOrgItemsIds": [
      "string"
    ],
    "performanceReviewsAssigned": 0,
    "enableModerationStage": true,
    "enableHardStopOnModerationStage": true,
    "reviewIsEditableByManagerAtModerationStage": true,
    "skipConversationAndPublish": true,
    "enableChallengeProcess": true,
    "enabledEmployeeAcceptedMessage": true,
    "dateCreated": "2025-07-04T14:50:00.329Z",
    "isDeleted": true,
    "isHistorical": true,
    "lastModifiedDate": "2025-07-04T14:50:00.329Z",
    "employeesSettings": {
      "goalsSettings": {
        "enabled": true,
        "enabledTypes": [
          "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        ],
        "perItemRatingSettings": {
          "enabled": true,
          "answerType": 0,
          "ratingScaleType": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "ratingIsMandatory": true,
          "commentIsMandatory": true
        },
        "overallRatingSettings": {
          "enabled": true,
          "answerType": 0,
          "ratingScaleType": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "ratingIsMandatory": true,
          "commentIsMandatory": true
        }
      },
      "behavioursSettings": {
        "enabled": true,
        "enabledTypes": [
          0
        ],
        "perItemRatingSettings": {
          "enabled": true,
          "answerType": 0,
          "ratingScaleType": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "ratingIsMandatory": true,
          "commentIsMandatory": true
        },
        "overallRatingSettings": {
          "enabled": true,
          "answerType": 0,
          "ratingScaleType": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "ratingIsMandatory": true,
          "commentIsMandatory": true
        }
      },
      "overallPerformanceSettings": {
        "enabled": true,
        "answerType": 0,
        "ratingScaleType": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "ratingIsMandatory": true,
        "commentIsMandatory": true
      }
    },
    "managersSettings": {
      "goalsSettings": {
        "enabled": true,
        "enabledTypes": [
          "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        ],
        "perItemRatingSettings": {
          "enabled": true,
          "answerType": 0,
          "ratingScaleType": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "ratingIsMandatory": true,
          "commentIsMandatory": true
        },
        "overallRatingSettings": {
          "enabled": true,
          "answerType": 0,
          "ratingScaleType": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "ratingIsMandatory": true,
          "commentIsMandatory": true
        }
      },
      "behavioursSettings": {
        "enabled": true,
        "enabledTypes": [
          0
        ],
        "perItemRatingSettings": {
          "enabled": true,
          "answerType": 0,
          "ratingScaleType": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "ratingIsMandatory": true,
          "commentIsMandatory": true
        },
        "overallRatingSettings": {
          "enabled": true,
          "answerType": 0,
          "ratingScaleType": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "ratingIsMandatory": true,
          "commentIsMandatory": true
        }
      },
      "overallPerformanceSettings": {
        "enabled": true,
        "answerType": 0,
        "ratingScaleType": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "ratingIsMandatory": true,
        "commentIsMandatory": true
      }
    },
    "reviewersSettings": {
      "goalsSettings": {
        "enabled": true,
        "enabledTypes": [
          "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        ],
        "perItemRatingSettings": {
          "enabled": true,
          "answerType": 0,
          "ratingScaleType": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "ratingIsMandatory": true,
          "commentIsMandatory": true
        },
        "overallRatingSettings": {
          "enabled": true,
          "answerType": 0,
          "ratingScaleType": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "ratingIsMandatory": true,
          "commentIsMandatory": true
        }
      },
      "behavioursSettings": {
        "enabled": true,
        "enabledTypes": [
          0
        ],
        "perItemRatingSettings": {
          "enabled": true,
          "answerType": 0,
          "ratingScaleType": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "ratingIsMandatory": true,
          "commentIsMandatory": true
        },
        "overallRatingSettings": {
          "enabled": true,
          "answerType": 0,
          "ratingScaleType": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "ratingIsMandatory": true,
          "commentIsMandatory": true
        }
      },
      "overallPerformanceSettings": {
        "enabled": true,
        "answerType": 0,
        "ratingScaleType": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "ratingIsMandatory": true,
        "commentIsMandatory": true
      }
    },
    "globalSettings": {
      "additionalReviewersEnabled": true,
      "usefulInformationEnabled": true,
      "additionalReviewersLimit": 0,
      "employeesInputsAreEnabledForAdditionalReviewer": true
    },
    "customTypeId": 0,
    "sendDocumentsSettings": {
      "enableSendingPdf": true,
      "communicationRoundCode": "string"
    }
  }
]

Output description

This endpoint returns the data related to review templates in the Comp Complete application.

  • Template ID: A unique identifier for this specific review template.

  • Review Template Outbound Status: The current state of the review template.

  • Start Review Date Time: The exact date and time when the review period, or the period for starting reviews based on this template, begins. Defined in the Review periods section of the review template configuration wizard.

  • End Review Date Time: The exact date and time when the review period, or the period for completing reviews based on this template, ends. Defined in the Review periods section of the review template configuration wizard.

  • Goals Period Start Date Time: The start date and time of the period for which the goals being reviewed in this template are relevant. Defined in the Review periods section of the goal plan configuration wizard.

  • Goals Period End Date Time: The end date and time of the period for which the goals being reviewed in this template are relevant.

  • Hide Goals Period: A boolean indicating whether the display of the Goals Period Start Date Time and Goals Period End Date Time should be hidden from users. Defined in the Review periods section of the review template configuration wizard.

  • Default Language: The default language setting for this review template. Defined in the Performance review details section of the review template configuration wizard.

  • Name: The title of the performance review. Defined in the Performance review details section of the review template configuration wizard.

    • Language: Specifies the language code for a particular piece of text content.

    • Value: The actual text content in the specified language.

  • Description: A description stating the details of the performance review. Defined in the Performance review details section of the review template configuration wizard.

    • Language: The language of the description.

    • Value: The actual description text in that language.

  • Owners IDs: A list of unique identifiers for the users who own or are responsible for managing this review template. Defined in the Add review owners section of the review template configuration wizard.

  • Performance Reviews Assigned: Indicates the count of the end reviewers.

  • Enable Moderation Stage: A boolean indicating whether a moderation stage is enabled in the review process. Defined in the Configure review stages section of the review template configuration wizard.

  • Enable Hard Stop On Moderation Stage: A boolean indicating if the review process has a strict halt at the moderation stage, preventing further progression until moderation is complete. Defined in the Configure review stages section of the review template configuration wizard.

  • Review Is Editable By Manager At Moderation Stage: A boolean indicating whether managers can still edit a review even when it is in the moderation stage. Defined in the Configure review stages section of the review template configuration wizard.

  • Skip Conversation And Publish: A boolean indicating whether the review process can bypass the conversation stage and directly publish the review results. Defined in the Configure review stages section of the review template configuration wizard.

  • Enable Challenge Process: A boolean indicating whether employees have the option to challenge their review results. Defined in the Configure review stages section of the review template configuration wizard.

  • Enable Employee Accepted Message: A boolean indicating whether an automated message is sent to employees when their review is accepted. Defined in the Configure review stages section of the review template configuration wizard.

  • Date Created: The specific date and time when this review template was first created.

  • Is Deleted: A boolean indicating whether the review template has been marked as deleted (though it might still exist in the database for historical purposes).

  • Is Historical: A boolean indicating if this template is considered historical and is no longer for active use.

  • Last Modified Date: The most recent date and time when this review template was last updated.

  • Employees Settings: Configuration options specific to how employees interact with the review. Defined in the Define assignment permissions section of the review template configuration wizard.

    • Goals Settings: Settings for the employee's self-assessment of goals.

      • Enabled: Whether goal self-assessment is enabled for employees.

      • Per Item Rating Settings: Settings for rating individual goals.

        • Enabled: Whether rating individual goals is enabled.

        • Answer Type: The type of rating scale used (e.g., numerical, qualitative text, dropdown).

        • Rating Is Mandatory: Whether providing a rating for individual goals is required.

        • Comment Is Mandatory: Whether providing a comment for individual goals is required.

      • Overall Rating Settings

        • Enabled: Whether an overall goal rating is enabled.

        • Answer Type: The type of rating scale used for the overall goal rating.

        • Rating Is Mandatory: Whether providing an overall goal rating is required.

        • Comment Is Mandatory: Whether providing an overall goal comment is required.

    • Behaviours Settings: Settings for the employee's self-assessment of behaviors.

      • Enabled: Whether behavior self-assessment is enabled for employees.

      • Per Item Rating Settings: Settings for rating individual behaviors.

        • Enabled: Whether rating individual behaviors is enabled.

        • Rating Is Mandatory: Whether providing a rating for individual behaviors is required.

        • Comment Is Mandatory: Whether providing a comment for individual behaviors is required.

      • Overall Rating Settings: Settings for an overall behavior rating.

        • Enabled: Whether an overall behavior rating is enabled.

        • Answer Type: The type of rating scale used for the overall behavior rating.

        • Rating Is Mandatory: Whether providing an overall behavior rating is required.

        • Comment Is Mandatory: Whether providing an overall behavior comment is required.

    • OverallPerformanceSettings: Settings for the employee's self-assessment of overall performance.

      • Enabled: Whether overall performance self-assessment is enabled.

      • Answer Type: The type of rating scale used for overall performance.

      • Rating Is Mandatory: Whether providing an overall performance rating is required.

      • Comment Is Mandatory: Whether providing an overall performance comment is required.

  • Managers Settings: Configuration options specific to how managers interact with the review (similar structure to employees Settings). Defined in the Define assignment permissions section of the review template configuration wizard.

    • Goals Settings: Settings for manager's assessment of employee goals.

      • Enabled: Whether manager goal assessment is enabled.

      • Per Item Rating Settings: Settings for manager rating of individual goals.

        • Enabled: Whether manager rating of individual goals is enabled.

        • Answer Type: Type of rating.

        • Rating Is Mandatory: Mandatory rating.

        • Comment Is Mandatory: Mandatory comment.

      • Overall Rating Settings: Settings for manager's overall goal rating.

        • Enabled: Whether overall goal rating is enabled.

        • Answer Type: Type of rating.

        • Rating Is Mandatory: Mandatory rating.

        • Comment Is Mandatory: Mandatory comment.

    • Behaviours Settings: Settings for manager's assessment of employee behaviors.

      • Enabled: Whether manager behavior assessment is enabled.

      • Enabled Types: Specifies which types of behaviors managers can assess (e.g., all, specific categories).

      • Per Item Rating Settings: Settings for manager rating of individual behaviors.

        • Enabled: Whether rating individual behaviors is enabled.

        • Answer Type: Type of rating.

        • Rating Is Mandatory: Mandatory rating.

        • Comment Is Mandatory: Mandatory comment.

      • Overall Rating Settings: Settings for manager's overall behavior rating.

        • Enabled: Whether overall behavior rating is enabled.

        • Answer Type: Type of rating.

        • Rating Is Mandatory: Mandatory rating.

        • Comment Is Mandatory: Mandatory comment.

    • Overall Performance Settings: Settings for manager's overall performance assessment.

      • Enabled: Whether overall performance assessment is enabled.

      • Answer Type: Type of rating.

      • Rating Is Mandatory: Mandatory rating.

      • Comment Is Mandatory: Mandatory comment.

  • Reviewers Settings: Configuration options specific to how additional reviewers interact with the review (similar structure to employees Settings). Defined in the Define assignment permissions section of the review template configuration wizard.

    • Goals Settings: Settings for additional reviewer's assessment of employee goals.

      • Enabled: Whether reviewer goal assessment is enabled.

      • Per Item Rating Settings: Settings for reviewer rating of individual goals.

        • Enabled: Whether rating individual goals is enabled.

        • Answer Type: Type of rating.

        • Rating Is Mandatory: Mandatory rating.

        • Comment Is Mandatory: Mandatory comment.

      • Overall Rating Setting: Settings for additional reviewer's overall goal rating.

        • Enabled: Whether overall goal rating is enabled.

        • Answer Type: Type of rating.

        • Rating Is Mandatory: Mandatory rating.

        • Comment Is Mandatory: Mandatory comment.

    • Behaviours Settings: Settings for additional reviewer's assessment of employee behaviors.

      • Enabled: Whether reviewer behavior assessment is enabled.

      • Per Item Rating Settings: Settings for reviewer rating of individual behaviors

        • Enabled: Whether rating individual behaviors is enabled.

        • Answer Type: Type of rating.

        • Rating Is Mandatory: Mandatory rating.

        • Comment Is Mandatory: Mandatory comment.

    • Overall Rating Settings: Settings for additional reviewer's overall behavior rating.

      • Enabled: Whether overall behavior rating is enabled.

      • Answer Type: Type of rating.

      • Rating Is Mandatory: Mandatory rating.

      • Comment Is Mandatory: Mandatory comment.

    • Overall Performance Settings: Settings for additional reviewer's overall performance assessment.

      • Enabled: Whether overall performance assessment is enabled.

      • Answer Type: Type of rating.

      • Rating Is Mandatory: Mandatory rating.

      • Comment Is Mandatory: Mandatory comment.

  • Global Settings: General settings that apply across the entire review process.

    • Additional Reviewers Enabled: A boolean indicating whether the option to include additional reviewers is available.

    • Useful Information Enabled: A boolean indicating whether a "useful information" section (e.g., help text, instructions) is enabled within the review.

    • Additional Reviewers Limit: The maximum number of additional reviewers that can be invited for a review.

    • Employees Inputs Are Enabled For Additional Reviewer: A boolean indicating whether the employee's self-assessment inputs are visible to additional reviewers.

  • Custom Type ID: An identifier of a custom type associated with the review template, likely for internal categorization.

  • Send Documents Settings: Configuration options for sending review-related documents.

    • Enable Sending Pdf: A boolean indicating whether reviews can be sent as PDF documents.

  • Communication Round Code: A code or identifier associated with a specific communication round or cycle within the review process where the final PDF file will be sent.

Retrieving review template scale data - /integrationapi/v2/data/review-template-scales

Method: GET

Endpoint: /integrationapi/v2/data/review-template-scales

Parameters:

  • lastModifiedDate>dateFrom: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshot from the specified date.

  • lastModifiedDate>dateTo: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshots until the specified date, including datetime.

  • page: optional, by default 1, integer. Page number to return starting from 1.

  • count: optional, by default 10, integer. Number of records to return per page.

Output sample:

Copy
[
  {
    "scaleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "scales": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "icon": "string",
        "order": 0,
        "scale": 0,
        "labels": [
          {
            "language": "string",
            "value": "string"
          }
        ],
        "descriptions": [
          {
            "language": "string",
            "value": "string"
          }
        ]
      }
    ],
    "name": [
      {
        "language": "string",
        "value": "string"
      }
    ],
    "lastModifiedDate": "2025-07-04T14:53:07.997Z"
  }
]

Outbound description

This endpoint returns the data related to the performance scales used in review templates in the Comp Complete application.

Scale ID: A unique identifier assigned to this specific performance scale. This distinguishes it from other scales in the system.

  • Scales: Represents the collection or array of individual rating levels within this scale.

  • ID: A unique identifier for a specific rating level within this scale.

    • Order: The numerical position or sequence of this rating level within the scale.

    • Scale Labels: A collection of localized labels or names for this specific rating level.

      • Language: The language code for the label.

      • Value: The actual text label for the rating level in that specific language.

    • Descriptions: A collection of localized descriptions providing more detail about what this rating level signifies.

      • Language: The language code for the description.

      • Value: The actual text description for the rating level in that specific language.

  • Name: The overall name of the performance scale itself. Defined in the Name section of the competency scale configuration wizard.

    • Language: The language code for the scale's name.

    • Value: The actual name of the performance scale in that specific language.

  • Last Modified Date: The most recent timestamp of a specific version record.

Retrieving review template widget data - /integrationapi/v2/data/review-template-widgets

Method: GET

Endpoint: /integrationapi/v2/data/review-template-widgets

Parameters:

  • lastModifiedDate>dateFrom: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshot from the specified date.

  • lastModifiedDate>dateTo: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshots until the specified date, including datetime.

  • page: optional, by default 1, integer. Page number to return starting from 1.

  • count: optional, by default 10, integer. Number of records to return per page.

  • templateId: string, required. ID of the template(s) to be retrieved.

Output sample:

Copy
[
  {
    "widgetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "templateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "isDisabled": true,
    "isEditable": true,
    "whoCanComplete": "None",
    "whoCanSeeAnswers": "None",
    "title": [
      {
        "language": "string",
        "value": "string"
      }
    ],
    "description": [
      {
        "language": "string",
        "value": "string"
      }
    ],
    "questions": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "isRequired": true,
        "answerType": "NotSelected",
        "ratingScaleType": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "order": 0,
        "localizations": [
          {
            "language": "string",
            "value": "string"
          }
        ]
      }
    ],
    "dateCreated": "2025-07-04T14:55:44.607Z",
    "lastModifiedDate": "2025-07-04T14:55:44.607Z"
  }
]

Output description

This endpoint returns the data related to the widgets used in review templates in the Comp Complete application.

  • Widget ID: A unique identifier assigned to this specific widget. This ID distinguishes it from other widgets in the system.

  • Template ID: The unique identifier of the review template to which this widget belongs or is associated. This links the widget to a specific review structure.

  • Is Disabled: A boolean indicating whether this widget is currently disabled or inactive within the template, meaning it won't appear or be usable in reviews.

  • Is Editable: A boolean indicating whether the content or settings of this widget can be modified or edited by users in the review process.

  • Who Can Complete: Specifies the roles or groups of users who are allowed to fill out or provide input for this particular widget within a review.

  • Who Can See Answers: Specifies the roles or groups of users who have permission to view the responses or data entered into this widget.

  • Title: The main heading or name of the widget itself, displayed to users.

    • Language: The language code for the widget's title.

    • Value: The actual text of the widget's title in that specific language.

  • Description: An optional explanatory text providing more details or instructions about the widget's purpose.

    • Language: The language code for the description.

    • Value: The actual text of the description in that specific language.

  • Questions: A collection or array of individual questions or input fields contained within this widget.

    • ID: A unique identifier for this specific question within the widget.

    • Is Required: A boolean indicating whether providing an answer to this question is mandatory.

    • Answer Type: The format or type of expected response for the question (e.g., "not selected", "only comment", "comment and rating", "only rating").

    • Rating Scale Type: 

    • Order: The numerical position or sequence of this question within the widget, determining its display order.

    • Localizations: A collection of localized versions of the question text.

      • Language: The language code for the question text.

      • Value: The actual text of the question in that specific language.

  • Date Created: The specific calendar date and time when this widget definition was originally created in the system.

  • Last Modified Date: The most recent timestamp of a specific version record

Retrieving performance review data - /integrationapi/v2/data/performance-reviews

Method: GET

Endpoint: /integrationapi/v2/data/performance-reviews

Parameters:

  • lastModifiedDate>dateFrom: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshot from the specified date.

  • lastModifiedDate>dateTo: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshots until the specified date, including datetime.

  • page: optional, by default 1, integer. Page number to return starting from 1.

  • count: optional, by default 10, integer. Number of records to return per page.

  • templateId: string, optional. ID of the review(s) to be retrieved.

  • includeHistorical: boolean, optional. Default value: false. Specifies whether historical (Historical Performance Rating Upload) reviews can be added if true returns both historical and not historical.

  • countries: optional, string (array). Countries for which the goals for which the goals should be returned. The format to use for this filter is country enum code available in the Country ISO enum of the platform data foundation. For more information, refer to Data foundation enums.

  • legalEntities: optional, string (array). External ID(s) of the legal entities for which the goals should be exported.

  • orgItems: optional, string (array). External ID(s) of the organization items for which the goals should be exported.

Output sample:

Copy
[
  {
    "performanceReviewId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "templateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "employeeId": "string",
    "managerId": "string",
    "originalManagerId": "string",
    "lineManagerPlus1Id": "string",
    "status": "Default",
    "challengeStartDate": "2025-07-04T14:58:44.920Z",
    "additionalReviewers": [
      {
        "participantId": "string",
        "dateModified": "2025-07-04T14:58:44.920Z",
        "modifiedBy": "string",
        "addedBy": "string",
        "status": "EmployeeAdded",
        "commentManager": "string"
      }
    ],
    "dateCreated": "2025-07-04T14:58:44.920Z",
    "lastModifiedDate": "2025-07-04T14:58:44.920Z",
    "isDeleted": true
  }
]

Output description

This endpoint returns the data related to performance reviews in the Comp Complete application.

  • Performance Review ID: A unique identifier assigned to this specific performance review instance. This distinguishes it from all other reviews in the system.

  • Template ID: The unique identifier of the review template on which this performance review instance is based. This links the specific review to its defining structure and settings.

  • Employee ID: The unique identifier of the employee who is being reviewed in this performance review.

  • Manager ID: The unique identifier of the manager currently responsible for conducting or overseeing this performance review for the employee.

  • Original Manager ID: The unique identifier of the manager who was originally assigned to conduct this performance review, in case the manager changed during the review cycle.

  • Line Manager Plus 1 ID: The unique identifier of the manager's manager (the employee's second-level manager), often involved in a review process for oversight or moderation.

  • Status: The current state or phase of the performance review. This indicates where the review stands in its workflow.

  • Challenge Start Date: The date and time when the employee initiated or could initiate a challenge process regarding their review results, if such a process is enabled.

  • Additional Reviewers: A collection or array of participants who are involved in the review beyond the employee and their direct manager.

    • Participant ID: The unique identifier of the specific additional reviewer.

    • Date Modified: The date and time when this contribution or status was last updated within the review.

    • Modified By: The unique identifier of the user who last modified the additional reviewer's entry.

    • Added By: The unique identifier of the user who originally added this additional reviewer to the review.

    • Status: The current status of this specific additional reviewer's participation.

    • Comment Manager: A specific comment or note related to this additional reviewer's participation, often added by the manager.

  • Date Created: The specific calendar date and time when this performance review instance was originally created in the system.

  • Last Modified Date: The most recent timestamp of a specific version record

  • Is Deleted: An indicator showing whether this performance review instance has been marked as deleted (though it might still exist in the database for historical or auditing purposes).

Retrieving individual review data - /integrationapi/v2/data/individual-reviews

Method: GET

Endpoint: /integrationapi/v2/data/individual-reviews

Parameters:

  • lastModifiedDate>dateFrom: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshot from the specified date.

  • lastModifiedDate>dateTo: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshots until the specified date, including datetime.

  • page: optional, by default 1, integer. Page number to return starting from 1.

  • count: optional, by default 10, integer. Number of records to return per page.

  • templateId: string, optional. ID of the review template(s) to be retrieved.

  • includeHistorical: boolean, optional. Default value: false. Specifies whether historical (Historical Performance Rating Upload) reviews can be added if true returns both historical and not historical.

  • countries: optional, string (array). Countries for which the goals for which the goals should be returned. The format to use for this filter is country enum code available in the Country ISO enum of the platform data foundation. For more information, refer to Data foundation enums.

  • legalEntities: optional, string (array). External ID(s) of the legal entities for which the goals should be exported.

  • orgItems: optional, string (array). External ID(s) of the organization items for which the goals should be exported.

Output sample:

Copy
[
  {
    "individualReviewId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "Employee",
    "templateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "performanceReviewId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "userId": "string",
    "status": "Default",
    "isDisabled": true,
    "employeeAccepted": true,
    "acceptedComment": "string",
    "finalValidationComment": "string",
    "finalValidationDate": "2025-07-04T15:02:08.306Z",
    "submittedBy": "string",
    "updatedBy": "string",
    "dateCreated": "2025-07-04T15:02:08.306Z",
    "lastModifiedDate": "2025-07-04T15:02:08.306Z",
    "freezeDate": "2025-07-04T15:02:08.306Z",
    "overallPerformanceRating": {
      "comment": "string",
      "ratingScaleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "dateUpdated": "2025-07-04T15:02:08.306Z",
      "updatedBy": "string"
    },
    "overallGoalRating": {
      "comment": "string",
      "ratingScaleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "dateUpdated": "2025-07-04T15:02:08.306Z",
      "updatedBy": "string"
    },
    "overallBehaviourRating": {
      "comment": "string",
      "ratingScaleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "dateUpdated": "2025-07-04T15:02:08.306Z",
      "updatedBy": "string"
    },
    "finalOverallPerformanceRating": {
      "comment": "string",
      "ratingScaleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "dateUpdated": "2025-07-04T15:02:08.306Z",
      "updatedBy": "string"
    },
    "finalOverallPerformanceRatingByLineManagerPlus1": {
      "comment": "string",
      "ratingScaleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "dateUpdated": "2025-07-04T15:02:08.306Z",
      "updatedBy": "string"
    },
    "goalRatings": [
      {
        "comment": "string",
        "ratingScaleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "dateUpdated": "2025-07-04T15:02:08.306Z",
        "updatedBy": "string",
        "entityId": 0
      }
    ],
    "behaviourRatings": [
      {
        "comment": "string",
        "ratingScaleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "dateUpdated": "2025-07-04T15:02:08.306Z",
        "updatedBy": "string",
        "entityId": 0
      }
    ],
    "excludedGoals": [
      0
    ],
    "excludedBehaviours": [
      0
    ],
    "letsDiscussSection": {
      "commentByEmployee": "string",
      "commentByManager": "string",
      "dateUpdatedEmployeesComment": "2025-07-04T15:02:08.307Z",
      "dateUpdatedManagersComment": "2025-07-04T15:02:08.307Z",
      "reviewEmployeeFiles": [
        {
          "field": "string",
          "fileName": "string",
          "dateCreated": "2025-07-04T15:02:08.307Z",
          "fileSize": 0
        }
      ],
      "reviewManagerFiles": [
        {
          "field": "string",
          "fileName": "string",
          "dateCreated": "2025-07-04T15:02:08.307Z",
          "fileSize": 0
        }
      ]
    },
    "challengeDiscussSection": {
      "commentByEmployee": "string",
      "commentByManager": "string",
      "dateUpdatedEmployeesComment": "2025-07-04T15:02:08.307Z",
      "dateUpdatedManagersComment": "2025-07-04T15:02:08.307Z",
      "reviewEmployeeFiles": [
        {
          "field": "string",
          "fileName": "string",
          "dateCreated": "2025-07-04T15:02:08.307Z",
          "fileSize": 0
        }
      ],
      "reviewManagerFiles": [
        {
          "field": "string",
          "fileName": "string",
          "dateCreated": "2025-07-04T15:02:08.307Z",
          "fileSize": 0
        }
      ]
    },
    "reviewFiles": [
      {
        "field": "string",
        "fileName": "string",
        "dateCreated": "2025-07-04T15:02:08.307Z",
        "fileSize": 0
      }
    ],
    "answersForQuestionCustomWidget": [
      {
        "widgetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "questionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "comment": "string",
        "ratingScaleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "dateUpdated": "2025-07-04T15:02:08.307Z"
      }
    ],
    "isActual": true,
    "chainId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "isDeleted": true
  }
]

Output description

This endpoint returns the data related to each individual participant of a review in the Comp Complete application.

  • Individual Review ID: A unique identifier for a specific instance of an individual performance review within the Comp Complete application.

  • Review Type Outbound: The classification or category defining that describes the role of user in the review.

  • Template ID: The unique identifier of the review template upon which this individual review is based.

  • Performance Review ID: A unique identifier that links this individual review to a broader performance review.

  • User ID: The unique identifier of the employee who is the subject of this individual review.

  • Status: The current state or phase of the individual review.

  • Is Disabled: A boolean indicator showing whether the review has been disabled or made inactive.

  • Employee Accepted: A boolean indicator confirming whether the employee has formally accepted their review.

  • Accepted Comment: Any written remarks or feedback provided by the employee when accepting their review.

  • Final Validation Comment: Any final comments or notes added during the ultimate validation or approval stage of the review.

  • Final Validation Date: The specific calendar date and time when the individual review underwent its final validation or approval.

  • Submitted By: The unique identifier of the user who formally submitted the individual review.

  • Updated By: The unique identifier of the user who last made any modifications to the individual review record.

  • Date Created: The specific calendar date and time when the individual review record was initially generated in the system.

  • Last Modified Date: The most recent calendar timestamp of a specific version record.

  • Overall Performance Rating: The aggregated rating given for the employee's total performance. Defined in the Overall performance section of the individual review page.

    • Comment: Written explanation or justification for the overall performance rating.

    • Date Updated: The calendar date and time when this overall performance rating was last updated.

    • Updated By: The unique identifier of the user who last updated this overall performance rating.

    • RatingScaleId:

  • Overall Goal Rating: The aggregated rating given for the employee's achievement of their goals. Defined in the Goals section of the individual review page.

    • Comment: Written explanation or justification for the overall goal rating.

    • Date Updated: The calendar date and time when this overall goal rating was last updated.

    • Updated By: The unique identifier of the user who last updated this overall goal rating.

    • RatingScaleId:

  • Overall Behaviour Rating: The aggregated rating given for the employee's demonstrated behaviors. Defined in the Behaviors section of the individual review page.

    • Comment: Written explanation or justification for the overall behavior rating.

    • date Updated: The calendar date and time when this overall behavior rating was last updated.

    • Updated By: The unique identifier of the user who last updated this overall behavior rating.

    • RatingScaleId

  • Final Overall Performance Rating: The final, definitive aggregated rating for the employee's total performance, potentially after moderation or finalization.

    • Comment: Written explanation or justification for the final overall performance rating.

    • Date Updated: The calendar date and time when this final overall performance rating was last updated.

    • Updated By: The unique identifier of the user who last updated this final overall performance rating.

    • RatingScaleId

  • Final Overall Performance Rating By Line Manager Plus 1: The final aggregated performance rating provided specifically by the employee's manager's manager (or next level up).

    • Comment: Written explanation or justification for this rating from the manager's manager.

    • Date Updated: The calendar date and time when this rating was last updated.

    • Updated By: The unique identifier of the user who last updated this rating.

    • RatingScaleId

  • Goal Ratings: A collection of individual ratings for each of the employee's specific goals.

    • Comment: Written explanation or justification for the rating of a specific goal.

    • Date Updated: The calendar date and time when this specific goal rating was last updated.

    • Updated By: The unique identifier of the user who last updated this specific goal rating.

    • Entity ID: The unique identifier of the specific goal being rated.

    • RatingScaleId

  • Behaviour Ratings: A collection of individual ratings for each of the employee's specific behaviors.

    • Comment: Written explanation or justification for the rating of a specific behavior.

    • Date Updated: The calendar date and time when this specific behavior rating was last updated.

    • Updated By: The unique identifier of the user who last updated this specific behavior rating.

    • Entity ID: The unique identifier of the specific behavior being rated.

    • RatingScaleId

  • Lets Discuss Section: A section dedicated to notes or comments related to discussion points identified for follow-up.

    • Comment By Employee: Written input from the employee in the "Let's Discuss" section.

    • Comment By Manager: Written input from the manager in the "Let's Discuss" section.

    • Date Updated Employees Comment: The calendar date and time when the employee's comment in this section was last updated.

    • Date Updated Managers Comment: The calendar date and time when the manager's comment in this section was last updated.

  • Challenge Discuss Section: A dedicated section for comments related to any challenge process initiated by the employee regarding their review.

    • Comment By Employee: Written input from the employee within the challenge discussion section.

    • Comment By Manager: Written input from the manager within the challenge discussion section.

    • Date Updated Employees Comment: The calendar date and time when the employee's comment in the challenge section was last updated.

    • Date Updated Managers Comment: The calendar date and time when the manager's comment in the challenge section was last updated.

  • Review Employee Files: A collection of files attached to the review by the employee.

    • Field: The specific field or section of the review to which the file is attached.

    • File Name: The name of the attached file.

    • Date Created: The calendar date and time when the file was uploaded.

    • File Size: The size of the attached file in bytes.

  • Review Manager Files: A collection of files attached to the review by the manager.

    • Field: The specific field or section of the review to which the file is attached.

    • File Name: The name of the attached file.

    • Date Created: The calendar date and time when the file was uploaded.

    • File Size: The size of the attached file in bytes.

  • Review Files: A general collection of files attached to the review, possibly by any participant or for general context.

    • Field: The specific field or section of the review to which the file is attached.

    • File Name: The name of the attached file.

    • Date Created: The calendar date and time when the file was uploaded.

    • File Size: The size of the attached file in bytes.

  • Answers For Question Custom Widget: A collection of responses or data points associated with a custom question widget within the review.

    • Comment: The text input or response provided for the custom widget question.

    • Date Updated: The calendar date and time when the answer for the custom widget was last updated.

    • Is Actual: A boolean indicator showing if this answer is the most current or valid one.

    • Is Deleted: A boolean indicator showing if this answer for the custom widget has been marked as deleted.

Retrieving custom review template data - /integrationapi/v2/data/review-template-custom-types

Method: GET

Endpoint: /integrationapi/v2/data/review-template-custom-types

Parameters:

  • lastModifiedDate>dateFrom: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshot from the specified date.

  • lastModifiedDate>dateTo: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshots until the specified date, including datetime.

  • page: optional, by default 1, integer. Page number to return starting from 1.

  • count: optional, by default 10, integer. Number of records to return per page.

  • templateCustomTypeId: string, required. ID of the custom review template(s) to be retrieved.

Output sample:

Copy
[
  {
    "id": 0,
    "hidden": true,
    "title": [
      {
        "language": "string",
        "value": "string"
      }
    ],
    "updatedBy": "string",
    "dateCreated": "2025-07-04T15:07:49.492Z",
    "lastModifiedDate": "2025-07-04T15:07:49.492Z"
  }
]

Output description

This endpoint returns the data related to custom review templates in the Comp Complete application.

  • ID: A unique identifier assigned to this specific custom review type. This ID distinguishes it from other custom review types in the system.

  • Hidden: A boolean indicating whether this custom review type is currently hidden from selection or view in the user interface. It might exist in the system but not be actively presented to users.

  • Title: The main heading or name of the custom review template, displayed to users.

    • Language: The language code for the template's title.

    • Value: The actual text of the template's title in that specific language.

  • Updated By: The unique identifier of the user who last made changes or updates to this custom review template.

  • Date Created: The specific calendar date and time when this custom review template was originally created in the system.

  • Last Modified Date: The most recent timestamp of a specific version record.

Retrieving review outcome data - /integrationapi/v2/data/review-templates/outcome

Method: GET

Endpoint: /integrationapi/v2/data/review-templates/outcome

Parameters:

  • lang: string, required. Language of the localized name. Default value: en.

  • lastModifiedDate>dateFrom: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshot from the specified date.

  • lastModifiedDate>dateTo: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshots until the specified date, including datetime.

  • includeHistorical: boolean, optional. Default value: false. Specifies whether historical (Historical Performance Rating Upload) reviews can be added if true returns both historical and not historical.

Output sample:

Copy
[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "string",
    "startReviewDateTime": "2025-07-04T15:12:13.125Z",
    "endReviewDateTime": "2025-07-04T15:12:13.125Z",
    "year": 0,
    "name": "string",
    "description": "string",
    "countPerformanceReviews": 0,
    "dateUpdated": "2025-07-04T15:12:13.125Z",
    "dateCreated": "2025-07-04T15:12:13.125Z",
    "customTypeId": 0,
    "isHistorical": {}
  }
]

Output description

This endpoint returns the data related to current reviews templates in the Comp Complete application.

  • ID: A unique identifier assigned to this specific review template.

  • Status: The current operational state of the review template (e.g., Active, Draft, Archived).

  • Start Review Date Time: The exact date and time when the review cycle associated with this template begins or becomes active.

  • End Review Date Time: The exact date and time when the review cycle associated with this template ends or becomes inactive.

  • Year: The calendar year to which this review template primarily applies.

  • Name: The name or title of the review template.

  • Description: A brief explanation or summary of the review template's purpose or content.

  • Count Performance Reviews: The total number of individual performance reviews that have been created or assigned using this specific template.

  • Date Updated: The specific date and time when this review template was last modified.

  • Date Created: The specific date and time when this review template was originally created in the system.

  • Custom Type ID: A custom identifier or category assigned to the template, used for labeling.

  • Historical Performance Rating Upload: A boolean (true/false) flag indicating whether this template is considered historical and is no longer intended for active use in creating new reviews.

Retrieving individual review outcome data - /integrationapi/v2/data/individual-reviews/outcome/initial

Method: GET

Endpoint: /integrationapi/v2/data/individual-reviews/outcome/initial

Parameters:

  • templateIds: sting, required. Filters the response by review template ID.

  • statuses: string. Filters the response by review status.

  • page: optional, integer. Page number to return starting from 1.

  • count: optional, integer. Number of records to return per page.

  • includeHistorical: boolean, optional. Default value: false. Specifies whether historical (Historical Performance Rating Upload) reviews can be added if true returns both historical and not historical.

Output sample:

Copy
[
  {
    "reviewTemplateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "internalUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "externalUserId": "string",
    "email": "string",
    "reviewStartDate": "2025-07-04T15:17:05.228Z",
    "reviewEndDate": "2025-07-04T15:17:05.228Z",
    "lastUpdatedDateTime": "2025-07-04T15:17:05.228Z",
    "reviewYear": 0,
    "reviewType": 0,
    "status": 0,
    "finalPerformanceRating": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "value": 0
    }
  }
]

Output description

This endpoint returns the data related to compensation in the Comp Complete application.

  • Review Template ID: The unique identifier of the review template that was used for the performance review related to this compensation data.

  • Internal User ID: The unique identifier for the employee within the company's internal user directory or system.

  • External User ID: An alternative unique identifier for the employee that might be used for external systems or integrations (e.g., a payroll system ID).

  • Email: The primary email address of the employee related to this compensation data.

  • Review Start Date: The exact date when the performance review period for this compensation data began.

  • Review End Date: The exact date when the performance review period for this compensation data ended.

  • Last Updated Date Time: The most recent date and time when this specific compensation record was changed or updated in the system.

  • Review Year: The calendar year to which the performance review and associated compensation data pertains.

  • Review Type: The classification or category of the performance review (e.g., "Annual Review," "Mid-Year Check-in," "Probation Review").

  • Status: The current state of the compensation record or its associated review (e.g., "Draft," "Approved," "Pending Payout," "Finalized").

  • Final Performance Rating: The employee's conclusive performance rating from the associated review.

    • ID: The unique identifier for the specific performance rating level (e.g., the ID for "Exceeds Expectations").

    • Value: The actual value or label of the final performance rating (e.g., "5," "Outstanding," "Meets Expectations").

Retrieving individual review outcome data (without status filter) integrationapi/v2/data/individual-reviews/outcome/delta

Method: GET

Endpoint: /integrationapi/v2/data/individual-reviews/outcome/delta

Parameters:

  • templateIds: sting, required. Filters the response by review template ID.

  • lastModifiedDate>dateFrom: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshot from the specified date.

  • lastModifiedDate>dateTo: required, in YYYY_MM-DDT00:00:00.000Z ISO 8601Z format. Filters results to return snapshots until the specified date, including datetime.

Output sample:

Copy
{
    "reviewTemplateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "internalUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "externalUserId": "string",
    "email": "string",
    "reviewStartDate": "2025-04-30T09:29:40.757Z",
    "reviewEndDate": "2025-04-30T09:29:40.757Z",
    "lastUpdatedDateTime": "2025-04-30T09:29:40.757Z",
    "reviewYear": 0,
    "reviewType": 0,
    "status": 0,
    "finalPerformanceRating": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "value": 0
    }
  }

Output description

This endpoint returns the data related to compensation that has changed in the Comp Complete application over the specified period.

  • Review Template ID: The unique identifier of the review template that was used for the performance review related to this compensation data.

  • Internal User ID: The unique identifier for the employee within the company's internal user directory or system.

  • External User ID: An alternative unique identifier for the employee that might be used for external systems or integrations.

  • Email: The primary email address of the employee related to this compensation data.

  • Review Start Date: The exact date when the performance review period for this compensation data began.

  • Review End Date: The exact date when the performance review period for this compensation data ended.

  • Last Updated Date Time: The most recent date and time when this specific compensation record was changed or updated in the system. This field is crucial for determining if the data has "changed over the specified period."

  • Review Year: The calendar year to which the performance review and associated compensation data pertains.

  • Review Type: The classification or category of the performance review (e.g., "Annual Review," "Mid-Year Check-in," "Probation Review").

  • Status: The current state of the compensation record or its associated review (e.g., "Draft," "Approved," "Pending Payout," "Finalized").

  • Final Performance Rating: The employee's conclusive performance rating from the associated review.

    • ID: The unique identifier for the specific performance rating level (e.g., the ID for "Exceeds Expectations").

    • Value: The actual value or label of the final performance rating (e.g., "5," "Outstanding," "Meets Expectations").

Pagination model

The API endpoints return results in a paginated model. The response contains the following fields:

Pagination model fields

Where:

  • currentPage: requested page number.

  • pageCount: total number of pages.

  • pageSize: number of records per page.

  • rowCount: total number of records.

  • results: array of records.

Attachments
Was this article helpful?
0 out of 0 found this helpful
Return to top