Deel: List equity grant valuations
Deel equityTokens.listEquityValuations: arguments, response, policy and SDK examples.
← Equity tokens operations · Get started
Operation deel.equitytokens_listequityvaluations_v2026_09_09
Provider route: GET /equity-valuations. 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"]["listEquityValuations"]>[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.listEquityValuations(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_valuations(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.employee_grant_number | string | Optional | Maximum length: 100 |
query.grant_date_from | string | Optional | Format: date |
query.grant_date_to | string | Optional | Format: date |
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 grant valuations — 200 response body |
Referenced models: List equity grant valuations — 200 response body
Schemas
Section titled “Schemas”List equity grant valuations — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Page of grant valuation records, one per grant occurrence. |
data[] | Model | Each item | Expand List equity grant valuations — 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 equity grant valuations — 200 response body — data item
List equity grant valuations — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amortization_method | string | Required within parent | Amortization method (e.g. Straight-Line), as reported by the ingested file. |
award_type | string | Required within parent | Award type (e.g. Restricted Stock - Standard), as reported by the ingested file. |
created_at | string | Required within parent | Timestamp this record was first ingested. Format: date-time |
dividend_yield_percent | JSON | Required within parent | |
dividend_yield_percent (anyOf 1) | JSON | Alternative | |
dividend_yield_percent (anyOf 1) (anyOf 1) | number | Alternative | Dividend yield, stored as the percent NUMBER itself, NOT a fraction. See parseShareworksPercent. Sparsely populated (measured: 14,353 of 15,090 real rows). Format: double |
dividend_yield_percent (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
dividend_yield_percent (anyOf 2) | null | Alternative | Dividend yield, stored as the percent NUMBER itself, NOT a fraction. See parseShareworksPercent. Sparsely populated (measured: 14,353 of 15,090 real rows). Format: double |
dividend_yield_type | JSON | Required within parent | |
dividend_yield_type (anyOf 1) | string | Alternative | Dividend yield type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows). |
dividend_yield_type (anyOf 2) | null | Alternative | Dividend yield type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows). |
employee_grant_number | string | Required within parent | Shareworks grant number for this employee, as reported by the ingested file. |
expected_life | JSON | Required within parent | |
expected_life (anyOf 1) | JSON | Alternative | |
expected_life (anyOf 1) (anyOf 1) | number | Alternative | Expected life of the award (years), as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows). Format: double |
expected_life (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
expected_life (anyOf 2) | null | Alternative | Expected life of the award (years), as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows). Format: double |
expected_life_type | JSON | Required within parent | |
expected_life_type (anyOf 1) | string | Alternative | Expected life type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows). |
expected_life_type (anyOf 2) | null | Alternative | Expected life type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows). |
expense_amortization_start_date | string | Required within parent | Expense amortization start date, as reported by the ingested file. Format: date |
expense_valuation_model | string | Required within parent | Expense valuation model (e.g. Black-Scholes), as reported by the ingested file. |
fair_value_per_share | JSON | Required within parent | |
fair_value_per_share (anyOf 1) | number | Alternative | Fair market value per share, as reported by the ingested file. Format: double |
fair_value_per_share (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
forfeiture_rate_calculation_method | string | Required within parent | Forfeiture rate calculation method, as reported by the ingested file. |
forfeiture_rate_percent | JSON | Required within parent | |
forfeiture_rate_percent (anyOf 1) | number | Alternative | Forfeiture rate, stored as the percent NUMBER itself (e.g. 5.25 means 5.25%), NOT a fraction. See parseShareworksPercent. Format: double |
forfeiture_rate_percent (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
grant_date | string | Required within parent | Date the grant was issued, as reported by the ingested file. Format: date |
grant_name | string | Required within parent | Grant name, as reported by the ingested file. |
grant_price | JSON | Required within parent | |
grant_price (anyOf 1) | number | Alternative | Strike/grant price per unit, as reported by the ingested file. Format: double |
grant_price (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Required within parent | The unique identifier of the record. Format: uuid |
last_seen_dataset_id | JSON | Required within parent | |
last_seen_dataset_id (anyOf 1) | string | Alternative | Identifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began. Format: uuid |
last_seen_dataset_id (anyOf 2) | null | Alternative | Identifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began. Format: uuid |
market_price | JSON | Required within parent | |
market_price (anyOf 1) | number | Alternative | Market price per unit, as reported by the ingested file. Format: double |
market_price (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
occurrence_index | JSON | Required within parent | |
occurrence_index (anyOf 1) | integer | Alternative | Discriminates several records the source file reports for the same natural key. Starts at 1, in the order the rows appear in the file. |
occurrence_index (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
original_granted | JSON | Required within parent | |
original_granted (anyOf 1) | number | Alternative | Original granted share count, as reported by the ingested file. Format: double |
original_granted (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
original_performance_rule | JSON | Required within parent | |
original_performance_rule (anyOf 1) | string | Alternative | Original performance rule, as reported by the ingested file. Sparsely populated (measured: 25 of 15,090 real rows). |
original_performance_rule (anyOf 2) | null | Alternative | Original performance rule, as reported by the ingested file. Sparsely populated (measured: 25 of 15,090 real rows). |
original_vest_date | JSON | Required within parent | |
original_vest_date (anyOf 1) | string | Alternative | Original vest date, as reported by the ingested file. Sparsely populated (measured: 4,477 of 15,090 real rows) - deliberately NOT part of the uniqueness key, since a Null value would not conflict with another Null under Postgres unique-constraint semantics. Format: date |
original_vest_date (anyOf 2) | null | Alternative | Original vest date, as reported by the ingested file. Sparsely populated (measured: 4,477 of 15,090 real rows) - deliberately NOT part of the uniqueness key, since a Null value would not conflict with another Null under Postgres unique-constraint semantics. Format: date |
plan_name | string | Required within parent | Equity plan name, as reported by the ingested file. |
risk_free_rate_percent | JSON | Required within parent | |
risk_free_rate_percent (anyOf 1) | JSON | Alternative | |
risk_free_rate_percent (anyOf 1) (anyOf 1) | number | Alternative | Risk-free rate, stored as the percent NUMBER itself, NOT a fraction. See parseShareworksPercent. Sparsely populated (measured: 14,353 of 15,090 real rows). Format: double |
risk_free_rate_percent (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
risk_free_rate_percent (anyOf 2) | null | Alternative | Risk-free rate, stored as the percent NUMBER itself, NOT a fraction. See parseShareworksPercent. Sparsely populated (measured: 14,353 of 15,090 real rows). Format: double |
risk_free_rate_source | JSON | Required within parent | |
risk_free_rate_source (anyOf 1) | string | Alternative | Risk-free rate source, as reported by the ingested file. Sparsely populated (measured: 8,308 of 15,090 real rows). |
risk_free_rate_source (anyOf 2) | null | Alternative | Risk-free rate source, as reported by the ingested file. Sparsely populated (measured: 8,308 of 15,090 real rows). |
risk_free_rate_type | JSON | Required within parent | |
risk_free_rate_type (anyOf 1) | string | Alternative | Risk-free rate type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows). |
risk_free_rate_type (anyOf 2) | null | Alternative | Risk-free rate type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows). |
row_hash | string | Required within parent | Hash of the reported values on this record. Compare it between syncs to detect a change without diffing every field. |
source_file_id | string | Required within parent | Identifier of the ingested Shareworks report file this record was last upserted from. Format: uuid |
updated_at | string | Required within parent | Timestamp this record was last upserted, for incremental sync. Format: date-time |
valuation_type | string | Required within parent | Valuation type, as reported by the ingested file. |
volatility_percent | JSON | Required within parent | |
volatility_percent (anyOf 1) | JSON | Alternative | |
volatility_percent (anyOf 1) (anyOf 1) | number | Alternative | Volatility, stored as the percent NUMBER itself, NOT a fraction. See parseShareworksPercent. Sparsely populated (measured: 14,353 of 15,090 real rows). Format: double |
volatility_percent (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
volatility_percent (anyOf 2) | null | Alternative | Volatility, stored as the percent NUMBER itself, NOT a fraction. See parseShareworksPercent. Sparsely populated (measured: 14,353 of 15,090 real rows). Format: double |
volatility_type | JSON | Required within parent | |
volatility_type (anyOf 1) | string | Alternative | Volatility type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows). |
volatility_type (anyOf 2) | null | Alternative | Volatility type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows). |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.equitytokens_listequityvaluations_v2026_09_09. Catalog operation: equitytokens_listequityvaluations_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"}