Users
The profile of the person a personal token or OAuth token acts as.
Your user id is the user_id of the member whose is_self is true in the member list, which needs member.read, and the actor_id of the audit events you caused.
Contains: Members
User object
A person's own profile: user id, email and names.
idstringYour user id.
emailemailYour email address.
full_name string or nullYour full name.
display_name string or nullThe name shown for you in the app.
Read your profile
/users/{user_id} Returns the profile of the person the credential acts as: your user id, email and names. Any other user id returns 404. A workspace token acts as no person and is refused.
- Request
- Response
- curl
- PowerShell
- Python
curl -X GET \ "https://engine.sparklogs.app/app-api/users/AlexRiveraExampleUserId00001" \ -H "Authorization: Bearer $SPARKLOGS_TOKEN"Invoke-RestMethod -Method Get ` -Uri "https://engine.sparklogs.app/app-api/users/AlexRiveraExampleUserId00001" ` -Headers @{ Authorization = "Bearer $env:SPARKLOGS_TOKEN" }import os import requests response = requests.get( "https://engine.sparklogs.app/app-api/users/AlexRiveraExampleUserId00001" , headers={"Authorization": f"Bearer {os.environ['SPARKLOGS_TOKEN']}"},)response.raise_for_status(){ "message": "user retrieved", "user": { "id": "AlexRiveraExampleUserId00001", "email": "alex.rivera@example.com", "full_name": "Alex Rivera", "display_name": "Alex" }}Access
- Works with
- Signed-in person, Personal token, OAuth token
Needs no privilege: it reads only the profile of the person the credential acts as.
Behavior
- Retry
- Safe to send again
Path parameters
user_id stringrequiredThe user's id.
Query parameters
fieldsarray of stringComma-separated top-level fields of each object to return instead of the default set.
Sent by default: idemailfull_namedisplay_name
Response 200
The user.
messagestringrequiredWhat the call did, as a short phrase for a person to read. Its wording may change: act on the HTTP status.
Errors
400APP_API_ERR_BAD_PARAMETERS A query parameter it does not take, one given twice, or fields naming a field it does not have.No403APP_API_ERR_CREDENTIAL_NOT_ADMITTED The call does not take a credential of this kind: workspace_key.No404APP_API_ERR_RECORD_NOT_FOUND The user id is not the caller's own.NoPlus the errors every call can return.