Skip to content

User

The user object associated with the current app/session.

User object

The user object is a subset of the app/session user with additional user-specific information.

Use this endpoint to independently retrieve the user object of the current session, disregarding the session object itself.

http
GET https://api.backstack.com/user

Returns a user object.

json
{
  "id": "usr_1234567890",
  "created": 1234567890,
  "last_login": 1234567890,
  "username": "jamesdoe",
  "name": "James Doe",
  "email": "jamesdoe@acme-corp.com",
  "avatar": "<svg>...</svg>",
  "avatar_color": "#952c8b",
  "hidden_tips": [
    "tip_1234567890",
    ...
  ],
  "mobile_number": "123-456-7890"
}

Resources

Create user

Users are added by an account (account/users), or created using the app/sign-up endpoint.

Resources

Update user

Updates the user object associated with the current app/session. See the account/users documentation for information on updating the account user.

http
POST https://api.backstack.com/user
{
    "name": "James Doe", // required
    "username": "jamesdoe", // required, cannot be password
    "email": "jdoe@acme-corp.com", // required
    "mobile_number": "123-456-7890",
    "avatar_color": "#952c8b",
    "hidden_tips": [
        "tip_1234567890",
        ...
    ]
}

Returns a user object.

Resources

Delete user

Deletes the session user and terminates the current session.

http
DELETE https://api.backstack.com/user

Returns the deleted user ID.

json
{
  "id": "usr_1234567890"
}

Resources