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

# Get Users

`GET /users`

## Request

- Base URL: `https://env.unqork.io/api/1.0`
- URL: `https://env.unqork.io/api/1.0/users`
- Auth: OAuth 2
  - Client credentials
  - Password
  - Token URL: `https://xyzfinancial.unqork.io/api/1.0/oauth2/access_token`
- TypeScript: <https://skmtc.dev/unqork/apis/unqork-customer-api/docs/users/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns Express user objects. This is a paged endpoint (see Paging).
### Authorization Required:
  - Designer Administrator

## Query parameters

- `limit` integer
- `sort` string
- `filter` string
- `showServiceUsers` boolean

## Response `200`

Users

- UserResponse[]
  - `userId` string, required
  - `name` string, required
  - `email` string, required
  - `phone` string
  - `role` string: One of the roles configured in Unqork
  - `expressRoles` string[]: Express roles configured in Unqork
  - `groups` string[]: List of groups configured in Unqork
  - `applicationRoles` object: Map of applications to roles
  - `created` string, date-time, required
  - `modified` string, date-time, required
  - `isServiceUser` boolean
  - `lastLogin` string, date-time
  - `...customAttributes` string: Custom attributes will be included as additional keys in the response body.

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/unqork/apis/unqork-customer-api.md) - [All operations](https://skmtc.dev/unqork/apis/unqork-customer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/unqork/apis/unqork-customer-api/revisions/13dad4096373?raw)