DocumentationChangelog
Log In
Documentation

Users

get
https://api.vygoapp.com/users

This request allows you to retrieve user data from the Vygo platform.

Query Params
date-time

The initial date of the range for filtering users by their creation dates, specified in ISO 8601 format (inclusive)

date-time

The final date of the range for filtering users by their creation dates, specified in ISO 8601 format (exclusive)

date-time

The initial date of the range for filtering users by their update dates, specified in ISO 8601 format (inclusive)

date-time

The final date of the range for filtering users by their update dates, specified in ISO 8601 format (exclusive)

string

A search term to filter users by their user_id, email, first_name, last_name, student_id, external_id, role

string
enum
Defaults to created_at

The field to sort users by. Supported fields include: user_id, first_name, last_name, student_id, external_id, created_at, updated_at,role

string
enum
Defaults to desc

The order to sort users by. Supported orders include: asc, desc

Allowed:
int32

Page number

int32

Results per page

Headers
string
required

You must provide your API key in the header of each request.

Responses

Updated about 1 year ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago