AVAILABLE WITH BUSINESS SUBSCRIPTION

POST /performance-management/appraisal/session/{sessionId}/info

Permissions to Run the Request

Account Owner and Account Administrators

Request Headers

HeaderDescription
Authorization (required)Access token. You can obtain a token by making a request
Content-Type: application/json
(required)
Property for processing a request in JSON
Accept: application/json
(required)
Property for processing a request in JSON
ParameterDescription
sessionId (required)The session ID

Response Parameters

ParameterDescription
name

The session name

description

The session description 

managerId

The manager ID

startDate

Session start time

endDate

Session end time

status

Session status

profileId

The profile ID

instruction

Instructions for employees

selfReviewInstruction

Instructions for self-review

questions []An array with data about questions
idQuestion ID
textQuestion text
isRequired

Indicates whether answering the question is required
Possible values:

  • false — optional
  • true — required
targetRoles []

An array with data about reviewers

value

Reviewers' roles:

  • REVIEWER_ROLE_SELF_REVIEW — self-assessment
  • REVIEWER_ROLE_DIRECT_MANAGER — manager
  • REVIEWER_ROLE_PEER — colleagues
  • REVIEWER_ROLE_DIRECT_REPORT — subordinates
  • REVIEWER_ROLE_CUSTOMER — customers
  • REVIEWER_ROLE_EXPERT — experts
employees []An array with data about the employee
employeeIdEmployee ID
reviewers []An array with data about reviewers
reviewerIdReviewer ID
roleUsers’ roles
permittedUserIdsIDs of the users who have access to the session

Response Codes

CodeTextDescription
200The request has been successfully processed
400Bad requestA request error
401UnauthorizedAn authorization error

Sample Request

POST performance-management/appraisal/session/8e7a5d39-1ae3-11f0-ae26-765c58ce190a/info
Host: api-learn.ispringlearn.com
Content-Type: application/json
Accept: application/json
X-Auth-Account-Url: https://api-learn.ispringlearn.com
Authorization: Bearer lW71iv_8-_0AiuL4raPaxZhefekBpgHZdVtdZRxGPoE

{
}
CODE

Sample Response

HTTP/1.1 200 OK
{
  "sessionId": "8e7a5d39-1ae3-11f0-ae26-765c58ce190a",
  "name": "Test",
  "description": "Test",
  "managerId": "8e7a5d39-1ae3-11f0-ae26-765c58ce190a",
  "startDate": "2025-04-23T17:58:36+00:00",
  "endDate": "",
  "status": "IN_PROGRESS",
  "profileId": "8e7a5d39-1ae3-11f0-ae26-765c58ce190a",
  "instruction": "{\"version\":4,\"state\":[{\"t\":\"p\",\"T\":\"You're invited to provide feedback about your colleague.\\nYour input will help your co-worker identify and understand their strengths and challenges and see opportunities for further development.\\nIt usually takes 10-15 minutes to complete the survey.\\nThis feedback review is completely anonymous, so please answer all questions as honestly and as accurately as you can. You can comment on answers to explain your reasoning for your choice.\\nAnswers are automatically saved, so if you close the form you can always come back to it later.\\nThanks for your time and input!\",\"k\":\"8bcf0f59-bb10-4e60-b44a-fa2758fc04ec\",\"v\":\"text\",\"a\":\"left\",\"i\":[],\"u\":[]}]}",
  "selfReviewInstruction": "{\"version\":4,\"state\":[{\"t\":\"p\",\"T\":\"You're invited to complete a self-evaluation form.\\nThis is an opportunity for you to express your opinion on how well you perform and to reflect on ways you can improve.\\nIt usually takes 10-15 minutes to complete the survey.\\nYou can comment on answers to explain your reasoning for your choice. Answers are automatically saved, so if you close the form you can always come back to it later.\",\"k\":\"9a263bad-a2fb-4167-99cb-f8e0e5eb5672\",\"v\":\"text\",\"a\":\"left\",\"i\":[],\"u\":[]}]}",
  "questions": [
    {
      "id": "fb2f551a-206b-11f0-9acb-2a40b3e0a9c7",
      "text": "New Question Self",
      "isRequired": true,
      "targetRoles": [
        {
          "value": "REVIEWER_ROLE_SELF_REVIEW"
        }
      ]
    },
    {
      "id": "087a6c20-206c-11f0-9acb-2a40b3e0a9c7",
      "text": "New question Manager",
      "isRequired": true,
      "targetRoles": [
        {
          "value": "REVIEWER_ROLE_DIRECT_MANAGER"
        }
      ]
    },
    {
      "id": "10bbcfed-206c-11f0-9acb-2a40b3e0a9c7",
      "text": "New question Experts Opt",
      "isRequired": false,
      "targetRoles": [
        {
          "value": "REVIEWER_ROLE_EXPERT"
        }
      ]
    }
  ],
  "employees": [
    {
      "employeeId": "7ee40868-1613-11f0-961a-aa78c64f2990",
      "reviewers": [
        {
          "reviewerId": "7de13bad-1613-11f0-961a-aa78c64f2990",
          "role": "REVIEWER_ROLE_DIRECT_MANAGER"
        }
      ]
    },
    {
      "employeeId": "7f7cdbf9-1613-11f0-961a-aa78c64f2990",
      "reviewers": [
        {
          "reviewerId": "80083ef5-1613-11f0-961a-aa78c64f2990",
          "role": "REVIEWER_ROLE_EXPERT"
        }
      ]
    },
    {
      "employeeId": "7e8849e8-1613-11f0-961a-aa78c64f2990",
      "reviewers": [
        {
          "reviewerId": "7e8849e8-1613-11f0-961a-aa78c64f2990",
          "role": "REVIEWER_ROLE_SELF_REVIEW"
        }
      ]
    },
    {
      "employeeId": "7fc2d0bf-1613-11f0-961a-aa78c64f2990",
      "reviewers": [
        {
          "reviewerId": "7fc2d0bf-1613-11f0-961a-aa78c64f2990",
          "role": "REVIEWER_ROLE_SELF_REVIEW"
        }
      ]
    },
    {
      "employeeId": "7e37ca63-1613-11f0-961a-aa78c64f2990",
      "reviewers": [
        {
          "reviewerId": "7e37ca63-1613-11f0-961a-aa78c64f2990",
          "role": "REVIEWER_ROLE_SELF_REVIEW"
        }
      ]
    }
  ],
  "permittedUserIds": [
    "7e8849e8-1613-11f0-961a-aa78c64f2990"
  ]
}
CODE


[
  {