For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
DeveloperAcademyCommunityStatus
    • Overview
    • API Credentials
    • Errors
    • Legacy & Deprecated APIs
  • Events API
    • Chat Markup
    • Rate Limits
    • Message Delivery
  • (Beta) Conversations API
  • Data API
    • GETList conversations
    • GETList interactions
    • GETList plugins calls
    • GETList Plugin Resources
    • GETList Users
  • Webhook Listeners
  • Content Gateway
    • Overview
    • Integration Strategies
    • Starter Code
    • Verifying Your Build
    • Connecting Your Gateway to Moveworks
    • Authentication
    • How Permissions Work
    • Common Pitfalls
    • Operational Guide
    • Errors
    • Supported MIME Types
  • Legacy Gateways
    • Authentication
      • GETList Users
      • GETGet User By ID
    • Response Options
    • Field Types
    • Form Gateway Errors
DeveloperAcademyCommunityStatus
Legacy GatewaysIdentity Gateway

Get User By ID

||View as Markdown|
GET
http://localhost:5000/myinstance1/users/:userId
GET
/myinstance1/users/:userId
$curl http://localhost:5000/myinstance1/users/userId \
> -H "Authorization: Bearer <token>"
200Retrieved
1{
2 "user": {
3 "state": "ACTIVE",
4 "universal_identifier": "john@example.com",
5 "email_addr": "john@example.com",
6 "first_name": "John",
7 "last_name": "Doe",
8 "full_name": "John Doe",
9 "work_status": "FULL_TIME",
10 "employment_info": {
11 "employee_start_date_ts": "2023-05-14T09:30:00Z",
12 "role": "Software Engineer",
13 "manager_email": "emilysmith@example.com",
14 "cost_center_id": "A123",
15 "cost_center_name": "Engineering Department",
16 "department": "Engineering",
17 "office_phone_number": "555-123-4567",
18 "assistant_full_name": "Sarah Johnson",
19 "employment_location": {
20 "location": "Austin, Texas",
21 "office": "MTV",
22 "country_code": "1",
23 "region": "South Central",
24 "timezone": "Central Standard Time (CST)"
25 }
26 }
27 },
28 "system_identity": {
29 "id": "1234-5678-9012-3456",
30 "username": "JohnDoe"
31 },
32 "last_updated_at": "2023-05-14T09:30:00Z"
33}

Returns user details given their userId. We recommend a rate limit of 5 req/sec for this endpoint.

Was this page helpful?
Previous

Identity Gateway Response Options

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

userIdstringRequired
ID of user to fetch details for

Response headers

X-RateLimit-Limitinteger
The maximum number of requests you're permitted to make per minute.
X-RateLimit-Remaininginteger
The number of requests remaining in the current rate limit window.
X-RateLimit-Resetstring
The remaining window before the rate limit FULLY resets in UTC epoch seconds.

Response

A single user
userobject
system_identityobject
last_updated_atstringformat: "timestamp"

Represents the timestamp indicating the most recent modification or update made to the user’s information (in ISO-8601 UTC)