Account Information13

Alerts5

Applicant Tracking10

Benefits10

Calendar Events1

Change Tracking2

Company Files6

Company Profile3

Compensation3

Compensation Benchmarking11

Compensation Planning28

Custom Fields12

Custom Reports4

Custom Tables7

Datasets8

Employee Files6

Employee Tables6

Employee Verification5

Employees8

Field Metadata4

Goals24

Holidays8

Hours1

Locations5

Login1

Meal & Rest Breaks20

Onboarding12

Pay Grades & Bands14

Photos2

Public API5

Recognition Settings1

Reports2

Scheduling21

Time Off37

Time Tracking63

Total Rewards8

Training12

Webhooks8

Webhooks

Webhook Events6

Compensation

Public API

Get company equity settings

Changed on Nov 3, 2026

Retrieves company-level equity settings including calculation type, valuation, shares, pricing, and vesting-related configuration.

OAuth Scopes: equity

get/api/v1/compensation/equity/settings

Request

Base URL
https://companySubDomain.bamboohr.com
Auth
OAuth 2
Authorization code/authorize.php
Token URL/token.php
Scopesequity
TypeScript
https://skmtc.dev/bamboohr/apis/bamboohr-api/docs/api/v1/compensation/equity/settings/get.ts
A function with typed inputs. Its response is checked against the schema.

Response

Success

calculationTypestring

companyValuationnumber nullable

outstandingSharesinteger nullable

pricePerSharenumber nullable

currencyCodestring

sliderMininteger nullable

sliderMaxinteger nullable

vestingConditionsstring nullable

disclaimersstring nullable

Changes

Nov 3, 2026922fc15f43a7 Revision changes
- info
  api operation id db49fb29f9f04d59afad7c01ce860418 removed and replaced with d90d59c4f1201ea05c23a1313c071db4

Operation history

Get company equity settings

Request

Response 200OK

Changes

Response