Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
stockgrant

Return a particular stock grant by id

get/v1/org/{orgId}/stockgrant/{stockGrantId}

Path parameters

orgIdstring required

Org identifier (either id or slug)

stockGrantIdstring required

Stock grant id

Response

successful operation

idstring required

globally unique id of stock grant

orgIdstring required

org that the stock grant belongs to

personIdstring required

person granted the stock

externalIdstring

external identifier, if grant synced from external system

stockstring required

ticker symbol of this stock

datestring date required

date of grant

vestStartDatestring date

vesting start date of grant

expireDatestring date

expiration date of grant

sharesnumber required

number of shares granted

pricenumber required

per share strike price

type'ISO' | 'NSO' | 'RSU' | 'SAR' | 'PERFORMANCE_SHARES' | 'PHANTOM_STOCK' | 'RSA' required

type of grant

vestSchedulestring required

vesting schedule

originalPricenumber

original per share value of stock (grant price at time of issue)

currentPricenumber

current per share value of stock

vestedSharesnumber

current number of shares vested

vestedSharesNextYearnumber

number of shares vested one year from today

vestedSharesByDateobject

number of shares vested, by future date

vestEndDatestring date

vesting end date

cancelDatestring date

cancellation date

terminationDatestring date

termination date — vesting freezes on this date when the holder separates

lastExercisableDatestring date

last date on which vested shares can be exercised; after this the grant is forfeited

detailsstring

details of the grant (arbitrary text)

createIdstring

created by user id

createAtstring

created timestamp

updateAtstring

updated timestamp

updateIdstring

updated by user id

deleteIdstring

deleted by user id

deleteAtstring

deleted timestamp

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "personId": "588f7ee98f138b19220041a7",
  "externalId": "588f7ee98f138b19220041a7",
  "stock": "GOOG",
  "createId": "588f7ee98f138b19220041a7",
  "createAt": "2017-01-24T13:57:52Z",
  "updateAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "deleteId": "588f7ee98f138b19220041a7",
  "deleteAt": "2017-01-24T13:57:52Z"
}