Users

This request allows you to retrieve user data from the Vygo platform. It returns everything the Update Users request can change, so you can read a user's current state before updating it.

Answers to onboarding questions with a dedicated field (study stage, courses, education attainment, areas of expertise, demographic identification) are returned as top-level arrays. Answers to any other tag group you have configured with a mapping field name are returned in the tags object, keyed by that mapping field name, which are the same keys the Update Users request accepts. Use the Tag Groups request to see the valid tags for each field.

Updating: a field sent to Update Users replaces that field's answers in full. Send a field only when you intend to set its complete new value, and omit fields you don't want to change. Values in tags are tag labels, matching what Update Users accepts. Values in custom_answers are free-text answers and are read-only context. To preserve one, keep the group's own tag label (e.g. Other) in the tags values you send; sending the free text itself will not match any tag.

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

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