Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
comp-review

Find comp reviews in the organization

get/v1/org/{orgId}/comp-review

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

fromstring

Comp review ID to start paginating from

limitinteger

Number of results to return

returnAccessstring

Return access information -- pass a list of actions to check, for example: create,update,delete

Response

successful operation

nextstring

Example response

{
  "data": [
    {
      "id": "588f7ee98f138b19220041a7",
      "orgId": "588f7ee98f138b19220041a7",
      "label": "Comp review H2 2022",
      "config": {
        "eligibleEmployees": {
          "excludeGroupIds": [
            "588f7ee98f138b19220041a7"
          ],
          "individualExclusions": [
            "588f7ee98f138b19220041a7"
          ],
          "individualInclusions": [
            "588f7ee98f138b19220041a7"
          ]
        },
        "reviewersAndApprovers": {
          "excludedReviewerIds": [
            "588f7ee98f138b19220041a7"
          ],
          "approverIds": [
            "588f7ee98f138b19220041a7"
          ]
        },
        "collaborators": {
          "collaboratorJobIds": [
            "588f7ee98f138b19220041a7"
          ],
          "collaboratorMatrix": {
            "conditions": [
              {
                "collaboratorJobIds": [
                  "588f7ee98f138b19220041a7"
                ]
              }
            ]
          }
        },
        "reviewerWorkbook": {
          "columns": [
            {
              "visibleToGroups": [
                "588f7ee98f138b19220041a7"
              ]
            }
          ]
        },
        "budgets": {
          "totalBudgetVisibilityPersonIds": [
            "588f7ee98f138b19220041a7"
          ]
        }
      },
      "shareAccess": [
        {
          "userId": "5887a7718f138b6a2a0041a7",
          "groupId": "5887a7718f138b6a2a0041a7",
          "fields": "name,image,title"
        }
      ],
      "createId": "588f7ee98f138b19220041a7",
      "createBehalfId": "588f7ee98f138b19220041a7",
      "createAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "createAt": "2017-01-24T13:57:52Z",
      "updateId": "588f7ee98f138b19220041a7",
      "updateBehalfId": "588f7ee98f138b19220041a7",
      "updateAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "updateAt": "2017-01-24T13:57:52Z",
      "deleteId": "588f7ee98f138b19220041a7",
      "deleteBehalfId": "588f7ee98f138b19220041a7",
      "deleteAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "deleteAt": "2017-01-24T13:57:52Z"
    }
  ],
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}