Skip to navigation

List intents

Beta

Use this endpoint to monitor the onboarding intents of your Child Accounts and find the ones that are stuck, without keeping every intent id. Only intents opened by your own organization are listed, newest first.

Token scopes: organizations:read

Beta: this version requires the X-Beta: true request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-02-16.

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/

Headers

X-BetaenumRequiredDefaults to true

Opts in to the beta version of this endpoint. Must be true.

Allowed values:

Query parameters

typestringOptional

The intent type to list. Required; the only value is CHILD_ACCOUNT_ONBOARDING.

statusstringOptional

Only intents with this status: CANCELED, REQUIRES_ACTION, SUCCEEDED.

limitdoubleOptional
Page size, from 1 to 100. Defaults to 20.
cursorstringOptional

The next_cursor of the previous page. Leave it out for the first page.

Response

One page of intents.
datalist of objects
The intents of your Child Accounts, newest first.
has_moreboolean
Whether another page follows this one.
next_cursorstring or null

Send it as cursor to get the next page. Null on the last page.

Errors

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