Skip to main content
GET
/
users
/
searchUsers
Search users
curl --request GET \
  --url https://api-dev.iclosed.io/users/searchUsers \
  --header 'Authorization: Bearer <token>'
{
  "count": 25,
  "data": [
    {
      "id": 123,
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "phoneNumber": "+1234567890",
      "lastLoggedIn": "2024-01-15T10:30:00Z",
      "verified": true,
      "invited": true,
      "timeZone": "America/New_York",
      "isCompleted": true,
      "createdAt": "2024-01-15T10:30:00Z",
      "deletedAt": null
    }
  ]
}

Authorizations

Authorization
string
header
required

API key required in 'Authorization' header. Format: iclosed-<token>

Query Parameters

email
string

Search users by email address

name
string

Search users by first name or last name

phoneNumber
string

Search users by phone number

page
integer
default:0

Page number for pagination (0-based)

Required range: x >= 0
limit
integer
default:50

Number of records per page (max 50)

Required range: 1 <= x <= 50

Response

Successfully retrieved users

count
integer

Total number of users matching the filters

data
object[]

Array of users for the current page

I