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

# Get external user profile

> Retrieves the profile of a user using their external ID.



## OpenAPI

````yaml /api-reference/users/openapi.json get /external/users/{externalId}/profile
openapi: 3.0.0
info:
  title: Users
  version: 1.0.0
  description: API endpoints for managing users in the 16TMS platform
servers:
  - url: https://api.16tms.com/api/v1
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /external/users/{externalId}/profile:
    get:
      summary: Get external user profile
      description: Retrieves the profile of a user using their external ID.
      operationId: getExternalUserProfile
      parameters:
        - name: externalId
          in: path
          required: true
          schema:
            type: string
          description: The external ID of the user.
      responses:
        '200':
          description: External user profile retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetExternalUserProfileResponse'
              example:
                success: true
                message: External user profile retrieved successfully
                data:
                  userId: cbf66c47-a05a-457c-9d3f-322ddd04d79a
                  username: test
                  displayName: test
                  email: null
                  phoneNumber: null
                  countryCode: null
                  image: null
                  coverImage: null
                meta:
                  traceId: 00-99e813e28dd5cd61273e4687a8d65da6-746be5aedcf85cd2-00
                  elapsedMs: 10.71
                  serverTimestamp: '2026-02-11T05:49:31.5088635Z'
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    GetExternalUserProfileResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates if the request was successful.
          example: true
        message:
          type: string
          description: A message describing the result of the operation.
          example: External user profile retrieved successfully
        data:
          type: object
          properties:
            userId:
              type: string
              format: uuid
              description: The unique identifier assigned to the user in 16TMS.
              example: cbf66c47-a05a-457c-9d3f-322ddd04d79a
            username:
              type: string
              description: The username of the user.
              example: test
            displayName:
              type: string
              description: The display name of the user.
              example: test
            email:
              type: string
              format: email
              description: The email address of the user.
              nullable: true
              example: null
            phoneNumber:
              type: string
              description: The phone number of the user.
              nullable: true
              example: null
            countryCode:
              type: string
              description: The country code for the phone number.
              nullable: true
              example: null
            image:
              type: string
              format: uri
              description: URL to the user's profile image.
              nullable: true
              example: null
            coverImage:
              type: string
              format: uri
              description: URL to the user's cover image.
              nullable: true
              example: null
        meta:
          type: object
          properties:
            traceId:
              type: string
              description: Unique trace identifier for debugging purposes.
              example: 00-99e813e28dd5cd61273e4687a8d65da6-746be5aedcf85cd2-00
            elapsedMs:
              type: number
              description: Time taken to process the request in milliseconds.
              example: 10.71
            serverTimestamp:
              type: string
              format: date-time
              description: Server timestamp when the response was generated.
              example: '2026-02-11T05:49:31.5088635Z'
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates if the request was successful.
          example: false
        message:
          type: string
          description: Error message describing what went wrong.
          example: Invalid API key
        errors:
          type: array
          description: Detailed error information.
          items:
            type: object
            properties:
              field:
                type: string
                description: The field that caused the error.
                example: externalId
              message:
                type: string
                description: Description of the error.
                example: This field is required
        meta:
          type: object
          properties:
            traceId:
              type: string
              description: Unique trace identifier for debugging purposes.
            serverTimestamp:
              type: string
              format: date-time
              description: Server timestamp when the error occurred.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: >-
        API key for authentication. You can generate this from the 16TMS
        console.

````