Skip to content
/Users

List all users

Request

Security
form_session or user_session or component_session or component_token or api_token
Query
emailstring
external_idstring
pagestring(NumberFromString)

a string to be decoded into a number

per_pagestring(NumberFromString)

a string to be decoded into a number

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/users?email=string&external_id=string&page=string&per_page=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
dataArray of objects(User)required
totalnumberrequired
current_pagenumberrequired
per_pagenumberrequired
total_pagesnumber
Response
{
  "data": [
    { … }
  ],
  "total": 0,
  "current_page": 0,
  "per_page": 0,
  "total_pages": 0
}