Developers

# User

This endpoints lets you work with the authenticated user profile.

# The user object

  • id integer

    The system-generated ID of the user.

  • name string

    The name of the user which is displayed across the app.

  • is_me boolean

    Whether the user is the same as the authenticated user.

  • initials string

    The initials based on the first letters of the first and last name.

  • email string

    The email address of the user which is used for notifications, communications and login. Must be a valid email address and unique within the application context.

  • password string

    The password of the user used for authentication. If provided, password_confirmation must also be provided and match the password value. If empty or not pressent, the field is ignored and the current password remains unchanged.

  • email_verified_at string

    The timestamp when the email was verified. If null, it is assumed the email hasn't been verified.

  • created_at string

    The timestamp when the user was created.

  • updated_at string

    The timestamp when the user was last updated.

# Retrieve user

curl https://www.yourdomain.com/api/v1/user \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <access-token>" \
  -G

The above command returns JSON structured like this:

{
  "data": {
    "id": 1,
    "name": "Jane Doe",
    "initials": "JD",
    "email": "jane@example.org",
    "email_verified_at": null,
    "created_at": "2019-04-24T01:27:22+00:00",
    "updated_at": "2019-04-24T01:27:22+00:00"
  }
}

# Update user

  • name string

    The name of the user which is displayed across the app.

  • email string

    The email address of the user which is used for notifications, communications and login. Must be a valid email address and unique within the application context.

  • password string

    The password of the user used for authentication. If provided, password_confirmation must also be provided and match the password value. If empty or not pressent, the field is ignored and the current password remains unchanged.

# Sample request

curl https://www.yourdomain.com/api/v1/user \
  --request PUT \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <access-token>"
  -d name="Jane Doe Doe" \
  -d email="janedoe@example.org" \
  -d password="my-secret-password" \
  -d password_confirmation="my-secret-password"

# Sample successful response

{
  "data": {
    "id": 1,
    "name": "Jane Doe Doe",
    "initials": "JD",
    "email": "janedoe@example.org",
    "email_verified_at": null,
    "created_at": "2019-04-24T01:27:22+00:00",
    "updated_at": "2019-04-24T01:27:22+00:00"
  }
}

# Delete user

This action permanently deletes the user and all data and information associated with it, like accounts and all data related to those accounts.

Any interaction the user has created on accounts he were invited to will not be deleted but disassociated.

The password must be provided and must match the user's current password.

curl https://www.yourdomain.com/api/v1/user \
  --request DELETE \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <access-token>" \
  -d password="current-password"

If successful, an empty response is returned with 204 HTTP status.

← Accounts →