Toast
API Reference

Users

User profile management for the authenticated user.

Get current user profile

GET
/api/users/me

Retrieves the authenticated user's profile information.

Response Body

User profile

application/json
  1. response
id*string
siteId*string
Formatuuid
email*string
Formatemail
emailVerified*boolean
name*string
image?string
Formaturi
createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
Example Request
curl -X GET 'https://example.com/api/users/me'
Example Response
{  "id": "string",  "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",  "email": "user@example.com",  "emailVerified": true,  "name": "string",  "image": "http://example.com",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}
PATCH
/api/users/me

Updates the authenticated user's profile information.

Request Body

application/json
  1. body
name*string

Display name

Length1 <= length

Response Body

User updated

application/json
  1. response
id*string
siteId*string
Formatuuid
email*string
Formatemail
emailVerified*boolean
name*string
image?string
Formaturi
createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
Example Request
curl -X PATCH 'https://example.com/api/users/me' \  -H 'Content-Type: application/json' \  -d '{  "name": "string"}'
Example Response
{  "id": "string",  "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",  "email": "user@example.com",  "emailVerified": true,  "name": "string",  "image": "http://example.com",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}