---
title: "Users"
method: GET
path: "/v2/users"
tags: ["Routes", "Users"]
---

# Users

`GET /v2/users`

This request gets information about Users such as User Login, User Email etc.

Return data description

Property: username, Description: What a User uses to login.
Property: wage, Description: The hourly rate of an employee.
Property: active, Description: Determines if a user can log into Limble or not.
Property: emailNotificationActive, Description: Determines if a User gets Email Notifications From Limble.
Property: pushNotificationActive, Description: Determines if a User gets Push Notifications From Limble.
Property: workdayHours, Description: The number of hours a day this employee works.
Property: dateAdded, Description: The date a user was added to Limble. This is a unix timestamp.
Property: teams, Description: What Teams a User has at specific Locations.

## Query parameters

- `users` integer
- `name` string
- `roles` integer
- `teams` string
- `cursor` integer
- `limit` integer

## Response `200`

Users

- User[]
  - `userID` integer
  - `username` string
  - `email` string, email
  - `phone` string, utc-millisec
  - `firstName` string
  - `lastName` string
  - `wage` integer
  - `active` string
  - `emailNotificationActive` string
  - `pushNotificationActive` string
  - `workdayHours` integer
  - `dateAdded` integer
  - `teams` object[]
    - `teamID` integer
    - `locationID` integer
    - `name` string
  - `roles` object[]
    - `roleID` integer
    - `locationID` integer
    - `name` string

## Other responses

- `400` — The request was malformed — either invalid JSON syntax or a validation failure (missing required field, wrong type, etc.).
- `401` — No `Authorization` header was provided on the request.
- `403` — The supplied credentials are invalid, the customer account is inactive, or the credentials do not have permission to perform this action.
- `429` — The per-minute or per-hour rate limit for this credential and method has been exhausted. Inspect the `X-RateLimit-*` headers to determine when to retry.
- `500` — An unhandled server-side error. The body message is generic (`System unavailable...`) when the underlying cause is a database fault; otherwise it reflects the raised error.

---

[API](https://skmtc.net/limblecmms/apis/limble-api-v2.md) · [All operations](https://skmtc.net/limblecmms/apis/limble-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/limblecmms/limble-api-v2/revisions/20801e23f7f2/schema)