---
title: "Find comp bands in the organization"
method: GET
path: "/v1/org/{orgId}/band"
tags: ["band"]
---

# Find comp bands in the organization

`GET /v1/org/{orgId}/band`

## Path parameters

- `orgId` string, required

## Query parameters

- `date` string, date
- `from` string
- `limit` integer
- `includeDeleted` boolean
- `returnAccess` string
- `jobTierOne` string
- `jobTierTwo` string
- `jobTierThree` string
- `sort` string
- `jobLevel` string

## Response `200`

successful operation

- ResultsCompBand
  - `data` CompBand[], required
    - `id` string, required — globally unique id
    - `orgId` string, required — parent organization id
    - `label` string, required — human-readable name of content
    - `color` string, required — hex color associated with the band level
    - `baseCompMax` Money
      - `amount` number, required
      - `currency` string, required
      - `places` integer
    - `baseCompMid` Money
      - `amount` number, required
      - `currency` string, required
      - `places` integer
    - `baseCompMin` Money
      - `amount` number, required
      - `currency` string, required
      - `places` integer
    - `baseSpread` number — spread percent used to calculate base comp from the midpoint
    - `baseInterval` EnumValue, required
      - `name` string, required — enum value name
      - `label` string, required — enum value label
      - `color` string — color of property
      - `expr` string — computed expression, for ENUM_EXPR type
      - `num` number — numeric value, for ENUM_SCALE type
      - `sort` integer — sort order
      - `rank` integer — rank order, if selected in rank order
      - `id` string — unique identifier for enum
      - `labelTr` Translations
        - `values` object, required
    - `baseTargetPay` Money
      - `amount` number, required
      - `currency` string, required
      - `places` integer
    - `baseTargetPayPercentile` number — target pay associated with open jobs at this band level, specified as a percentile of [min,max]
    - `jobTierOneField` JobTierField
      - `code` string
      - `value` string, required
    - `jobTierTwoField` JobTierField
      - `code` string
      - `value` string, required
    - `jobTierThreeField` JobTierField
      - `code` string
      - `value` string, required
    - `jobLevel` TableRowRef
      - `tableId` string, required
      - `tableName` string, required
      - `id` string, required
      - `label` object
    - `equityTargetShares` number — target equity for the band, in shares
    - `equityTargetPercentOfBase` number — target equity for the band, as a percentage of base
    - `equityTargetValue` number — target equity for the band, as a monetary value, in the same currency as the org
    - `equityRefreshShares` number — refresh grant equity for the band, in shares
    - `equityRefreshPercentOfBase` number — refresh grant equity for the band, as a percentage of base
    - `equityRefreshValue` number — refresh grant equity for the band, as a monetary value, in the same currency as the org
    - `variableValue` Money
      - `amount` number, required
      - `currency` string, required
      - `places` integer
    - `variablePercentOfBase` number — variable compensation for the band, specified as a percentage of base
    - `startingSalary` Money
      - `amount` number, required
      - `currency` string, required
      - `places` integer
    - `createId` string — created by user id
    - `createBehalfId` string — created on behalf of user id
    - `createAttribution` Attribution
      - `principalUserId` string
      - `agentUserIds` string[]
      - `eventId` string
      - `aiChatId` string
      - `aiToolUseId` string
      - `channel` 'WEB' | 'MOBILE' | 'SLACK' | 'TEAMS' | 'MCP'
    - `createAt` string — created timestamp
    - `updateId` string — last updated by user id
    - `updateBehalfId` string — last updated on behalf of user id
    - `updateAttribution` Attribution
      - `principalUserId` string
      - `agentUserIds` string[]
      - `eventId` string
      - `aiChatId` string
      - `aiToolUseId` string
      - `channel` 'WEB' | 'MOBILE' | 'SLACK' | 'TEAMS' | 'MCP'
    - `updateAt` string — last updated timestamp
    - `deleteId` string — deleted by user id
    - `deleteBehalfId` string — deleted on behalf of user id
    - `deleteAttribution` Attribution
      - `principalUserId` string
      - `agentUserIds` string[]
      - `eventId` string
      - `aiChatId` string
      - `aiToolUseId` string
      - `channel` 'WEB' | 'MOBILE' | 'SLACK' | 'TEAMS' | 'MCP'
    - `deleteAt` string — deleted timestamp
    - `createDate` string, date — when this entity starts existing in org history
    - `deleteDate` string, date — when this entity stops existing in org history
  - `next` string
  - `access` ResultsAccess[]
    - `ids` string[]
    - `allowed` AccessAction[], required
      - `action` string, required
      - `fields` string[]
      - `types` string[]

## Other responses

- `400` — bad request
- `401` — not authorized
- `404` — not found

---

[API](https://skmtc.net/charthop/apis/charthop-api.md) · [All operations](https://skmtc.net/charthop/apis/charthop-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/charthop/charthop-api/versions/50a1edd6b27e/schema)