GET
/
v1
/
offboarding
/
entities
curl --request GET \
  --url https://platform.realto.io/api/v1/offboarding/entities \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "data": {
        "collectiveId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "principalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "requestType": "<string>",
      "status": "<string>"
    }
  ],
  "links": {
    "next": "<string>"
  },
  "meta": {
    "continuationToken": "<string>",
    "pageSize": 123
  }
}

Authorizations

​
Authorization
string
header
required

Access Token Authentication

Query Parameters

​
pageSize
integer
default:
25

The number of Offboarding Requests per page

​
continuationToken
string

The token used to retrieve the next page

Response

200
application/json
OK

A page of Offboarding Requests

​
data
object[] | null
​
links
object
​
meta
object

Was this page helpful?

Retrieve an Entity Offboarding RequestCreate an Entity Offboarding Request