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

# Get Users

`GET /users`

Use this endpoint to get the list of users for a company. The status filter can be used to filter users based on status - active, inactive, archived, or deleted.  By default, only active users will be returned. This endpoint will return a paginated response starting from the given record index.

## Query parameters

- `pageSize` integer
- `recordStartIndex` integer
- `status` string

## Response `200`

OK

- CompanyUserCollection — Base structure for all paginated collection responses. This provides consistent pagination metadata across all collection endpoints.
  - `count` integer — The total number of items available across all pages. Use this to calculate the total number of pages available.
  - `pageSize` integer — The number of items per page in this response. This reflects either your requested page size or the default value.
  - `pageStartIndex` integer — The starting index of this page of results. Use with pageSize to track your position in the overall result set.
  - `items` CompanyUser[]
    - `id` string, uuid — The unique ID of the Company User.
    - `displayName` string — The display name of the user.
    - `firstName` string — The user's first name.
    - `lastName` string — The user's last name.
    - `initials` string — The user's initials.
    - `role` CompanyUserRole
      - `id` integer — The id/enum value of the user role.
      - `name` 'Company Administrator' | 'Location Administrator' | 'Manager' | 'Office' | 'Sales' | 'Crew' — The name of the role.
    - `status` 'Active' | 'Inactive' | 'Archived' | 'Deleted' — the status of this user account.
    - `phone` string — The user's phone number.
    - `mobilePhone` string — The user's mobile phone number.
    - `email` string — The user's email address.
    - `_link` string — The unique URI of the AccuLynx User.

## Other responses

- `400` — Bad Request - The server cannot process the request due to a client error. Common causes: - Invalid request format - Missing required fields - Validation errors in the request data
- `401` — Unauthorized - Authentication is required or has failed. Common causes: - Missing API key - Invalid API key - Expired or deactivated API key
- `416` — Range Not Satisfiable - The requested page of results is not available. Common causes: - pageStartIndex is beyond the available data range - Invalid pagination parameters

---

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