Skip to navigation

Retrieve a Child Account onboarding intent

Beta

Returns a Child Account onboarding intent that your organization opened, with its status, the steps still due and the next calls to make. Use it after opening the intent to check how far the onboarding has progressed and what to do next. With include=steps the answer also lists every step with its status.

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/

Path parameters

intent_idstringRequired
Id of the intent.

Headers

X-BetaenumRequiredDefaults to true

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

Allowed values:

Query parameters

includestringOptional

Only steps is accepted: it adds every step of the intent with its status.

Response

The intent.
dataobject
The intent.

Errors

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