Platforms
Get sub-entity Members
<span style="font-size: 12px; font-weight: 500; color: rgb(0, 0, 0); background-color: rgb(255, 176, 97); border-radius: 4px; padding: 2px 6px" >Beta</span><p></p> Retrieve information on all users of a sub-entity that has been invited through <a href="https://www.checkout.com/docs/platforms/onboard-sub-entities/onboard-with-hosted-onboarding" target="_blank">Hosted Onboarding</a>. Only one user can be invited to onboard the sub-entity through Hosted Onboarding.
To enable the Hosted Onboarding feature, contact your Account Manager.
get/accounts/entities/{entityId}/members
Request
- Base URLhttps://{prefix}.api.sandbox.checkout.com
- Auth
- OAuth 2Client credentialsToken URLstringScopesaccounts
- or API key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Response
Sub-Entity member retrieved successfully
Example response
{
"data": [
{
"user_id": "usr_eyk754cqieqexfh6u46no5nnha"
}
],
"links": {
"_links": {
"self": {
"href": "https://{prefix}.api.checkout.com/accounts/entities/ent_wxglze3wwywujg4nna5fb7ldli"
}
}
}
}Changes
No recorded changes to this operation across all 1 revision of this API.