Toast
API Reference

Users

User profile management for the authenticated user.

GET
/api/users/me

Retrieves the authenticated user's profile information.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/users/me"
{  "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"}
{  "error": "string"}
{  "error": "string"}
PATCH
/api/users/me

Updates the authenticated user's profile information.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/users/me" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "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"}
{  "error": "string",  "details": [    {      "code": "string",      "message": "string",      "path": [        "string"      ]    }  ]}
{  "error": "string"}
{  "error": "string"}