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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.limit | integer | Optional | Default: 100 Maximum: 200 Minimum: 1 |
query.offset | integer | Optional | Default: 0 Minimum: 0 |
query.search | string | Optional | Maximum length: 255 |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand List equity grants with tax events — 200 response body |
Referenced models: List equity grants with tax events — 200 response body
Schemas
Section titled “Schemas”3 more schemas are linked from the tables above, on the schema pages.
List equity grants with tax events — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | |
data[] | Model | Each item | Expand List equity grants with tax events — 200 response body — data item |
limit | JSON | Optional | |
limit (anyOf 1) | integer | Alternative | The limit applied to this page of results |
limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
offset | JSON | Optional | |
offset (anyOf 1) | integer | Alternative | The offset applied to this page of results |
offset (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total | JSON | Optional | |
total (anyOf 1) | integer | Alternative | The total number of grants matching the query, independent of limit/offset |
total (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
additional_grant_requirements_and_restrictions | JSON | Optional | |
additional_grant_requirements_and_restrictions (anyOf 1) | string | Alternative | Free-text additional requirements or restrictions on the grant |
additional_grant_requirements_and_restrictions (anyOf 2) | null | Alternative | Free-text additional requirements or restrictions on the grant |
cliff_period | JSON | Optional | |
cliff_period (anyOf 1) | JSON | Alternative | |
cliff_period (anyOf 1) (anyOf 1) | number | Alternative | The cliff period in months before any shares vest Format: double |
cliff_period (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
cliff_period (anyOf 2) | null | Alternative | The cliff period in months before any shares vest Format: double |
equity_grant_type | JSON | Optional | |
equity_grant_type (anyOf 1) | string | Alternative | The type of equity instrument granted |
equity_grant_type (anyOf 2) | null | Alternative | The type of equity instrument granted |
equity_grant_type_name | JSON | Optional | |
equity_grant_type_name (anyOf 1) | string | Alternative | The organization's custom label for the grant type |
equity_grant_type_name (anyOf 2) | null | Alternative | The organization's custom label for the grant type |
exercise_price | JSON | Optional | |
exercise_price (anyOf 1) | JSON | Alternative | |
exercise_price (anyOf 1) (anyOf 1) | number | Alternative | The per-unit price at which the option or warrant can be exercised, in exercise price currency Format: double |
exercise_price (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
exercise_price (anyOf 2) | null | Alternative | The per-unit price at which the option or warrant can be exercised, in exercise price currency Format: double |
exercise_price_currency | JSON | Optional | |
exercise_price_currency (anyOf 1) | string | Alternative | The currency of the exercise price |
exercise_price_currency (anyOf 2) | null | Alternative | The currency of the exercise price |
fmv_when_granted | JSON | Optional | |
fmv_when_granted (anyOf 1) | JSON | Alternative | |
fmv_when_granted (anyOf 1) (anyOf 1) | number | Alternative | The fair market value of the underlying instrument at grant time Format: double |
fmv_when_granted (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
fmv_when_granted (anyOf 2) | null | Alternative | The fair market value of the underlying instrument at grant time Format: double |
grant_currency | JSON | Optional | |
grant_currency (anyOf 1) | string | Alternative | The currency of the grant value |
grant_currency (anyOf 2) | null | Alternative | The currency of the grant value |
grant_date | JSON | Optional | |
grant_date (anyOf 1) | string | Alternative | The date the grant was issued Format: date |
grant_date (anyOf 2) | null | Alternative | The date the grant was issued Format: date |
grant_name | JSON | Optional | |
grant_name (anyOf 1) | string | Alternative | The name of the grant |
grant_name (anyOf 2) | null | Alternative | The name of the grant |
grant_status | JSON | Optional | |
grant_status (anyOf 1) | string | Alternative | The lifecycle status of the grant (e.g. GRANTED, PENDING_APPROVAL) |
grant_status (anyOf 2) | null | Alternative | The lifecycle status of the grant (e.g. GRANTED, PENDING_APPROVAL) |
hris_profile | Model | Optional | Expand List equity grants with tax events — 200 response body — data item hris profile Profile information for the EOR worker who holds the grant |
id | string | Optional | The unique identifier of the equity grant Format: uuid |
option_expiration | JSON | Optional | |
option_expiration (anyOf 1) | string | Alternative | The date the option expires Format: date |
option_expiration (anyOf 2) | null | Alternative | The date the option expires Format: date |
quantity | JSON | Optional | |
quantity (anyOf 1) | JSON | Alternative | |
quantity (anyOf 1) (anyOf 1) | number | Alternative | The total quantity granted Format: double |
quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
quantity (anyOf 2) | null | Alternative | The total quantity granted Format: double |
reference_id | JSON | Optional | |
reference_id (anyOf 1) | JSON | Alternative | |
reference_id (anyOf 1) (anyOf 1) | number | Alternative | The human-readable reference number of the grant Format: double |
reference_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
reference_id (anyOf 2) | null | Alternative | The human-readable reference number of the grant Format: double |
source | JSON | Optional | |
source (anyOf 1) | string | Alternative | The system of record the grant originated from |
source (anyOf 2) | null | Alternative | The system of record the grant originated from |
tax_events | array | Optional | The tax events reported against this grant |
tax_events[] | Model | Each item | Expand List equity grants with tax events — 200 response body — data item tax events item |
tranches | JSON | Optional | |
tranches (anyOf 1) | JSON | Alternative | |
tranches (anyOf 1) (anyOf 1) | number | Alternative | The number of vesting tranches Format: double |
tranches (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
tranches (anyOf 2) | null | Alternative | The number of vesting tranches Format: double |
value | JSON | Optional | |
value (anyOf 1) | JSON | Alternative | |
value (anyOf 1) (anyOf 1) | number | Alternative | The total grant value at the time of issuance, in grant currency Format: double |
value (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
value (anyOf 2) | null | Alternative | The total grant value at the time of issuance, in grant currency Format: double |
vested_events | array | Optional | The individual vesting events recorded for this grant |
vested_events[] | Model | Each item | Expand List equity grants with tax events — 200 response body — data item vested events item |
vested_quantity | JSON | Optional | |
vested_quantity (anyOf 1) | JSON | Alternative | |
vested_quantity (anyOf 1) (anyOf 1) | number | Alternative | The quantity vested so far Format: double |
vested_quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
vested_quantity (anyOf 2) | null | Alternative | The quantity vested so far Format: double |
vesting_length | JSON | Optional | |
vesting_length (anyOf 1) | JSON | Alternative | |
vesting_length (anyOf 1) (anyOf 1) | number | Alternative | The total vesting length in months Format: double |
vesting_length (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
vesting_length (anyOf 2) | null | Alternative | The total vesting length in months Format: double |
vesting_start_date | JSON | Optional | |
vesting_start_date (anyOf 1) | string | Alternative | The date vesting begins Format: date |
vesting_start_date (anyOf 2) | null | Alternative | The 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
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}