Skip to navigation

List Organization Registration Documents

Lists the registration documents required across every legal entity in the organization, in one call. Use this to see what is still outstanding organization-wide — to drive an onboarding status dashboard, or to reconcile records — rather than requesting each legal entity in turn. Pass legal_entity_id to narrow to specific entities. Requirements that have not been answered yet are included with a null id.

Token scopes: legal-entity: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 20
Maximum number of results to return per page.
cursorstringOptionalformat: "^[A-Za-z0-9_-]+$"<=2048 characters

Pagination cursor returned as next_cursor by the previous response. Omit for the first page.

legal_entity_idlist of stringsOptional
Narrow to specific legal entities. Repeat the parameter to pass several values. Omit for every entity you can access.
searchstringOptional<=255 characters

Free-text search on the requirement name.

statuslist of enumsOptional
Filter by submission status. Repeat the parameter to pass several values.
product_typelist of enumsOptional
Filter by the product the requirement applies to. Repeat the parameter to pass several values.
Allowed values:
requirement_idlist of stringsOptional
Filter to specific requirements. Repeat the parameter to pass several values.
only_archivedbooleanOptionalDefaults to false
Return superseded submissions instead of the current ones.

Response

Registration documents returned successfully.
datalist of objects
Documents for this page.
has_moreboolean
Whether another page of results is available.
next_cursorstring or null

Cursor to pass as cursor for the next page. Null when there are no more pages.

total_countinteger>=0
Total number of matching documents.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error