Users

get

https://api.vygoapp.com/users

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

Query Params

createdDateStart

date-time

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

createdDateEnd

date-time

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

updatedDateStart

date-time

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

updatedDateEnd

date-time

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

searchTerm

string

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

sortField

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

order

string

enum

Defaults to desc

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

Allowed:

page

int32

Page number

limit

int32

Results per page

Headers

x-api-key

string

required

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

Responses

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response

400Bad request

401Unauthorized

429Too Many Requests