Sessions

get

https://api.vygoapp.com/sessions

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

Query Params

programId

string

Filter results by program ID

sessionId

string

Filter by specific session ID

type

string

enum

Filter by session type

Allowed:

scheduledDateStart

date-time

Filter results by the time the session was scheduled to start in ISO 8601 format (inclusive)

scheduledDateEnd

date-time

Filter results by the time the session was scheduled to start in ISO 8601 format (exclusive)

updatedDateStart

date-time

Filter results by the time the session was last updated in ISO 8601 format (inclusive)

updatedDateEnd

date-time

Filter results by the time the session was last updated in ISO 8601 format (exclusive)

page

int32

Defaults to 1

Page number for paginated results

limit

int32

≤ 1000

Defaults to 10

Number of results per page (max 1000)

Headers

x-api-key

string

required

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

Responses

Language

Loading…

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