Skip to main content
GET
Get Employee Grants

Authorizations

Authorization
string
header
required

Personal API token. Create via createUserApiToken endpoint.

Headers

x-role-type
enum<string>
required

Role context for the request. Use CLIENT_ORG_ADMIN for most integrations.

Available options:
CLIENT_ORG_ADMIN,
PAYROLL_ADMIN,
FINANCE_ADMIN,
TOKU_ADMIN

Query Parameters

payrollEmployeeID
string

Payroll identifier. Takes precedence when both are provided.

externalEmployeeID
string

External HRIS identifier. At least one ID is required.

Response

Employee grants

grantID
string<uuid>
Example:

"550e8400-e29b-41d4-a716-446655440000"

grantName
string
Example:

"Q1 2026 Token Grant"

grantDescription
string | null
Example:

"Annual token compensation"

grantStatus
string
Example:

"ACCEPTED"

grantAmount
number
Example:

50000

grantAmountInFiat
number | null
Example:

25000

pricePerUnit
number | null
Example:

0.5

pricePerUnitCurrencyCode
string | null
Example:

"USD"

grantDate
string<date-time> | null
Example:

"2025-12-15T00:00:00.000Z"

vestingStartDate
string<date-time> | null
Example:

"2026-01-01T00:00:00.000Z"

vestingFrequencyType
string | null
Example:

"MONTHLY"

vestingCliffPercentage
number | null
Example:

25

vestingCliffPeriods
integer | null
Example:

12

vestingPeriods
number | null
Example:

48

terminationDate
string<date-time> | null
Example:

null

futureTerminationDate
string<date-time> | null
Example:

null

tags
string[]
Example: