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.

Atomicwork Public API

Atomicwork Public API Users

Retrieve User

||View as Markdown|

GET

https://{tenant}.atomicwork.com/api/v1/users/:user_id

GET

/api/v1/users/:user_id

$ curl https://{tenant}.atomicwork.com/api/v1/users/1 \
>      -H "X-Workspace-Id: {{workspace_id}}" \
>      -H "X-Api-Key: <apiKey>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "id": 1,
3   "username": "jdoe",
4   "email": "jdoe@example.com",
5   "firstName": "John",
6   "lastName": "Doe",
7   "role": "agent",
8   "createdAt": "2024-04-01T09:15:00Z",
9   "lastLogin": "2024-06-10T16:45:00Z",
10   "active": true
11 }

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

user_idlongRequired

Headers

X-Workspace-IdstringOptional

Response

Successful response

Was this page helpful?

Get paginated users list in a segment

Update User