Deel: List equity awards granted — 200 response body — data item
List equity awards granted: 200 response body, field data / item. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: List equity awards granted — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allow_early_exercise | JSON | Required within parent | |
allow_early_exercise (anyOf 1) | string | Alternative | Whether early exercise is allowed, as reported by the ingested file (verbatim text, e.g. Yes/No). |
allow_early_exercise (anyOf 2) | null | Alternative | Whether early exercise is allowed, as reported by the ingested file (verbatim text, e.g. Yes/No). |
award_name | JSON | Required within parent | |
award_name (anyOf 1) | string | Alternative | Award template name, as reported by the ingested file. |
award_name (anyOf 2) | null | Alternative | Award template name, as reported by the ingested file. |
compensation_benefit | JSON | Required within parent | |
compensation_benefit (anyOf 1) | JSON | Alternative | |
compensation_benefit (anyOf 1) (anyOf 1) | number | Alternative | Compensation benefit amount, as reported by the ingested file. Format: double |
compensation_benefit (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
compensation_benefit (anyOf 2) | null | Alternative | Compensation benefit amount, as reported by the ingested file. Format: double |
created_at | string | Required within parent | Timestamp this record was first ingested. Format: date-time |
employee_number | string | Required within parent | Shareworks employee number, as reported by the ingested file. The intended join key for this record. Some values are non-numeric for legacy or masked records. |
employee_type | JSON | Required within parent | |
employee_type (anyOf 1) | string | Alternative | Employee type (e.g. Employee, Consultant), as reported by the ingested file. |
employee_type (anyOf 2) | null | Alternative | Employee type (e.g. Employee, Consultant), as reported by the ingested file. |
federal_exemption | JSON | Required within parent | |
federal_exemption (anyOf 1) | string | Alternative | Federal exemption, as reported by the ingested file. |
federal_exemption (anyOf 2) | null | Alternative | Federal exemption, as reported by the ingested file. |
federal_exemption_date | JSON | Required within parent | |
federal_exemption_date (anyOf 1) | string | Alternative | Federal exemption date, as reported by the ingested file. |
federal_exemption_date (anyOf 2) | null | Alternative | Federal exemption date, as reported by the ingested file. |
first_name | JSON | Required within parent | |
first_name (anyOf 1) | string | Alternative | Employee first name, as reported by the ingested file. |
first_name (anyOf 2) | null | Alternative | Employee first name, as reported by the ingested file. |
fmv_per_share_at_grant_date | JSON | Required within parent | |
fmv_per_share_at_grant_date (anyOf 1) | JSON | Alternative | |
fmv_per_share_at_grant_date (anyOf 1) (anyOf 1) | number | Alternative | Fair market value per share at grant date, as reported by the ingested file. Format: double |
fmv_per_share_at_grant_date (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
fmv_per_share_at_grant_date (anyOf 2) | null | Alternative | Fair market value per share at grant date, as reported by the ingested file. Format: double |
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) | JSON | Alternative | |
grant_price (anyOf 1) (anyOf 1) | number | Alternative | Strike/grant price per unit, as reported by the ingested file. Format: double |
grant_price (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
grant_price (anyOf 2) | null | Alternative | Strike/grant price per unit, as reported by the ingested file. Format: double |
grant_quantity | JSON | Required within parent | |
grant_quantity (anyOf 1) | JSON | Alternative | |
grant_quantity (anyOf 1) (anyOf 1) | number | Alternative | Number of shares/units granted, as reported by the ingested file. Format: double |
grant_quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
grant_quantity (anyOf 2) | null | Alternative | Number of shares/units granted, as reported by the ingested file. Format: double |
hris_profile_id | JSON | Required within parent | |
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, or when employee_number is non-numeric or blank. |
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, or when employee_number is non-numeric or blank. |
id | string | Required within parent | The unique identifier of the record. Format: uuid |
is_under_rule_701 | JSON | Required within parent | |
is_under_rule_701 (anyOf 1) | string | Alternative | Whether the grant is under Rule 701, as reported by the ingested file (verbatim text, e.g. Yes/No). |
is_under_rule_701 (anyOf 2) | null | Alternative | Whether the grant is under Rule 701, as reported by the ingested file (verbatim text, e.g. Yes/No). |
last_name | JSON | Required within parent | |
last_name (anyOf 1) | string | Alternative | Employee last name, as reported by the ingested file. |
last_name (anyOf 2) | null | Alternative | Employee last name, as reported by the ingested file. |
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 |
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]+)?$ |
plan_name | JSON | Required within parent | |
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. |
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 |
state_exemption | JSON | Required within parent | |
state_exemption (anyOf 1) | string | Alternative | State exemption, as reported by the ingested file. |
state_exemption (anyOf 2) | null | Alternative | State exemption, as reported by the ingested file. |
state_exemption_date | JSON | Required within parent | |
state_exemption_date (anyOf 1) | string | Alternative | State exemption date, as reported by the ingested file. |
state_exemption_date (anyOf 2) | null | Alternative | State exemption date, as reported by the ingested file. |
state_of_exemption | JSON | Required within parent | |
state_of_exemption (anyOf 1) | string | Alternative | State of exemption, as reported by the ingested file. |
state_of_exemption (anyOf 2) | null | Alternative | State of exemption, as reported by the ingested file. |
total_exercise_price | JSON | Required within parent | |
total_exercise_price (anyOf 1) | JSON | Alternative | |
total_exercise_price (anyOf 1) (anyOf 1) | number | Alternative | Total exercise price for the grant, as reported by the ingested file. Format: double |
total_exercise_price (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_exercise_price (anyOf 2) | null | Alternative | Total exercise price for the grant, as reported by the ingested file. Format: double |
total_fmv | JSON | Required within parent | |
total_fmv (anyOf 1) | JSON | Alternative | |
total_fmv (anyOf 1) (anyOf 1) | number | Alternative | Total fair market value of the grant, as reported by the ingested file. Format: double |
total_fmv (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_fmv (anyOf 2) | null | Alternative | Total fair market value of the grant, as reported by the ingested file. Format: double |
updated_at | string | Required within parent | Timestamp this record was last upserted, for incremental sync. Format: date-time |
vest_schedule_name | JSON | Required within parent | |
vest_schedule_name (anyOf 1) | string | Alternative | Vesting schedule name, as reported by the ingested file. |
vest_schedule_name (anyOf 2) | null | Alternative | Vesting schedule name, as reported by the ingested file. |
vesting_start_date | JSON | Required within parent | |
vesting_start_date (anyOf 1) | string | Alternative | Vesting start date, as reported by the ingested file. Format: date |
vesting_start_date (anyOf 2) | null | Alternative | Vesting start date, as reported by the ingested file. Format: date |