---
title: "Get users"
method: GET
path: "/Users"
tags: ["Users"]
---

# Get users

`GET /Users`

## Request

- Base URL: `https://api.peakon.com/api/scim/v2`
- URL: `https://api.peakon.com/api/scim/v2/Users`
- Auth: none declared

Returns all already provisioned users in the system. This operation supports pagination as described in  [the SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.4.2.4) . It also supports filtering by `userName`, `emails`, `externalId`, `id` (internal Peakon ID).

## Query parameters

- `filter` string
- `startIndex` integer
- `count` integer

## Response `200`

successful operation

- UserListResponse
  - `Resources` UserResponse[]: user list
    - `active` boolean: user status
    - `addresses` Address[]
      - `country` string
      - `locality` string
      - `postalCode` string
      - `region` string
      - `streetAddress` string
      - `type` 'work', required
    - `emails` Email[], required
      - `type` 'work', required
      - `value` string, required
    - `externalId` string: external unique resource id defined by provisioning client
    - `id` string: unique resource id
    - `name` Name, required
      - `familyName` string, required
      - `givenName` string, required
    - `phoneNumbers` PhoneNumber[]
      - `type` 'work' | 'mobile' | 'other', required
      - `value` string, required
    - `photos` Photo[]
      - `type` 'photo', required
      - `value` string, required
    - `schemas` string[], required
    - `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User` EnterpriseUser
      - `department` string
    - `userName` string, required: MUST be same as work type email address
    - `meta` Meta: resource metadata
      - `created` string, date-time
      - `lastModified` string, date-time
      - `location` string: resource location URI
      - `resourceType` 'User' | 'Group'
  - `itemsPerPage` integer
  - `schemas` string[]
  - `startIndex` integer
  - `totalResults` integer

## Other responses

- `400`: bad request
- `401`: authorization failure
- `403`: permissions denied
- `429`: too many requests
- `500`: internal server error

---

[API](https://skmtc.dev/peakon/apis/scim-2-0-api.md) - [All operations](https://skmtc.dev/peakon/apis/scim-2-0-api/llms.txt) - [OpenAPI document](https://skmtc.dev/peakon/apis/scim-2-0-api/revisions/4bddb3795891?raw)