Skip to main content

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.

idstring

Your user id.

emailemail

Your email address.

full_namestring or null

Your full name.

display_namestring or null

The name shown for you in the app.

Read your profile​

GET/users/{user_id}
Preview

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.

curl -X GET \  "https://engine.sparklogs.app/app-api/users/AlexRiveraExampleUserId00001" \  -H "Authorization: Bearer $SPARKLOGS_TOKEN"

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_idstringrequired

The user's id.

Query parameters

fieldsarray of string

Comma-separated top-level fields of each object to return instead of the default set.

Sent by default: idemailfull_namedisplay_name

Response 200

userUserrequired

The user.

messagestringrequired

What the call did, as a short phrase for a person to read. Its wording may change: act on the HTTP status.

Errors

StatusCodeWhenSend again?
400APP_API_ERR_BAD_PARAMETERSA query parameter it does not take, one given twice, or fields naming a field it does not have.No
403APP_API_ERR_CREDENTIAL_NOT_ADMITTEDThe call does not take a credential of this kind: workspace_key.No
404APP_API_ERR_RECORD_NOT_FOUNDThe user id is not the caller's own.No

Plus the errors every call can return.

Related