> This page is for API, version 2026-01-01 (Stable) (default).
> For other versions, use one of these documentation indexes:
> - 2026-01-01 (Stable) (default): https://developer.deel.com/api/stable/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.deel.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.deel.com/_mcp/server.

# List equity option ledger entries

GET https://api.letsdeel.com/rest/equity-option-ledger

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`

Reference: https://developer.deel.com/api/reference/endpoints/equity-tokens/list-equity-option-ledger-entries-v-2026-09-09

## Authentication

- `Authorization` header (bearer token, required) — ## 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.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)
- `Authorization` header (bearer token, required) — Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

## Servers

- `https://api.letsdeel.com/rest` (Production, default)
- `https://api-staging.letsdeel.com/rest` (Demo)

## Request

### Query parameters

- `limit` (integer, optional, default: 50) — Maximum number of records to return in this page.
- `cursor` (string, optional) — Opaque pagination cursor returned as next_cursor by a previous response. Omit to fetch the first page.
- `employee_number` (string, optional) — Only return records for this exact Shareworks employee number.
- `employee_grant_number` (string, optional) — Only return records for this exact Shareworks grant number.
- `grant_date_from` (string, optional) — Only return records with a grant_date on or after this date (inclusive), in YYYY-MM-DD format.
- `grant_date_to` (string, optional) — Only return records with a grant_date on or before this date (inclusive), in YYYY-MM-DD format.

## Response

### 200

List equity option ledger entries returned successfully.

- `data` (list of EquityOptionLedgerGetResponsesContentApplicationJsonSchemaDataItems, required) — Page of option holder ledger records, one per grant occurrence.
- `has_more` (boolean, required) — Whether another page of results is available.
- `next_cursor` (string, required, nullable) — Cursor for the next page. Null when has_more is false.

## Errors

### 400 Bad Request Error

Bad request — invalid or missing parameters.

- `errors` (list of EquityOptionLedgerGetResponsesContentApplicationJsonSchemaErrorsItems, required) — List of errors that occurred while processing the request.

### 401 Unauthorized Error

Unauthorized — missing or invalid authentication token.

- `errors` (list of EquityOptionLedgerGetResponsesContentApplicationJsonSchemaErrorsItems, required) — List of errors that occurred while processing the request.

### 403 Forbidden Error

Forbidden — caller lacks the equities.view permission, or the caller's organization is not permitted to access this endpoint.

- `errors` (list of EquityOptionLedgerGetResponsesContentApplicationJsonSchemaErrorsItems, required) — List of errors that occurred while processing the request.

### 404 Not Found Error

Not found — the requested resource does not exist.

- `errors` (list of EquityOptionLedgerGetResponsesContentApplicationJsonSchemaErrorsItems, required) — List of errors that occurred while processing the request.

### 500 Internal Server Error

Internal server error.

- `errors` (list of EquityOptionLedgerGetResponsesContentApplicationJsonSchemaErrorsItems, required) — List of errors that occurred while processing the request.

## Types

### EquityOptionLedgerGetResponsesContentApplicationJsonSchemaDataItems

- `id` (string, required) — The unique identifier of the record.
- `notes` (string, required, nullable) — Free-form notes, as reported by the ingested file.
- `row_hash` (string, required) — Hash of the reported values on this record. Compare it between syncs to detect a change without diffing every field.
- `last_name` (string, required, nullable) — Employee last name, as reported by the ingested file.
- `plan_name` (string, required, nullable) — Equity plan name, as reported by the ingested file.
- `total_fmv` (double, required, nullable) — Total fair market value of the grant, as reported by the ingested file.
- `created_at` (string, required) — Timestamp this record was first ingested.
- `first_name` (string, required, nullable) — Employee first name, as reported by the ingested file.
- `grant_date` (string, required, nullable) — Date the grant was issued, as reported by the ingested file.
- `grant_name` (string, required, nullable) — Grant name, as reported by the ingested file.
- `grant_type` (string, required, nullable) — Grant type (e.g. Options (NQ)), as reported by the ingested file.
- `updated_at` (string, required) — Timestamp this record was last upserted, for incremental sync.
- `expire_date` (string, required, nullable) — Grant expiration date, as reported by the ingested file.
- `middle_name` (string, required, nullable) — Employee middle name, as reported by the ingested file.
- `grant_reason` (string, required, nullable) — Grant reason, as reported by the ingested file.
- `shares_expired` (double, required, nullable) — Shares expired, as reported by the ingested file.
- `source_file_id` (string, required) — Identifier of the ingested Shareworks report file this record was last upserted from.
- `tax_identifier` (string, required, nullable) — Tax identifier, as reported by the ingested file.
- `employee_number` (string, required, nullable) — 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.
- `hris_profile_id` (integer, required, nullable) — Matched HRIS profile id, if employee_number could be resolved to one. Null when unmatched, or when employee_number is non-numeric or blank.
- `state_exemption` (string, required, nullable) — State exemption, as reported by the ingested file.
- `occurrence_index` (integer, required) — Discriminates several records the source file reports for the same natural key. Starts at 1, in the order the rows appear in the file.
- `shares_cancelled` (double, required, nullable) — Shares cancelled, as reported by the ingested file.
- `vesting_schedule` (string, required, nullable) — Vesting schedule name, as reported by the ingested file.
- `federal_exemption` (string, required, nullable) — Federal exemption, as reported by the ingested file.
- `is_under_rule_701` (string, required, nullable) — Whether the grant is under Rule 701, as reported by the ingested file (verbatim text, e.g. Yes/No).
- `outstanding_vested` (double, required, nullable) — Outstanding vested shares, as reported by the ingested file.
- `shares_outstanding` (double, required, nullable) — Shares outstanding, as reported by the ingested file.
- `shares_repurchased` (double, required, nullable) — Shares repurchased, as reported by the ingested file.
- `vesting_start_date` (string, required, nullable) — Vesting start date, as reported by the ingested file.
- `no_of_shares_vested` (double, required, nullable) — Number of shares vested, as reported by the ingested file.
- `compensation_benefit` (double, required, nullable) — Compensation benefit amount, as reported by the ingested file.
- `last_seen_dataset_id` (string, required, nullable) — Identifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began.
- `no_of_shares_granted` (double, required, nullable) — Number of shares/units granted, as reported by the ingested file.
- `outstanding_unvested` (double, required, nullable) — Outstanding unvested shares, as reported by the ingested file.
- `total_exercise_price` (double, required, nullable) — Total exercise price for the grant, as reported by the ingested file.
- `employee_grant_number` (string, required) — Shareworks grant number for this employee, as reported by the ingested file.
- `no_of_shares_unvested` (double, required, nullable) — Number of shares unvested, as reported by the ingested file.
- `preferred_share_price` (double, required, nullable) — Preferred share price, as reported by the ingested file.
- `early_exercise_allowed` (string, required, nullable) — Whether early exercise is allowed, as reported by the ingested file (verbatim text, e.g. Yes/No).
- `formatted_home_address` (string, required, nullable) — Formatted home address, as reported by the ingested file.
- `outstanding_exercisable` (double, required, nullable) — Outstanding exercisable shares, as reported by the ingested file.
- `exercise_price_per_share` (double, required, nullable) — Exercise price per share, as reported by the ingested file.
- `shares_exercised_released` (double, required, nullable) — Shares exercised/released, as reported by the ingested file.
- `carta_grant_acceptance_date` (string, required, nullable) — Carta - Grant Acceptance Date, as reported by the ingested file.
- `fmv_per_share_at_grant_date` (double, required, nullable) — Fair market value per share at grant date, as reported by the ingested file.
- `split_employee_grant_number` (string, required, nullable) — Split Employee Grant Number, as reported by the ingested file.
- `shares_subject_to_repurchase` (double, required, nullable) — Shares subject to repurchase, as reported by the ingested file.
- `grant_agreement_template_name` (string, required, nullable) — Grant agreement template name, as reported by the ingested file.
- `iso_csop_disqualification_date` (string, required, nullable) — ISO/CSOP disqualification date, as reported by the ingested file.
- `section_102_disqualification_date` (string, required, nullable) — "102 Disqualification date" in the source file (Section 102 of the Israeli tax ordinance).
- `shareworks_grant_agreement_print_instant` (string, required, nullable) — Shareworks - Grant Agreement - Print Instant, as reported by the ingested file.
- `stock_options_and_awards_employee_status` (string, required, nullable) — Stock Options and Awards Employee Status, as reported by the ingested file.
- `shareworks_grant_agreement_agreement_date` (string, required, nullable) — Shareworks - Grant Agreement - Agreement Date, as reported by the ingested file.
- `stock_options_and_awards_employee_status_effective_date` (string, required, nullable) — Stock Options and Awards Employee Status (Effective Date), as reported by the ingested file.

### EquityOptionLedgerGetResponsesContentApplicationJsonSchemaErrorsItems

- `message` (string, required) — Human-readable explanation
- `code` (string, optional) — Machine-readable error code
- `field` (string, optional, nullable) — Field that caused the error, if applicable.

## Examples

**Response**

```json
{
  "data": [
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
      "notes": "Amended per board approval",
      "row_hash": "9f2c1a7e4b6d8f0a2c4e6b8d0f2a4c6e8b0d2f4a6c8e0b2d4f6a8c0e2b4d6f8a",
      "last_name": "Doe",
      "plan_name": "2020 Stock Plan",
      "total_fmv": 4.7,
      "created_at": "2026-08-13T09:01:02.000Z",
      "first_name": "Jane",
      "grant_date": "2022-06-18",
      "grant_name": "06/18/2022 - NQSO - $4.7",
      "grant_type": "Options (NQ)",
      "updated_at": "2026-08-13T09:01:02.000Z",
      "expire_date": "2022-06-18",
      "middle_name": "Quinn",
      "grant_reason": "New Hire",
      "shares_expired": 1000,
      "source_file_id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
      "tax_identifier": "123-45-6789",
      "employee_number": "9001",
      "hris_profile_id": 4821,
      "state_exemption": "Rule 701",
      "occurrence_index": 1,
      "shares_cancelled": 1000,
      "vesting_schedule": "4 Year Monthly",
      "federal_exemption": "Rule 701",
      "is_under_rule_701": "Yes",
      "outstanding_vested": 1000,
      "shares_outstanding": 1000,
      "shares_repurchased": 1000,
      "vesting_start_date": "2022-06-18",
      "no_of_shares_vested": 1000,
      "compensation_benefit": 4700,
      "last_seen_dataset_id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
      "no_of_shares_granted": 1000,
      "outstanding_unvested": 1000,
      "total_exercise_price": 4.7,
      "employee_grant_number": "ES-0001",
      "no_of_shares_unvested": 1000,
      "preferred_share_price": 4.7,
      "early_exercise_allowed": "Yes",
      "formatted_home_address": "1 Example Street",
      "outstanding_exercisable": 1000,
      "exercise_price_per_share": 4.7,
      "shares_exercised_released": 1000,
      "carta_grant_acceptance_date": "2022-06-18",
      "fmv_per_share_at_grant_date": 4.7,
      "split_employee_grant_number": "ES-0001",
      "shares_subject_to_repurchase": 1000,
      "grant_agreement_template_name": "Reported value",
      "iso_csop_disqualification_date": "2022-06-18",
      "section_102_disqualification_date": "2022-06-18",
      "shareworks_grant_agreement_print_instant": "2022-06-20 10:15:00",
      "stock_options_and_awards_employee_status": "Active",
      "shareworks_grant_agreement_agreement_date": "2022-06-18",
      "stock_options_and_awards_employee_status_effective_date": "2022-06-18"
    }
  ],
  "has_more": false,
  "next_cursor": "eyJzb3J0VmFsdWUiOiI5MDAxIiwiaWQiOiJhMWIyYzNkNC1lNWY2LTc4OTAtYWJjZC1lZjEyMzQ1Njc4OTAifQ=="
}
```

**SDK Code**

```python
import requests

url = "https://api.letsdeel.com/rest/equity-option-ledger"

querystring = {"cursor":"eyJzb3J0VmFsdWUiOiI5MDAxIiwiaWQiOiJhMWIyYzNkNC1lNWY2LTc4OTAtYWJjZC1lZjEyMzQ1Njc4OTAifQ==","employee_grant_number":"ES-0001","employee_number":"9001","grant_date_from":"2026-01-01","grant_date_to":"2026-12-31","limit":"50"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.letsdeel.com/rest/equity-option-ledger?cursor=eyJzb3J0VmFsdWUiOiI5MDAxIiwiaWQiOiJhMWIyYzNkNC1lNWY2LTc4OTAtYWJjZC1lZjEyMzQ1Njc4OTAifQ%3D%3D&employee_grant_number=ES-0001&employee_number=9001&grant_date_from=2026-01-01&grant_date_to=2026-12-31&limit=50';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.letsdeel.com/rest/equity-option-ledger?cursor=eyJzb3J0VmFsdWUiOiI5MDAxIiwiaWQiOiJhMWIyYzNkNC1lNWY2LTc4OTAtYWJjZC1lZjEyMzQ1Njc4OTAifQ%3D%3D&employee_grant_number=ES-0001&employee_number=9001&grant_date_from=2026-01-01&grant_date_to=2026-12-31&limit=50"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.letsdeel.com/rest/equity-option-ledger?cursor=eyJzb3J0VmFsdWUiOiI5MDAxIiwiaWQiOiJhMWIyYzNkNC1lNWY2LTc4OTAtYWJjZC1lZjEyMzQ1Njc4OTAifQ%3D%3D&employee_grant_number=ES-0001&employee_number=9001&grant_date_from=2026-01-01&grant_date_to=2026-12-31&limit=50")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.letsdeel.com/rest/equity-option-ledger?cursor=eyJzb3J0VmFsdWUiOiI5MDAxIiwiaWQiOiJhMWIyYzNkNC1lNWY2LTc4OTAtYWJjZC1lZjEyMzQ1Njc4OTAifQ%3D%3D&employee_grant_number=ES-0001&employee_number=9001&grant_date_from=2026-01-01&grant_date_to=2026-12-31&limit=50")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.letsdeel.com/rest/equity-option-ledger?cursor=eyJzb3J0VmFsdWUiOiI5MDAxIiwiaWQiOiJhMWIyYzNkNC1lNWY2LTc4OTAtYWJjZC1lZjEyMzQ1Njc4OTAifQ%3D%3D&employee_grant_number=ES-0001&employee_number=9001&grant_date_from=2026-01-01&grant_date_to=2026-12-31&limit=50', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.letsdeel.com/rest/equity-option-ledger?cursor=eyJzb3J0VmFsdWUiOiI5MDAxIiwiaWQiOiJhMWIyYzNkNC1lNWY2LTc4OTAtYWJjZC1lZjEyMzQ1Njc4OTAifQ%3D%3D&employee_grant_number=ES-0001&employee_number=9001&grant_date_from=2026-01-01&grant_date_to=2026-12-31&limit=50");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.letsdeel.com/rest/equity-option-ledger?cursor=eyJzb3J0VmFsdWUiOiI5MDAxIiwiaWQiOiJhMWIyYzNkNC1lNWY2LTc4OTAtYWJjZC1lZjEyMzQ1Njc4OTAifQ%3D%3D&employee_grant_number=ES-0001&employee_number=9001&grant_date_from=2026-01-01&grant_date_to=2026-12-31&limit=50")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```