Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
band

Return a particular comp band by id on an effective date

get/v1/org/{orgId}/band/{bandId}

Path parameters

orgIdstring required

Org identifier (either id or slug)

bandIdstring required

Comp band id

Query parameters

datestring date

Date to search as of

Response

successful operation

idstring required

globally unique id

orgIdstring required

parent organization id

labelstring required

human-readable name of content

colorstring required

hex color associated with the band level

baseSpreadnumber

spread percent used to calculate base comp from the midpoint

baseTargetPayPercentilenumber

target pay associated with open jobs at this band level, specified as a percentile of [min,max]

equityTargetSharesnumber

target equity for the band, in shares

equityTargetPercentOfBasenumber

target equity for the band, as a percentage of base

equityTargetValuenumber

target equity for the band, as a monetary value, in the same currency as the org

equityRefreshSharesnumber

refresh grant equity for the band, in shares

equityRefreshPercentOfBasenumber

refresh grant equity for the band, as a percentage of base

equityRefreshValuenumber

refresh grant equity for the band, as a monetary value, in the same currency as the org

variablePercentOfBasenumber

variable compensation for the band, specified as a percentage of base

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

deleteIdstring

deleted by user id

deleteBehalfIdstring

deleted on behalf of user id

deleteAtstring

deleted timestamp

createDatestring date

when this entity starts existing in org history

deleteDatestring date

when this entity stops existing in org history

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "label": "L15",
  "color": "#ffee4a",
  "baseInterval": {
    "id": "588f7ee98f138b19220041a7"
  },
  "jobLevel": {
    "tableId": "588f7ee98f138b19220041a7",
    "id": "588f7ee98f138b19220041a7"
  },
  "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"
}