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.
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"]["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 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_shareworks_exercises(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: 50 Maximum: 100 Minimum: 1 |
query.cursor | string | Optional | Maximum length: 2048 |
query.exercise_date_from | string | Optional | Format: date |
query.exercise_date_to | string | Optional | Format: date |
query.employee_number | string | Optional | Maximum length: 64 |
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 Shareworks equity exercises — 200 response body |
Referenced models: List Shareworks equity exercises — 200 response body
Schemas
Section titled “Schemas”List Shareworks equity exercises — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Page 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[] | Model | Each item | Expand List Shareworks equity exercises — 200 response body — data item |
has_more | boolean | Required within parent | Whether another page of results is available. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor for the next page. Null when has_more is false. |
next_cursor (anyOf 2) | null | Alternative | Cursor 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cost_of_options | JSON | Optional | |
cost_of_options (anyOf 1) | JSON | Alternative | |
cost_of_options (anyOf 1) (anyOf 1) | number | Alternative | Total cost paid to exercise the options. Format: double |
cost_of_options (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
cost_of_options (anyOf 2) | null | Alternative | Total cost paid to exercise the options. Format: double |
currency | string | Optional | ISO 4217 currency code for the monetary fields on this record. |
employee_grant_number | string | Optional | Shareworks grant number for this employee. |
employee_number | string | Optional | Shareworks employee number, as reported by the ingested file. The intended join key for this record. |
exercise_date | string | Optional | Date the exercise took place. Format: date |
exercise_fmv | JSON | Optional | |
exercise_fmv (anyOf 1) | JSON | Alternative | |
exercise_fmv (anyOf 1) (anyOf 1) | number | Alternative | Total fair market value of the exercised shares. Format: double |
exercise_fmv (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
exercise_fmv (anyOf 2) | null | Alternative | Total fair market value of the exercised shares. Format: double |
exercise_gain | JSON | Optional | |
exercise_gain (anyOf 1) | JSON | Alternative | |
exercise_gain (anyOf 1) (anyOf 1) | number | Alternative | Gain realized on exercise (FMV minus cost). Format: double |
exercise_gain (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
exercise_gain (anyOf 2) | null | Alternative | Gain realized on exercise (FMV minus cost). Format: double |
exercise_price | JSON | Optional | |
exercise_price (anyOf 1) | JSON | Alternative | |
exercise_price (anyOf 1) (anyOf 1) | number | Alternative | Strike/exercise price per unit. Format: double |
exercise_price (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
exercise_price (anyOf 2) | null | Alternative | Strike/exercise price per unit. Format: double |
fmv_per_unit | JSON | Optional | |
fmv_per_unit (anyOf 1) | JSON | Alternative | |
fmv_per_unit (anyOf 1) (anyOf 1) | number | Alternative | Fair market value per unit at exercise. Format: double |
fmv_per_unit (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
fmv_per_unit (anyOf 2) | null | Alternative | Fair market value per unit at exercise. Format: double |
grant_date | JSON | Optional | |
grant_date (anyOf 1) | string | Alternative | Date the grant was issued. Format: date |
grant_date (anyOf 2) | null | Alternative | Date the grant was issued. Format: date |
grant_name | JSON | Optional | |
grant_name (anyOf 1) | string | Alternative | Grant name, as reported by the ingested file. |
grant_name (anyOf 2) | null | Alternative | Grant name, as reported by the ingested file. |
grant_type | JSON | Optional | |
grant_type (anyOf 1) | string | Alternative | Grant type (e.g. ISO, NSO, RSU), as reported by the ingested file. |
grant_type (anyOf 2) | null | Alternative | Grant type (e.g. ISO, NSO, RSU), as reported by the ingested file. |
hris_profile_id | JSON | Optional | |
hris_profile_id (anyOf 1) | JSON | Alternative | |
hris_profile_id (anyOf 1) (anyOf 1) | integer | Alternative | Matched HRIS profile id, if employee_number could be resolved to one. Null when unmatched. |
hris_profile_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hris_profile_id (anyOf 2) | null | Alternative | Matched HRIS profile id, if employee_number could be resolved to one. Null when unmatched. |
id | string | Optional | The unique identifier of the exercise record. Format: uuid |
plan_name | JSON | Optional | |
plan_name (anyOf 1) | string | Alternative | Equity plan name, as reported by the ingested file. |
plan_name (anyOf 2) | null | Alternative | Equity plan name, as reported by the ingested file. |
shares_exercised_total | JSON | Optional | |
shares_exercised_total (anyOf 1) | JSON | Alternative | |
shares_exercised_total (anyOf 1) (anyOf 1) | number | Alternative | Total number of shares exercised. Format: double |
shares_exercised_total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
shares_exercised_total (anyOf 2) | null | Alternative | Total number of shares exercised. Format: double |
shares_exercised_unvested | JSON | Optional | |
shares_exercised_unvested (anyOf 1) | JSON | Alternative | |
shares_exercised_unvested (anyOf 1) (anyOf 1) | number | Alternative | Number of unvested shares exercised. Format: double |
shares_exercised_unvested (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
shares_exercised_unvested (anyOf 2) | null | Alternative | Number of unvested shares exercised. Format: double |
shares_exercised_vested | JSON | Optional | |
shares_exercised_vested (anyOf 1) | JSON | Alternative | |
shares_exercised_vested (anyOf 1) (anyOf 1) | number | Alternative | Number of vested shares exercised. Format: double |
shares_exercised_vested (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
shares_exercised_vested (anyOf 2) | null | Alternative | Number of vested shares exercised. Format: double |
updated_at | string | Optional | Timestamp this record was last upserted, for incremental sync. Format: date-time |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}