Skip to navigation
EndpointsEquity Tokens

List equity grant total expense records

Retrieves the total share-based compensation expense recognised per equity grant in an organization, as ingested from Shareworks. Use it at period close to tie the equity expense in the ledger back to the individual grants that produced it. Each record reflects the most recently ingested reporting period; earlier periods are overwritten, so this is not a period history. 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.letsdeel.com/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

OR
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 grant total expense records returned successfully.
datalist of objects
Page of total expense 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