Skip to main content
GET
/
v1
/
users
List users
curl --request GET \
  --url https://api.hyperline.co/v1/users \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0
  },
  "data": [
    {
      "id": "usr_DKL4Xcb5VSa8CQ",
      "email": "john@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "picture_url": null,
      "role_id": "rol_DKL4Xcb5VSa8CQ",
      "is_account_owner": false
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

take
number | null
default:50
Required range: 0 <= x <= 100
skip
number | null
default:0
Required range: x >= 0
first_name
string
first_name__not
string
first_name__isNull
string
first_name__isNotNull
string
first_name__equals
string
first_name__contains
string
first_name__startsWith
string
first_name__endWith
string
last_name
string
last_name__not
string
last_name__isNull
string
last_name__isNotNull
string
last_name__equals
string
last_name__contains
string
last_name__startsWith
string
last_name__endWith
string
email
string
email__not
string
email__isNull
string
email__isNotNull
string
email__equals
string
email__contains
string
email__startsWith
string
email__endWith
string

Response

200 - application/json
meta
object
required
data
object[]
required

List of User.