Skip to content

Deel: List equity grants with tax events

Deel equityTokens.listEquityGrantsWithTaxEvents: arguments, response, policy and SDK examples.

← Equity tokens operations · Get started

Operation deel.equitytokens_listequitygrantswithtaxevents_v2026_08_10

Provider route: GET /equity-grants. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["equityTokens"]["listEquityGrantsWithTaxEvents"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.equityTokens.listEquityGrantsWithTaxEvents(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.equity_tokens.list_equity_grants_with_tax_events(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.limitintegerOptionalDefault: 100
Maximum: 200
Minimum: 1
query.offsetintegerOptionalDefault: 0
Minimum: 0
query.searchstringOptionalMaximum length: 255

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List equity grants with tax events — 200 response body

Referenced models: List equity grants with tax events — 200 response body

3 more schemas are linked from the tables above, on the schema pages.

List equity grants with tax events — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand List equity grants with tax events — 200 response body — data item
limitJSONOptional
limit (anyOf 1)integerAlternativeThe limit applied to this page of results
limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
offsetJSONOptional
offset (anyOf 1)integerAlternativeThe offset applied to this page of results
offset (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalJSONOptional
total (anyOf 1)integerAlternativeThe total number of grants matching the query, independent of limit/offset
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List equity grants with tax events — 200 response body — data item

List equity grants with tax events — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
additional_grant_requirements_and_restrictionsJSONOptional
additional_grant_requirements_and_restrictions (anyOf 1)stringAlternativeFree-text additional requirements or restrictions on the grant
additional_grant_requirements_and_restrictions (anyOf 2)nullAlternativeFree-text additional requirements or restrictions on the grant
cliff_periodJSONOptional
cliff_period (anyOf 1)JSONAlternative
cliff_period (anyOf 1) (anyOf 1)numberAlternativeThe cliff period in months before any shares vest
Format: double
cliff_period (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
cliff_period (anyOf 2)nullAlternativeThe cliff period in months before any shares vest
Format: double
equity_grant_typeJSONOptional
equity_grant_type (anyOf 1)stringAlternativeThe type of equity instrument granted
equity_grant_type (anyOf 2)nullAlternativeThe type of equity instrument granted
equity_grant_type_nameJSONOptional
equity_grant_type_name (anyOf 1)stringAlternativeThe organization's custom label for the grant type
equity_grant_type_name (anyOf 2)nullAlternativeThe organization's custom label for the grant type
exercise_priceJSONOptional
exercise_price (anyOf 1)JSONAlternative
exercise_price (anyOf 1) (anyOf 1)numberAlternativeThe per-unit price at which the option or warrant can be exercised, in exercise price currency
Format: double
exercise_price (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
exercise_price (anyOf 2)nullAlternativeThe per-unit price at which the option or warrant can be exercised, in exercise price currency
Format: double
exercise_price_currencyJSONOptional
exercise_price_currency (anyOf 1)stringAlternativeThe currency of the exercise price
exercise_price_currency (anyOf 2)nullAlternativeThe currency of the exercise price
fmv_when_grantedJSONOptional
fmv_when_granted (anyOf 1)JSONAlternative
fmv_when_granted (anyOf 1) (anyOf 1)numberAlternativeThe fair market value of the underlying instrument at grant time
Format: double
fmv_when_granted (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fmv_when_granted (anyOf 2)nullAlternativeThe fair market value of the underlying instrument at grant time
Format: double
grant_currencyJSONOptional
grant_currency (anyOf 1)stringAlternativeThe currency of the grant value
grant_currency (anyOf 2)nullAlternativeThe currency of the grant value
grant_dateJSONOptional
grant_date (anyOf 1)stringAlternativeThe date the grant was issued
Format: date
grant_date (anyOf 2)nullAlternativeThe date the grant was issued
Format: date
grant_nameJSONOptional
grant_name (anyOf 1)stringAlternativeThe name of the grant
grant_name (anyOf 2)nullAlternativeThe name of the grant
grant_statusJSONOptional
grant_status (anyOf 1)stringAlternativeThe lifecycle status of the grant (e.g. GRANTED, PENDING_APPROVAL)
grant_status (anyOf 2)nullAlternativeThe lifecycle status of the grant (e.g. GRANTED, PENDING_APPROVAL)
hris_profileModelOptionalExpand List equity grants with tax events — 200 response body — data item hris profile
Profile information for the EOR worker who holds the grant
idstringOptionalThe unique identifier of the equity grant
Format: uuid
option_expirationJSONOptional
option_expiration (anyOf 1)stringAlternativeThe date the option expires
Format: date
option_expiration (anyOf 2)nullAlternativeThe date the option expires
Format: date
quantityJSONOptional
quantity (anyOf 1)JSONAlternative
quantity (anyOf 1) (anyOf 1)numberAlternativeThe total quantity granted
Format: double
quantity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantity (anyOf 2)nullAlternativeThe total quantity granted
Format: double
reference_idJSONOptional
reference_id (anyOf 1)JSONAlternative
reference_id (anyOf 1) (anyOf 1)numberAlternativeThe human-readable reference number of the grant
Format: double
reference_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
reference_id (anyOf 2)nullAlternativeThe human-readable reference number of the grant
Format: double
sourceJSONOptional
source (anyOf 1)stringAlternativeThe system of record the grant originated from
source (anyOf 2)nullAlternativeThe system of record the grant originated from
tax_eventsarrayOptionalThe tax events reported against this grant
tax_events[]ModelEach itemExpand List equity grants with tax events — 200 response body — data item tax events item
tranchesJSONOptional
tranches (anyOf 1)JSONAlternative
tranches (anyOf 1) (anyOf 1)numberAlternativeThe number of vesting tranches
Format: double
tranches (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tranches (anyOf 2)nullAlternativeThe number of vesting tranches
Format: double
valueJSONOptional
value (anyOf 1)JSONAlternative
value (anyOf 1) (anyOf 1)numberAlternativeThe total grant value at the time of issuance, in grant currency
Format: double
value (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value (anyOf 2)nullAlternativeThe total grant value at the time of issuance, in grant currency
Format: double
vested_eventsarrayOptionalThe individual vesting events recorded for this grant
vested_events[]ModelEach itemExpand List equity grants with tax events — 200 response body — data item vested events item
vested_quantityJSONOptional
vested_quantity (anyOf 1)JSONAlternative
vested_quantity (anyOf 1) (anyOf 1)numberAlternativeThe quantity vested so far
Format: double
vested_quantity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
vested_quantity (anyOf 2)nullAlternativeThe quantity vested so far
Format: double
vesting_lengthJSONOptional
vesting_length (anyOf 1)JSONAlternative
vesting_length (anyOf 1) (anyOf 1)numberAlternativeThe total vesting length in months
Format: double
vesting_length (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
vesting_length (anyOf 2)nullAlternativeThe total vesting length in months
Format: double
vesting_start_dateJSONOptional
vesting_start_date (anyOf 1)stringAlternativeThe date vesting begins
Format: date
vesting_start_date (anyOf 2)nullAlternativeThe date vesting begins
Format: date

Referenced models: List equity grants with tax events — 200 response body — data item hris profile, List equity grants with tax events — 200 response body — data item tax events item, List equity grants with tax events — 200 response body — data item vested events item

SDK function policy ID: deel.equitytokens_listequitygrantswithtaxevents_v2026_08_10. Catalog operation: equitytokens_listequitygrantswithtaxevents_v2026_08_10. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["equities:read"]

Pinned headers: {"X-Version": "2026-08-10"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.