Retrieve the current WalkMe Support access settings for your account.

GET

https://api.walkme.com/public/v1/walkmeAccess

cURL Example

curl -L -X GET https://api.walkme.com/public/v1/walkmeAccess' \ -H 'Authorization: Bearer <token>

Response Example JSON

{"accessRestricted": false,
   "restrictionStartsAt": "2026-06-30T20:39:49.504Z",
   "allowedUserEmails": [
       "[email protected]",
       "[email protected]"
   ]
}

Response

200 OK

Returns the current access settings. The response reflects whether impersonation is restricted right now, not raw internal configuration.

Response scenarios

Access is not restricted

{
  "accessRestricted": false,
  }

WalkMe Support may impersonate all users on the account.
allowedUserEmails is omitted because no specific allow-list is configured.

Access is restricted now

{
  "accessRestricted": true
}

WalkMe Support is currently blocked from impersonating users on the account.
restrictionStartsAtis omitted because the restriction is already in effect.

A restriction is scheduled for the future

{
"accessRestricted": false,
"restrictionStartsAt": "2026-06-22T15:00:00.000Z"
 }

Impersonation is not restricted yet.
accessRestricted is false because the restriction has not started. restrictionStartsAt shows when it will begin in UTC (ISO 8601 with a 'z' suffix). 'allowedUserEmails' is omitted when all users are allowed.

Partial access for specific users

{
  "accessRestricted": false,
  "allowedUserEmails": ["[email protected]", "[email protected]"]
}

WalkMe Support may impersonate only the listed email addresses.

Scheduled restriction with specific allowed users

{
  "accessRestricted": false,
 "restrictionStartsAt": "2026-06-22T15:00:00.000Z",
  "allowedUserEmails": ["[email protected]", "[email protected]"]
 }

Impersonation is still allowed until restrictionStartsAt, but only for the listed emails.
After that time, access becomes fully restricted.

Error responses

{
  "status": 403,
  "detail": "Forbidden"
}