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

# List Users by ID

`GET /users-by-ids`

## Request

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

This API retrieves user details for one or more specified user IDs in a single request.

**Behavior:**
- Supports fetching multiple users by providing a list of user IDs.
- Returns detailed user information, including role, status, and attributes.

## Query parameters

- `userIds` string[], required

## Headers

- `Authorization` string

## Response `200`

Successfully retrieved user details

- UsersByIdsResponse
  - `data` object
    - `usersByIds` UserDetailV2[]
      - `id` string, required: Unique identifier for the user
      - `firstName` string, required: User's first name
      - `lastName` string, nullable: User's last name
      - `email` string, email, required: User's email address
      - `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
      - `preferences` object
        - `locale` string: User's locale preference
        - `dateFormat` string, nullable: User's preferred date format
        - `timezone` string, nullable: User's timezone preference

## Other responses

- `400`: Bad Request - Invalid user IDs format
- `401`: Unauthorized - Valid API key required

---

[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)