Skip to main content
GET
/
v1
/
offboarding
/
entities
/
{offboardingRequestId}
Retrieve an Offboarding Request
curl --request GET \
  --url https://api.traxes.io/connect/v1/offboarding/entities/{offboardingRequestId} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "components": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "principalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Access Token Authentication

Path Parameters

​
offboardingRequestId
string<uuid>
required

The id of the Offboarding Request

Response

OK

An Offboarding Request

​
data
object

Represents an entity in the offboarding process.

​
id
string<uuid>

The id of the Offboarding Request

​
principalId
string<uuid>

The id of the Principal that initiated the Offboarding Request

​
status
enum<string>
Available options:
Canceled,
Failed,
Pending,
Succeeded