---
title: "Get user"
url: "https://nov18-dev.movespot.fyi/apis/internal-insomnia-api-v3-dev-3/versions/2ce2387b-9064-4a0f-8d1e-9764d7953a0a/operations/get-user"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/internal-insomnia-api-v3-dev-3/versions/2ce2387b-9064-4a0f-8d1e-9764d7953a0a.md

# Get user

`GET` `/users/{userId}`

Operation ID: `get-user`

Retrieve the profile of the specified user.

## Path parameters

- `userId` (string, required) - The user ID

## Responses

- `200` - A single user profile response
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Internal Insomnia API V3
  version: 3.1.4
servers:
  - url: https://api.insomnia.rest/v3
    description: Base URL for the Insomnia API
paths:
  /users/{userId}:
    get:
      operationId: get-user
      summary: Get user
      description: Retrieve the profile of the specified user.
      parameters:
        - name: userId
          in: path
          description: The user ID
          required: true
          schema:
            type: string
          example: usr_abc123
      responses:
        "200":
          $ref: "#/components/responses/UserResponse"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      security:
        - oktaOAuth: []
      x-permission: authenticated
security:
  - oktaOAuth: []
components:
  responses:
    UserResponse:
      description: A single user profile response
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/User"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    User:
      description: The user's full profile
      type: object
      properties:
        id:
          description: Unique identifier for the user
          type: string
          example: usr_abc123
          readOnly: true
        first_name:
          description: The user's first name
          type: string
          example: Jane
        last_name:
          description: The user's last name
          type: string
          example: Doe
        picture:
          description: URL to the user's profile picture
          type: string
          format: uri
          example: https://cdn.insomnia.rest/avatars/usr_abc123.jpg
        email:
          $ref: "#/components/schemas/EmailAddress"
        emails:
          description: All email addresses associated with the user
          type: array
          items:
            $ref: "#/components/schemas/UserEmail"
          readOnly: true
        is_externally_provisioned:
          description: Indicates the user was provisioned externally (e.g., via SCIM).
            When true, profile fields (first_name, last_name, email, emails,
            picture) cannot be updated by the user.
          type: boolean
          example: false
          readOnly: true
        encryption_enabled:
          description: Whether end-to-end encryption is enabled for this user
          type: boolean
          example: false
          readOnly: true
        created_at:
          description: The date and time the user account was created
          type: string
          format: date-time
          example: 2024-01-15T08:30:00Z
          readOnly: true
      required:
        - id
        - first_name
        - last_name
        - email
        - emails
        - is_externally_provisioned
        - encryption_enabled
        - created_at
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    EmailAddress:
      description: The email address
      type: string
      format: email
      example: jane.doe@example.com
    UserEmail:
      description: An email address associated with a user
      type: object
      properties:
        email:
          $ref: "#/components/schemas/EmailAddress"
        is_primary:
          description: Whether this is the user's primary email
          type: boolean
          example: true
      required:
        - email
        - is_primary
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
  examples:
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    oktaOAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
```
