---
title: "User"
url: "https://developer.retailexpress.com.au/apis/retail-express-api-21-v2/versions/210b509a-613e-44ac-a87b-ef6c22c23a2c/schemas/User"
---

> Full API specification: https://developer.retailexpress.com.au/apis/retail-express-api-21-v2/versions/210b509a-613e-44ac-a87b-ef6c22c23a2c.md

# User

User model

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Retail Express API
  version: v2.1
servers:
  - url: https://api.retailexpress.com.au/v2.1
components:
  schemas:
    UserSecurityProfile:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Id
          format: int32
          nullable: true
        name:
          type: string
          description: Security profile name
          nullable: true
      additionalProperties: false
      description: User security profile model
    UserOutlet:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Id.
          format: int32
        name:
          type: string
          description: Name.
          nullable: true
      additionalProperties: false
      description: User outlet model
    User:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Id.
          format: int32
          nullable: true
        user_code:
          type: string
          description: User code.
          nullable: true
        first_name:
          type: string
          description: First name.
          nullable: true
        surname:
          type: string
          description: Surname.
          nullable: true
        security_profile:
          $ref: "#/components/schemas/UserSecurityProfile"
        is_admin:
          type: boolean
          description: Is admin.
        enabled:
          type: boolean
          description: Is enabled.
          nullable: true
        modified_on:
          type: string
          description: Modified on
          format: date-time
          nullable: true
        outlets:
          type: array
          items:
            $ref: "#/components/schemas/UserOutlet"
          description: Contain list of outlets that user has access to
          nullable: true
        stock_outlets:
          type: array
          items:
            $ref: "#/components/schemas/UserOutlet"
          description: Contain list of stock outlets that user has access to
          nullable: true
      additionalProperties: false
      description: User model
```