band

Find comp bands in the organization

get/v1/org/{orgId}/band

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/band
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

datestring date

Date to search as of

fromstring

Table id to start paginating from

limitinteger

Number of results to return

includeDeletedboolean

Include deleted bands

returnAccessstring

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

jobTierOnestring

Filter by job tier one value

jobTierTwostring

Filter by job tier two value

jobTierThreestring

Filter by job tier three value

sortstring

Sort by CompBand field (e.g., label, baseCompMin, baseCompMax)

jobLevelstring

Filter by job level label

Response

successful operation

nextstring

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 20 revisions of this API.