Read admin profile

GET 
/v2/onboard/admin

Reads the profile of the admin that the API key belongs to. The answer is a flat object with no wrapper.

Responses

200

The profile of the admin.

application/json

Schema

Schema

id string

The identifier of the admin.

email string

The e-mail address of the admin.

name string

The name of the admin.

phone string

The phone number of the admin. Empty when not set.

avatarImageId string

The identifier of the avatar image. Empty when the admin has no avatar.

avatarImageUrl string

The URL of the avatar image. Read the image with the read admin avatar image operation.

externalId string

The external identifier of the admin. Empty when not set.

identityProviderId string

The identifier of the identity provider of the admin. Empty when not set.

lastVisited string

The date and time of the last login of the admin.

roleId integer

The role identifier of the admin in the organisation.

roleName string

The role name of the admin in the organisation.

organizationName string

The name of the organisation.

Example (from schema)

{
  "id": "6a1f0c2e9b3d4e5f6a7b8c9d",
  "email": "[email protected]",
  "name": "Jane Doe",
  "phone": "",
  "avatarImageId": "6a1f0c2e9b3d4e5f6a7b8c9e",
  "avatarImageUrl": "https://demo-api.igrant.io/onboard/admin/avatarimage",
  "externalId": "",
  "identityProviderId": "",
  "lastVisited": "2026-10-27T09:12:44Z",
  "roleId": 1,
  "roleName": "Admin",
  "organizationName": "Example Organisation"
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

404

The organisation or the admin is not found.

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...