---
title: "GET /user"
method: GET
path: "/user"
tags: ["user"]
---

# GET /user

`GET /user`

## Request

- Base URL: `https://www.weclapp.com/api/nullapi/v2`
- URL: `https://www.weclapp.com/api/nullapi/v2/user`
- Auth: API key in header `AuthenticationToken`
- TypeScript: <https://skmtc.dev/weclapp/apis/weclapp-api/docs/user/get.ts> (a function with typed inputs; its response is checked against the schema)

query user

## Query parameters

- `page` integer
- `pageSize` integer
- `sort` string

## Response `200`

user response

- object
  - `result` User[]
    - `id` string
    - `version` string
    - `canEditDashboard` boolean
    - `createdDate` integer
    - `customAttributes` CustomAttribute[]
      - `attributeDefinitionId` string
      - `booleanValue` boolean
      - `dateValue` integer
      - `entityId` string
      - `entityReferences` EntityReference[]
        - `entityId` string
        - `entityName` string
      - `numberValue` string, number
      - `selectedValueId` string
      - `selectedValues` OnlyId[]
        - `id` string
      - `stringValue` string
    - `email` string, required
    - `faxNumber` string
    - `firstName` string
    - `imageId` string
    - `lastModifiedDate` integer
    - `lastName` string
    - `licenses` string[]
    - `mobilePhoneNumber` string
    - `phoneNumber` string
    - `status` 'ACTIVE' | 'DEPARTURE' | 'NOT_ACTIVE'
    - `superUser` boolean
    - `title` string
    - `userRoles` OnlyId[]
      - `id` string
    - `username` string

## Other responses

- `default`: error response

---

[API](https://skmtc.dev/weclapp/apis/weclapp-api.md) - [All operations](https://skmtc.dev/weclapp/apis/weclapp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/weclapp/apis/weclapp-api/revisions/0e021229755d?raw)