Profile Resource

The Profile resource provides access to all data sets and parameters available to the client.

Get all options and available parameters This endpoint is part of the Base package

View in API Navigator

The /profile/ endpoint gives access to a listing of allowed data sets and parameters. These values can then be used as parameter values in subsequent API requests.

Get a listing of available data sets and parameters in the client profile

Request

GET /profile/

Response

This endpoint returns a Profile JSON object. This is a description of the fields contained in the object

Table 1 - Profile object

Field Description Type
standards_setsA list of standards sets the profile has access tolist
standards_sets.set_idAn identifier for the standards setstring
standards_sets.nameName of the standards setstring
Standards_set.parent (optional)Name of the parent group the standards set belongs tostring
content_sets (optional)A list of content sets the profile has access tolist
content_sets.set_idAn identifier for the content setinteger
content_sets.nameName of the content setstring
subjectsA list of subject areas the profile has access tolist (string)
gradesA list of grades the profile has access tolist (string)
textbooks (optional)A list of textbooks the profile has access tolist
textbooks.textbook_idAn identifier for the textbookstring
textbooks.nameTitle of the textbookstring
textbooks.thumbnail (optional)URL of a thumbnail of the textbook’s converstring