Skip to content
SynupAPI
Get an API key
GETapi.synup.com/api/v4/users-by-ids

List Users by ID

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.
Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Query

NameTypeRequiredDescription
userIdsarrayrequiredArray of user IDs to fetch details for

Request

Request
curl -X GET 'https://api.synup.com/api/v4/users-by-ids?userIds=' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json'

Responses

StatusDescription
200Successfully retrieved user details
400Bad Request - Invalid user IDs format
401Unauthorized - Valid API key required
Example response
{
  "data": {
    "usersByIds": [
      {
        "id": "VXNlcjoxNjUyMDY=",
        "firstName": "user",
        "lastName": "user",
        "email": "subasrisridhar879+1@gmail.com",
        "customRole": {
          "id": "Q3VzdG9tUm9sZTo0NDUyMg==",
          "name": "Admin"
        },
        "directCustomer": true,
        "createdAt": "2025-02-02 06:57:41 UTC",
        "inviteStatus": "RESEND_INVITE",
        "preferences": {
          "locale": "en-US",
          "dateFormat": null,
          "timezone": null
        }
      }
    ]
  }
}

Response body

NameTypeRequiredDescription
dataobjectoptional
data.usersByIdsarray of objectoptional
data.usersByIds[].idstringrequiredUnique identifier for the user
data.usersByIds[].firstNamestringrequiredUser's first name
data.usersByIds[].lastNamestringoptionalUser's last name
data.usersByIds[].emailstringrequiredUser's email address
data.usersByIds[].customRoleobjectrequired
data.usersByIds[].customRole.idstringoptionalRole identifier
data.usersByIds[].customRole.namestringoptionalRole name
data.usersByIds[].directCustomerbooleanrequiredIndicates if the user is a direct customer
data.usersByIds[].createdAtstringrequiredTimestamp when the user was created
data.usersByIds[].inviteStatusstringrequiredCurrent status of the user's invitation
ACTIVEINVITE_SENTRESEND_INVITE
data.usersByIds[].preferencesobjectoptional
data.usersByIds[].preferences.localestringoptionalUser's locale preference
data.usersByIds[].preferences.dateFormatstringoptionalUser's preferred date format
data.usersByIds[].preferences.timezonestringoptionalUser's timezone preference