List equity participants

Retrieves the people who hold equity in an organization, as ingested from Shareworks, in ascending employee_number order. Use it to reconcile equity participants against HRIS records, or to feed worker identity and residence data into equity tax calculations. Records carry direct identifiers, including a full Social Security Number where the source reports one. 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 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.

Response

List equity participants returned successfully.
datalist of objects
Page of equity participant records, one per Shareworks employee number.
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