Tips & Tricks
Technical / API Documentation
Authenticating and using the EdApp API
How to authenticate with the EdApp API, and other general guidelines.
To authenticate with the EdApp API, an access token is needed. An access token can be acquired via the EdApp admin portal, under Account Settings → API Details. The access token needs to be passed via the HTTP Authorization header with the Bearer prefix. For example, with curl, the format would be:
curl https://rest.edapp.com/v2/users -H 'Authorization: Bearer a56cd0ac-11c2-11e6-a148-3e1d07dcef63'
All parameters passed in the query string must be url encoded. Parameters can be used to make queries by logical groupings, like date range, or filter by course, lesson, user, etc.
Most EdApp v2 API’s use paging to limit the size of the responses. You can provide the following query string parameters to requests that support pagination:
- page: defaults to 1.
- pageSize: defaults to 25, with a maximum of 1000 records per page.
You can check if a request supports pagination in our API specification.