EndpointsEquity Tokens

List Shareworks equity exercises

Retrieves ingested Shareworks equity exercise records for an organization, in ascending exercise_date order. 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 curl -X GET 'https://api.deel.training/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)
OR
AuthorizationBearer
Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Query parameters

limitintegerOptional1-100Defaults to 50
Maximum number of exercise 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.

exercise_date_fromstringOptionalformat: "date"

Only return exercises with an exercise_date on or after this date (inclusive), in YYYY-MM-DD format.

exercise_date_tostringOptionalformat: "date"

Only return exercises with an exercise_date on or before this date (inclusive), in YYYY-MM-DD format.

employee_numberstringOptional<=64 characters
Only return exercises for this exact Shareworks employee number.

Response

Shareworks equity exercises returned successfully.
datalist of objects

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.

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