---
title: "List Users"
method: GET
path: "/users"
tags: ["User Management", "Users"]
---

# List Users

`GET /users`

## Request

- Base URL: `https://api.synup.com/api/v4`
- URL: `https://api.synup.com/api/v4/users`
- Auth: none required
- TypeScript: <https://skmtc.dev/synup/apis/synup-api/docs/users/get.ts> (a function with typed inputs; its response is checked against the schema)

This API retrieves a paginated list of all users in the system.

**Pagination:**
- Uses cursor-based pagination for efficient data retrieval.
- Returns up to 50 users per request.
- Includes pageInfo for navigating through results.

## Headers

- `Authorization` string

## Response `200`

Successfully retrieved users

- UsersResponseV2
  - `data` object
    - `users` object
      - `totalCount` integer: Total number of users in the system
      - `pageInfo` PageInfoV6
        - `hasNextPage` boolean: Indicates if there are more pages after the current page
        - `hasPreviousPage` boolean: Indicates if there are previous pages before the current page
        - `total` integer: Number of items in the current page
        - `endCursor` string: Cursor for the last item in the current page
      - `edges` UserEdgeV2[]
        - `cursor` string: Unique cursor for this user record
        - `node` UserV2
          - `id` string, required: Unique identifier for the user
          - `email` string, email, required: User's email address
          - `firstName` string, required: User's first name
          - `lastName` string, nullable: User's last name (optional)
          - `customRole` object, required
            - `id` string: Role identifier
            - `name` string: Role name
          - `directCustomer` boolean, required: Indicates if the user is a direct customer
          - `createdAt` string, date-time, required: Timestamp when the user was created
          - `inviteStatus` 'ACTIVE' | 'INVITE_SENT' | 'RESEND_INVITE', required: Current status of the user's invitation

## Other responses

- `401`: Unauthorized - Valid API key required
- `403`: Forbidden - Insufficient permissions to list users

---

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