> For the complete documentation index, see [llms.txt](https://docs.2checkout.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.2checkout.com/api-reference/reference/users.md).
# Users
## Retrieve user details by email
> Returns a single user's profile (name, email, status, the accounts/sites they have roles on, and their last login date), looked up by email.\
> \
> Scoped to the caller's own account and any account manually linked to it (accounts linking) - a user belonging only to an unrelated account will not be found.
```json
{"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/users/{Email}":{"get":{"tags":["Users"],"summary":"Retrieve user details by email","description":"Returns a single user's profile (name, email, status, the accounts/sites they have roles on, and their last login date), looked up by email.\n\nScoped to the caller's own account and any account manually linked to it (accounts linking) - a user belonging only to an unrelated account will not be found.\n","parameters":[{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","default":"application/json","enum":["application/json"]}},{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"Email","in":"path","description":"The email address of the user to retrieve.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"UserName":{"type":"string"},"Email":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"UserStatus":{"type":"string","description":"The user's status.","enum":["ENABLED","DISABLED","DELETED"]},"Accounts":{"type":"array","description":"Every account/site this user has access to, with the roles held on it.","items":{"type":"object","properties":{"Homepage":{"type":"string"},"Roles":{"type":"array","items":{"type":"string"}},"Default":{"type":"boolean","description":"True for the account used to authenticate the call."}}}},"LastLoginDate":{"type":"string","nullable":true,"description":"ISO-8601 timestamp of the user's last login. Null if the user has never logged in."}}}}}},"400":{"description":"Bad request - validation error","content":{"application/json":{"schema":{"type":"object","properties":{"error_code":{"type":"string","description":"Error code identifying the specific validation failure.","enum":["USER_EMAIL"]},"message":{"type":"string","description":"Detailed error message."}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error_code":{"type":"string","enum":["USER_NOT_FOUND"]},"message":{"type":"string"}}}}}}}}}}}
```
## Retrieve users list
> Returns a paginated list of user profiles (name, email, status, the accounts/sites they have roles on, and their last login date) belonging to the caller's own account and any account manually linked to it (accounts linking).\
> \
> Takes no parameters beyond pagination - the vendor is derived entirely from the authentication used for the call. This endpoint never returns a 404; an empty result set is returned as a 200 with an empty \`Data\` array.
```json
{"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/users/":{"get":{"tags":["Users"],"summary":"Retrieve users list","description":"Returns a paginated list of user profiles (name, email, status, the accounts/sites they have roles on, and their last login date) belonging to the caller's own account and any account manually linked to it (accounts linking).\n\nTakes no parameters beyond pagination - the vendor is derived entirely from the authentication used for the call. This endpoint never returns a 404; an empty result set is returned as a 200 with an empty `Data` array.\n","parameters":[{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","default":"application/json","enum":["application/json"]}},{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"Page","in":"query","description":"Page number for pagination. Default value is 1. Must be >= 1.","required":false,"style":"form","explode":true,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"Limit","in":"query","description":"Number of results per page. Default value is 100. Must be between 1 and 1000.","required":false,"style":"form","explode":true,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"Data":{"type":"array","description":"One entry per matching user.","items":{"type":"object","properties":{"UserName":{"type":"string"},"Email":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"UserStatus":{"type":"string","enum":["ENABLED","DISABLED","DELETED"]},"Accounts":{"type":"array","items":{"type":"object","properties":{"Homepage":{"type":"string"},"Roles":{"type":"array","items":{"type":"string"}},"Default":{"type":"boolean","description":"True only for the exact account used to authenticate the call."}}}},"LastLoginDate":{"type":"string","nullable":true}}}},"Pagination":{"type":"object","properties":{"Page":{"type":"integer","description":"The page returned."},"Limit":{"type":"integer","description":"The page size used."},"Count":{"type":"integer","description":"Total number of users across the caller's account and its manually linked accounts."}}}}}}}}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.2checkout.com/api-reference/reference/users.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.