Skip to content

Deel: List Shareworks equity exercises

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

← Equity tokens operations · Get started

Operation deel.equitytokens_listequityshareworksexercises_v2026_09_09

Provider route: GET /equity-exercises. 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"]["listEquityShareworksExercises"]>[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.listEquityShareworksExercises(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_shareworks_exercises(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.limitintegerOptionalDefault: 50
Maximum: 100
Minimum: 1
query.cursorstringOptionalMaximum length: 2048
query.exercise_date_fromstringOptionalFormat: date
query.exercise_date_tostringOptionalFormat: date
query.employee_numberstringOptionalMaximum length: 64

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List Shareworks equity exercises — 200 response body

Referenced models: List Shareworks equity exercises — 200 response body

List Shareworks equity exercises — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of exercise records. Worker name fields are deliberately not included — employee_number is the intended join key, and first/last name are SENSITIVE PII not needed by downstream consumers of this endpoint.
data[]ModelEach itemExpand List Shareworks equity exercises — 200 response body — data item
has_morebooleanRequired within parentWhether another page of results is available.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor for the next page. Null when has_more is false.
next_cursor (anyOf 2)nullAlternativeCursor for the next page. Null when has_more is false.

Referenced models: List Shareworks equity exercises — 200 response body — data item

List Shareworks equity exercises — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
cost_of_optionsJSONOptional
cost_of_options (anyOf 1)JSONAlternative
cost_of_options (anyOf 1) (anyOf 1)numberAlternativeTotal cost paid to exercise the options.
Format: double
cost_of_options (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
cost_of_options (anyOf 2)nullAlternativeTotal cost paid to exercise the options.
Format: double
currencystringOptionalISO 4217 currency code for the monetary fields on this record.
employee_grant_numberstringOptionalShareworks grant number for this employee.
employee_numberstringOptionalShareworks employee number, as reported by the ingested file. The intended join key for this record.
exercise_datestringOptionalDate the exercise took place.
Format: date
exercise_fmvJSONOptional
exercise_fmv (anyOf 1)JSONAlternative
exercise_fmv (anyOf 1) (anyOf 1)numberAlternativeTotal fair market value of the exercised shares.
Format: double
exercise_fmv (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
exercise_fmv (anyOf 2)nullAlternativeTotal fair market value of the exercised shares.
Format: double
exercise_gainJSONOptional
exercise_gain (anyOf 1)JSONAlternative
exercise_gain (anyOf 1) (anyOf 1)numberAlternativeGain realized on exercise (FMV minus cost).
Format: double
exercise_gain (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
exercise_gain (anyOf 2)nullAlternativeGain realized on exercise (FMV minus cost).
Format: double
exercise_priceJSONOptional
exercise_price (anyOf 1)JSONAlternative
exercise_price (anyOf 1) (anyOf 1)numberAlternativeStrike/exercise price per unit.
Format: double
exercise_price (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
exercise_price (anyOf 2)nullAlternativeStrike/exercise price per unit.
Format: double
fmv_per_unitJSONOptional
fmv_per_unit (anyOf 1)JSONAlternative
fmv_per_unit (anyOf 1) (anyOf 1)numberAlternativeFair market value per unit at exercise.
Format: double
fmv_per_unit (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fmv_per_unit (anyOf 2)nullAlternativeFair market value per unit at exercise.
Format: double
grant_dateJSONOptional
grant_date (anyOf 1)stringAlternativeDate the grant was issued.
Format: date
grant_date (anyOf 2)nullAlternativeDate the grant was issued.
Format: date
grant_nameJSONOptional
grant_name (anyOf 1)stringAlternativeGrant name, as reported by the ingested file.
grant_name (anyOf 2)nullAlternativeGrant name, as reported by the ingested file.
grant_typeJSONOptional
grant_type (anyOf 1)stringAlternativeGrant type (e.g. ISO, NSO, RSU), as reported by the ingested file.
grant_type (anyOf 2)nullAlternativeGrant type (e.g. ISO, NSO, RSU), as reported by the ingested file.
hris_profile_idJSONOptional
hris_profile_id (anyOf 1)JSONAlternative
hris_profile_id (anyOf 1) (anyOf 1)integerAlternativeMatched HRIS profile id, if employee_number could be resolved to one. Null when unmatched.
hris_profile_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hris_profile_id (anyOf 2)nullAlternativeMatched HRIS profile id, if employee_number could be resolved to one. Null when unmatched.
idstringOptionalThe unique identifier of the exercise record.
Format: uuid
plan_nameJSONOptional
plan_name (anyOf 1)stringAlternativeEquity plan name, as reported by the ingested file.
plan_name (anyOf 2)nullAlternativeEquity plan name, as reported by the ingested file.
shares_exercised_totalJSONOptional
shares_exercised_total (anyOf 1)JSONAlternative
shares_exercised_total (anyOf 1) (anyOf 1)numberAlternativeTotal number of shares exercised.
Format: double
shares_exercised_total (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
shares_exercised_total (anyOf 2)nullAlternativeTotal number of shares exercised.
Format: double
shares_exercised_unvestedJSONOptional
shares_exercised_unvested (anyOf 1)JSONAlternative
shares_exercised_unvested (anyOf 1) (anyOf 1)numberAlternativeNumber of unvested shares exercised.
Format: double
shares_exercised_unvested (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
shares_exercised_unvested (anyOf 2)nullAlternativeNumber of unvested shares exercised.
Format: double
shares_exercised_vestedJSONOptional
shares_exercised_vested (anyOf 1)JSONAlternative
shares_exercised_vested (anyOf 1) (anyOf 1)numberAlternativeNumber of vested shares exercised.
Format: double
shares_exercised_vested (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
shares_exercised_vested (anyOf 2)nullAlternativeNumber of vested shares exercised.
Format: double
updated_atstringOptionalTimestamp this record was last upserted, for incremental sync.
Format: date-time

SDK function policy ID: deel.equitytokens_listequityshareworksexercises_v2026_09_09. Catalog operation: equitytokens_listequityshareworksexercises_v2026_09_09. 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-09-09"}

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.