Get Agent Status

Returns detailed information about the user being impersonated.

This endpoint requires the Agent Impersonator role.

URL

GET: https://[base-url]/{applicationId}/agents/{userId}/status

Headers

Authorization: Bearer <accessToken>

Request Body

N/A

Response

Success -> 200

Sample response:

{
    "userId": "accef80a-0491-4865-8f1b-1455f4c08b14",
    "email": "[e-mail]",
    "displayName": "Irene Jones",
    "initials": "IJ",
    "organizationId": "504912b8-f9bd-4248-b51b-340aa333fff2",
    "organizationName": "Evergreen College",
    "organizationStatus": "Active",
    "organizationCustomersDataTableId": "8ab4307c-5f1c-4537-b0d5-718aeea9d2f4",
    "unitId": "37da50e0-ba32-4718-bf3f-261f7e1c6a02",
    "unitName": "Registrar's Office",
    "workspaceId": "899f29fa-a91f-4699-a8ed-5e2dd478da87",
    "workspaceName": "Default",
    "emailVerified": true,
    "picture": "https://.../public/profiles/f1af71e8-3ba4-4034-b4f2-141492c07b23",
    "isTrialSubscription": false,
    "subscriptionExpiry": null,
    "unitPath": [],
    "isOrganizationOwner": false,
    "isAccountManager": false,
    "ssoEnabled": false,
    "rejoinRequired": null,
    "isLicensed": true,
    "roles": [
        "Agent",
        "PowerAgent",
        "..."
    ]
}