GET/end-users/{end_user_id}

Get End User Info

Available for: Chatflow, Workflow, Agent, Chatbot, Legacy Agent, Text Generator apps.

Returns an end user's details by ID. Useful for resolving an end-user ID returned by another endpoint, such as created_by in the Upload File response.

1 parameter
end_user_idstringrequired
ID of the end user to look up.

2 status codes
200End user retrieved successfully.
app_idstringoptional
Application ID.
created_atstringoptional
Creation timestamp.
external_user_idstringoptional
The `user` identifier provided in API requests (e.g., the `user` field in [Send Chat Message](/en/api-reference/chat-messages/send-chat-message)).
idstringoptional
End user ID.
is_anonymousbooleanoptional
Whether the user is anonymous. `true` when no `user` identifier was provided in the original API request.
namestringoptional
End user name.
session_idstringoptional
Session identifier. Defaults to the `external_user_id` value.
tenant_idstringoptional
Tenant ID.
typestringoptional
End user type. Always `service-api` for Service API users.
updated_atstringoptional
Last update timestamp.
404`end_user_not_found` : End user not found.

One documented failure

  • end_user_not_found

    End user not found.

    end_user_not_found

Error handling

A 404 is returned: end_user_not_found : End user not found.