---
updatedAt: 2026-05-13T12:01:40.000Z
agentTools:
  projectIndex: https://docs.scaut.com/llms.txt
---

# Get user profile

Retrieve the authenticated user's profile information

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Scaut REST API",
    "description": "Comprehensive REST API gateway for the Scaut platform, providing secure endpoints for authentication, order management, and business operations. Features include multi-factor authentication with passkey support (WebAuthn), Stripe payment integration, VAT validation, internationalization, and webhook handling. All protected endpoints require Bearer token or API key authentication.",
    "version": "1.0.0",
    "contact": {
      "name": "Scaut s.r.o.",
      "url": "https://scaut.com"
    },
    "license": {
      "name": "Scaut s.r.o.",
      "url": "https://scaut.com"
    }
  },
  "tags": [
    {
      "name": "Users",
      "description": "User management endpoints"
    }
  ],
  "paths": {
    "/profile/": {
      "get": {
        "tags": [
          "Users"
        ],
        "summary": "Get user profile",
        "description": "Retrieve the authenticated user's profile information",
        "responses": {
          "200": {
            "description": "User profile response with complete user information",
            "content": {
              "application/json": {
                "schema": {
                  "description": "User profile response with complete user information",
                  "additionalProperties": false,
                  "type": "object",
                  "required": [
                    "uuid"
                  ],
                  "properties": {
                    "uuid": {
                      "description": "User UUID",
                      "type": "string"
                    },
                    "email": {
                      "description": "User email address",
                      "format": "email",
                      "type": "string"
                    },
                    "phone": {
                      "description": "User phone number",
                      "type": "string"
                    },
                    "givenName": {
                      "description": "User's given name (first name)",
                      "type": "string"
                    },
                    "familyName": {
                      "description": "User's family name (last name)",
                      "type": "string"
                    },
                    "settings": {
                      "description": "Complete user settings including locale, UI, security, communication, and compliance",
                      "additionalProperties": false,
                      "type": "object",
                      "required": [
                        "locale",
                        "ui",
                        "security",
                        "communication",
                        "compliance"
                      ],
                      "properties": {
                        "locale": {
                          "description": "User locale and regional settings",
                          "additionalProperties": false,
                          "type": "object",
                          "required": [
                            "language",
                            "defaultDateFormat",
                            "defaultTimeFormat",
                            "timezone"
                          ],
                          "properties": {
                            "language": {
                              "description": "User's preferred language (locale code)",
                              "default": "en-GB",
                              "type": "string"
                            },
                            "defaultDateFormat": {
                              "description": "Default date format for the user",
                              "default": "yyyy-MM-dd",
                              "type": "string"
                            },
                            "defaultTimeFormat": {
                              "description": "Default time format for the user",
                              "default": "hh:mm:ss",
                              "type": "string"
                            },
                            "timezone": {
                              "description": "Preferred timezone identifier (IANA format)",
                              "default": "UTC",
                              "type": "string"
                            }
                          }
                        },
                        "ui": {
                          "description": "User interface and display settings",
                          "additionalProperties": false,
                          "type": "object",
                          "required": [
                            "theme",
                            "highContrastMode",
                            "uiScale"
                          ],
                          "properties": {
                            "theme": {
                              "type": "string",
                              "enum": [
                                "system",
                                "dark",
                                "light"
                              ]
                            },
                            "highContrastMode": {
                              "description": "Whether high contrast mode is enabled",
                              "default": false,
                              "type": "boolean"
                            },
                            "uiScale": {
                              "description": "UI scale factor (-1 to 1)",
                              "minimum": -1,
                              "maximum": 1,
                              "default": 0,
                              "type": "number"
                            },
                            "fontScale": {
                              "description": "Base font size (8-32 pixels)",
                              "minimum": 8,
                              "maximum": 32,
                              "default": 16,
                              "type": "number"
                            }
                          }
                        },
                        "security": {
                          "description": "User security and authentication settings",
                          "additionalProperties": false,
                          "type": "object",
                          "required": [
                            "passkeySupport"
                          ],
                          "properties": {
                            "passkeySupport": {
                              "description": "Whether passkey authentication is enabled",
                              "default": true,
                              "type": "boolean"
                            },
                            "sessionTimeout": {
                              "description": "Session timeout in seconds (organization policies may override)",
                              "minimum": 60,
                              "type": "number"
                            }
                          }
                        },
                        "communication": {
                          "description": "User communication channels and notification settings",
                          "additionalProperties": false,
                          "type": "object",
                          "required": [
                            "newsletters"
                          ],
                          "properties": {
                            "email": {
                              "description": "Email address for notifications",
                              "format": "email",
                              "type": "string"
                            },
                            "phone": {
                              "description": "Phone number for SMS and WhatsApp notifications",
                              "type": "string"
                            },
                            "slackChannel": {
                              "description": "Slack channel for notifications (requires proper subscription tier)",
                              "type": "string"
                            },
                            "slackUserID": {
                              "description": "Slack user ID for notifications (requires proper subscription tier)",
                              "type": "string"
                            },
                            "msTeamsChatID": {
                              "description": "Microsoft Teams chat ID for notifications (requires proper subscription tier)",
                              "type": "string"
                            },
                            "msTeamsTeamID": {
                              "description": "Microsoft Teams team ID for notifications (requires proper subscription tier)",
                              "type": "string"
                            },
                            "msTeamsChannelID": {
                              "description": "Microsoft Teams channel ID for notifications (requires proper subscription tier)",
                              "type": "string"
                            },
                            "azureAccessToken": {
                              "description": "Azure access token for Microsoft Teams communication (requires proper subscription tier)",
                              "type": "string"
                            },
                            "newsletters": {
                              "description": "Whether the user is subscribed to newsletters",
                              "default": false,
                              "type": "boolean"
                            }
                          }
                        },
                        "compliance": {
                          "description": "User compliance and terms acceptance settings",
                          "additionalProperties": false,
                          "type": "object",
                          "required": [
                            "accepted",
                            "version"
                          ],
                          "properties": {
                            "accepted": {
                              "description": "Whether the user has accepted the terms and conditions",
                              "default": false,
                              "type": "boolean"
                            },
                            "version": {
                              "description": "Version of the terms and conditions accepted",
                              "default": "1.0",
                              "type": "string"
                            },
                            "acceptedAt": {
                              "description": "ISO 8601 timestamp when terms were accepted",
                              "format": "date-time",
                              "type": "string"
                            }
                          }
                        }
                      }
                    },
                    "createdAt": {
                      "description": "ISO 8601 timestamp of creation",
                      "format": "date-time",
                      "type": "string"
                    },
                    "updatedAt": {
                      "description": "ISO 8601 timestamp of last update",
                      "format": "date-time",
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "operationId": "getProfile"
      }
    }
  }
}
```