Skip to main content
GET
/
v1
/
users
List users
curl --request GET \
  --url http://localhost:4000/v1/users \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "users": [
      {
        "id": 123,
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "phoneNumber": "<string>",
        "timeZone": "<string>",
        "profilePicture": "<string>",
        "verified": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "deletedAt": "<unknown>"
      }
    ],
    "count": 123
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer
default:20
Required range: 1 <= x <= 100
​
page
integer
default:0
Required range: x >= 0
​
search
string
​
ids
string

Response

List of users and total count

​
data
object
required