List equity option ledger entries

GET

/equity-option-ledger

GET

/rest/equity-option-ledger

$ curl -G https://api.letsdeel.com/rest/equity-option-ledger \
>      -H "Authorization: Bearer <token>" \
>      -d limit=50 \
>      -d cursor=eyJzb3J0VmFsdWUiOiI5MDAxIiwiaWQiOiJhMWIyYzNkNC1lNWY2LTc4OTAtYWJjZC1lZjEyMzQ1Njc4OTAifQ \
>      -d employee_number=9001 \
>      -d employee_grant_number=ES-0001 \
>      -d grant_date_from=2026-01-01 \
>      -d grant_date_to=2026-12-31

1 {
2   "data": [
3     {
4       "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
5       "notes": "Amended per board approval",
6       "row_hash": "9f2c1a7e4b6d8f0a2c4e6b8d0f2a4c6e8b0d2f4a6c8e0b2d4f6a8c0e2b4d6f8a",
7       "last_name": "Doe",
8       "plan_name": "2020 Stock Plan",
9       "total_fmv": 4.7,
10       "created_at": "2026-08-13T09:01:02.000Z",
11       "first_name": "Jane",
12       "grant_date": "2022-06-18",
13       "grant_name": "06/18/2022 - NQSO - $4.7",
14       "grant_type": "Options (NQ)",
15       "updated_at": "2026-08-13T09:01:02.000Z",
16       "expire_date": "2022-06-18",
17       "middle_name": "Quinn",
18       "grant_reason": "New Hire",
19       "shares_expired": 1000,
20       "source_file_id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
21       "tax_identifier": "123-45-6789",
22       "employee_number": "9001",
23       "hris_profile_id": 4821,
24       "state_exemption": "Rule 701",
25       "occurrence_index": 1,
26       "shares_cancelled": 1000,
27       "vesting_schedule": "4 Year Monthly",
28       "federal_exemption": "Rule 701",
29       "is_under_rule_701": "Yes",
30       "outstanding_vested": 1000,
31       "shares_outstanding": 1000,
32       "shares_repurchased": 1000,
33       "vesting_start_date": "2022-06-18",
34       "no_of_shares_vested": 1000,
35       "compensation_benefit": 4700,
36       "last_seen_dataset_id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
37       "no_of_shares_granted": 1000,
38       "outstanding_unvested": 1000,
39       "total_exercise_price": 4.7,
40       "employee_grant_number": "ES-0001",
41       "no_of_shares_unvested": 1000,
42       "preferred_share_price": 4.7,
43       "early_exercise_allowed": "Yes",
44       "formatted_home_address": "1 Example Street",
45       "outstanding_exercisable": 1000,
46       "exercise_price_per_share": 4.7,
47       "shares_exercised_released": 1000,
48       "carta_grant_acceptance_date": "2022-06-18",
49       "fmv_per_share_at_grant_date": 4.7,
50       "split_employee_grant_number": "ES-0001",
51       "shares_subject_to_repurchase": 1000,
52       "grant_agreement_template_name": "Reported value",
53       "iso_csop_disqualification_date": "2022-06-18",
54       "section_102_disqualification_date": "2022-06-18",
55       "shareworks_grant_agreement_print_instant": "2022-06-20 10:15:00",
56       "stock_options_and_awards_employee_status": "Active",
57       "shareworks_grant_agreement_agreement_date": "2022-06-18",
58       "stock_options_and_awards_employee_status_effective_date": "2022-06-18"
59     }
60   ],
61   "has_more": false,
62   "next_cursor": "eyJzb3J0VmFsdWUiOiI5MDAxIiwiaWQiOiJhMWIyYzNkNC1lNWY2LTc4OTAtYWJjZC1lZjEyMzQ1Njc4OTAifQ=="
63 }

Retrieves the full option holder ledger for an organization, as ingested from Shareworks, in ascending employee_grant_number order. Use it as the per-grant system of record: it carries the vested, unvested, exercised, cancelled, expired and outstanding share counts for every grant, plus grant agreement and disqualification dates. Records carry direct identifiers, including a tax identifier and a home address. Requires the equities.view permission at the organization level.

Token scopes: equities:read

Retrieves the full option holder ledger for an organization, as ingested from Shareworks, in ascending employee_grant_number order. Use it as the per-grant system of record: it carries the vested, unvested, exercised, cancelled, expired and outstanding share counts for every grant, plus grant agreement and disqualification dates. Records carry direct identifiers, including a tax identifier and a home address. Requires the `equities.view` permission at the organization level. **Token scopes**: `equities:read`

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

$ curl -X GET 'https://api.deel.training/rest/v2/contracts' \
>   -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

## Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail. ```curl curl -X GET 'https://api.deel.training/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Query parameters

limitintegerOptional1-100Defaults to 50

Maximum number of records to return in this page.

cursorstringOptional<=2048 characters

Opaque pagination cursor returned as next_cursor by a previous response. Omit to fetch the first page.

employee_numberstringOptional<=64 characters

Only return records for this exact Shareworks employee number.

employee_grant_numberstringOptional<=100 characters

Only return records for this exact Shareworks grant number.

grant_date_fromstringOptionalformat: "date"

Only return records with a grant_date on or after this date (inclusive), in YYYY-MM-DD format.

grant_date_tostringOptionalformat: "date"

Only return records with a grant_date on or before this date (inclusive), in YYYY-MM-DD format.

Response

List equity option ledger entries returned successfully.

datalist of objects

Page of option holder ledger records, one per grant occurrence.

has_moreboolean

Whether another page of results is available.

next_cursorstring or null

Cursor for the next page. Null when has_more is false.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

$	curl -X GET 'https://api.deel.training/rest/v2/contracts' \
>	-H 'Authorization: Bearer YOUR-TOKEN-HERE'