---
title: "List all system users"
method: GET
path: "/api/systemusers"
tags: ["Systemusers"]
---

# List all system users

`GET /api/systemusers`

## Request

- Base URL: `https://console.jumpcloud.com`
- URL: `https://console.jumpcloud.com/api/systemusers`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/docs/api/systemusers/get.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint returns all systemusers.

#### Sample Request

```
curl -X GET https://console.jumpcloud.com/api/systemusers \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'
```

## Query parameters

- `limit` integer
- `skip` integer
- `sort` string
- `fields` string
- `filter` string
- `search` string

## Headers

- `x-org-id` string

## Response `200`

OK

- Systemuserslist
  - `results` Systemuserreturn[]: The list of system users.
    - `_id` string
    - `account_locked` boolean
    - `account_locked_date` string, nullable
    - `activated` boolean
    - `admin` object, nullable
      - `id` string
      - `roleName` string
      - `roleNames` string[]
    - `addresses` object[]
      - `country` string
      - `extendedAddress` string
      - `id` string
      - `locality` string
      - `poBox` string
      - `postalCode` string
      - `region` string
      - `streetAddress` string
      - `type` string
    - `allow_public_key` boolean
    - `alternateEmail` string
    - `attributes` Attribute[]
      - `name` string
      - `value` string
    - `badLoginAttempts` integer
    - `company` string
    - `costCenter` string
    - `created` string
    - `department` string
    - `description` string
    - `disableDeviceMaxLoginAttempts` boolean
    - `displayname` string
    - `email` string
    - `employeeIdentifier` string: Must be unique per user.
    - `employeeType` string
    - `enable_managed_uid` boolean
    - `enable_user_portal_multifactor` boolean
    - `external_dn` string
    - `external_password_expiration_date` string
    - `external_source_type` string
    - `externally_managed` boolean: The externally_managed property has been deprecated. Whenever a user has their externally_managed field modified their restrictedFields property gets populated with the appropriate value, even if it is already set to a value an administrator manually set.
    - `firstname` string
    - `jobTitle` string
    - `lastname` string
    - `ldap_binding_user` boolean
    - `location` string
    - `manager` string: Relation with another systemuser to identify the last as a manager.
    - `mfa` Mfa
      - `configured` boolean
      - `exclusion` boolean
      - `exclusionUntil` string, date-time
      - `exclusionDays` integer
    - `mfaEnrollment` MfaEnrollment
      - `totpStatus` 'NOT_ENROLLED' | 'DISABLED' | 'PENDING_ACTIVATION' | 'ENROLLMENT_EXPIRED' | 'IN_ENROLLMENT' | 'PRE_ENROLLMENT' | 'ENROLLED'
      - `webAuthnStatus` 'NOT_ENROLLED' | 'DISABLED' | 'PENDING_ACTIVATION' | 'ENROLLMENT_EXPIRED' | 'IN_ENROLLMENT' | 'PRE_ENROLLMENT' | 'ENROLLED'
      - `pushStatus` 'NOT_ENROLLED' | 'DISABLED' | 'PENDING_ACTIVATION' | 'ENROLLMENT_EXPIRED' | 'IN_ENROLLMENT' | 'PRE_ENROLLMENT' | 'ENROLLED'
      - `smsStatus` 'NOT_ENROLLED' | 'DISABLED' | 'PENDING_ACTIVATION' | 'ENROLLMENT_EXPIRED' | 'IN_ENROLLMENT' | 'PRE_ENROLLMENT' | 'ENROLLED'
      - `overallStatus` 'NOT_ENROLLED' | 'DISABLED' | 'PENDING_ACTIVATION' | 'ENROLLMENT_EXPIRED' | 'IN_ENROLLMENT' | 'PRE_ENROLLMENT' | 'ENROLLED'
      - `jcGoStatus` 'NOT_ENROLLED' | 'DISABLED' | 'PENDING_ACTIVATION' | 'ENROLLMENT_EXPIRED' | 'IN_ENROLLMENT' | 'PRE_ENROLLMENT' | 'ENROLLED'
    - `middlename` string
    - `organization` string
    - `password_date` string, nullable
    - `password_expiration_date` string, nullable
    - `password_expired` boolean
    - `password_never_expires` boolean
    - `passwordless_sudo` boolean
    - `phoneNumbers` object[]
      - `id` string
      - `number` string
      - `type` string
    - `public_key` string
    - `recoveryEmail` object
      - `address` string
      - `verified` boolean
      - `verifiedAt` string
    - `relationships` object[]
      - `type` string
      - `value` string
    - `samba_service_user` boolean
    - `ssh_keys` Sshkeylist[]
      - `_id` string: The ID of the SSH key.
      - `create_date` string: The date the SSH key was created.
      - `name` string: The name of the SSH key.
      - `public_key` string: The Public SSH key.
    - `state` 'STAGED' | 'ACTIVATED' | 'SUSPENDED'
    - `sudo` boolean
    - `suspended` boolean
    - `tags` string[]
    - `totp_enabled` boolean
    - `unix_guid` integer
    - `unix_uid` integer
    - `username` string
    - `managedAppleId` string
    - `creationSource` string
    - `delegatedAuthority` object, nullable: Used by auth to determine password delegation authority
      - `name` 'ActiveDirectory': Authority name
      - `id` string: ObjectId of the target Active Directory connection
    - `restrictedFields` RestrictedField[]
      - `field` 'addresses' | 'company' | 'costCenter' | 'department' | 'description' | 'displayname' | 'email' | 'employeeIdentifier' | 'employeeType' | 'firstname' | 'jobTitle' | 'lastname' | 'location' | 'middlename' | 'password' | 'phoneNumbers' | 'sudo' | 'username'
      - `type` 'active_directory' | 'federated_identity_provider' | 'scim'
      - `id` string
  - `totalCount` integer: The total number of system users.

## Other responses

- `401`

---

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