> ## Documentation Index
> Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve the current user profile (Beta)

> Retrieve the authenticated user's profile, including data locality and migration status.

**Beta:** this API should be considered a beta integration target because it may change if user account settings require changes



## OpenAPI

````yaml /openapi/source/external/user-profile/user-profile.json get /user_profile
openapi: 3.1.0
info:
  title: Telnyx User Profile API
  version: 2.0.0
  x-latency-category: responsive
  x-endpoint-cost: light
  description: Retrieve and update the authenticated user's account profile (Beta).
  contact:
    email: support@telnyx.com
servers:
  - url: https://api.telnyx.com/v2
security:
  - bearerAuth: []
tags:
  - name: User Profile
    description: Read and update the authenticated user's profile and data locality.
paths:
  /user_profile:
    get:
      tags:
        - User Profile
      summary: Retrieve the current user profile (Beta)
      description: >-
        Retrieve the authenticated user's profile, including data locality and
        migration status.


        **Beta:** this API should be considered a beta integration target
        because it may change if user account settings require changes
      operationId: GetUserProfile
      responses:
        '200':
          description: The authenticated user's profile.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    $ref: '#/components/schemas/UserProfile'
              example:
                data:
                  record_type: user_profile
                  id: 12345
                  user_id: 12ade33a-21c0-473b-b055-b3c836e1c292
                  updated_at: '2026-01-15T10:30:00Z'
                  first_name: Alex
                  last_name: Taylor
                  business_name: Example Company
                  data_locality: UAE
                  data_locality_updated_at: '2026-01-15T10:00:00Z'
                  data_locality_migration_status: finished
        '401':
          description: >-
            Authentication failed. Supply a valid API key using Bearer
            authentication.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                          description: API error code.
                        title:
                          type: string
                          description: Error title.
                        detail:
                          type: string
                          description: Explanation of the error.
                        source:
                          type: object
                          properties:
                            pointer:
                              type: string
                              description: Pointer to the invalid field.
                        meta:
                          type: object
                          additionalProperties: true
                          description: Additional error metadata.
              example:
                errors:
                  - code: '10009'
                    title: Unauthorized
                    detail: You must be authenticated to perform this action.
                    source:
                      pointer: /
                    meta:
                      url: https://developers.telnyx.com/docs/overview/errors/10009
        '403':
          description: The authenticated user is not permitted to access this resource.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                          description: API error code.
                        title:
                          type: string
                          description: Error title.
                        detail:
                          type: string
                          description: Explanation of the error.
                        source:
                          type: object
                          properties:
                            pointer:
                              type: string
                              description: Pointer to the invalid field.
                        meta:
                          type: object
                          additionalProperties: true
                          description: Additional error metadata.
              example:
                errors:
                  - code: '10006'
                    title: Not authorized
                    detail: You are not authorized to access the requested resource.
                    source:
                      pointer: /
                    meta:
                      url: https://developers.telnyx.com/docs/overview/errors/10006
components:
  schemas:
    UserProfile:
      type: object
      description: The authenticated user's profile.
      additionalProperties: true
      properties:
        record_type:
          type: string
          enum:
            - user_profile
          description: Identifies the type of resource.
          example: user_profile
        id:
          type: integer
          description: Identifier of the user profile, distinct from the user ID.
          example: 12345
        user_id:
          type: string
          description: Identifier of the user who owns this profile.
          example: 12ade33a-21c0-473b-b055-b3c836e1c292
        updated_at:
          type: string
          format: date-time
          description: Timestamp of the most recent profile update.
          example: '2026-01-15T10:30:00Z'
        first_name:
          type:
            - string
            - 'null'
          description: The user's first name.
          example: Alex
        last_name:
          type:
            - string
            - 'null'
          description: The user's last name.
          example: Taylor
        business_name:
          type:
            - string
            - 'null'
          description: Business name associated with the profile.
          example: Example Company
        phone_number:
          type:
            - string
            - 'null'
          description: Contact phone number associated with the profile.
          example: '+13125550100'
        address_1:
          type:
            - string
            - 'null'
          description: First line of the profile address.
          example: 123 Example Street
        address_2:
          type:
            - string
            - 'null'
          description: Second line of the profile address.
          example: Suite 100
        city:
          type:
            - string
            - 'null'
          description: City in the profile address.
          example: Chicago
        state:
          type:
            - string
            - 'null'
          description: State or region in the profile address.
          example: IL
        zip:
          type:
            - string
            - 'null'
          description: Postal code in the profile address.
          example: '60601'
        country:
          type:
            - string
            - 'null'
          description: Country code in the profile address.
          example: US
        data_locality:
          type:
            - string
            - 'null'
          enum:
            - USA
            - DEU
            - AUS
            - UAE
            - CAN
            - null
          description: >-
            The user's data locality: USA (United States), DEU (Germany), AUS
            (Australia), UAE (United Arab Emirates), or CAN (Canada).
          example: UAE
        data_locality_updated_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Timestamp when the user's data locality was last changed, or null if
            it has not been changed.
          example: '2026-01-15T10:00:00Z'
        data_locality_migration_status:
          type:
            - string
            - 'null'
          enum:
            - not_started
            - in_progress
            - finished
            - null
          description: >-
            Status of the user's data locality migration, or null when no
            migration status is recorded.
          example: finished
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````