Back to list

search/{API key}/

The workhorse of the site. Search for lessons and Companion Resources in the Curriculum Matrix.

Extra Parameters:
Parameter API key
Type (20 character) string
Description This key is given to you by a national administrator.
GETParameter findlesson
Description A flag indicating searching for lessons
Example https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?findresource&findlesson&search=apples
GETParameter findresource
Description A flag indicating searching for Companion Resources
Example https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?search=apples&findresource
GETParameter search
Type url-encoded string
Description Indicates the search term returned from search bar
Example https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?findlesson&search=apples
GETParameter commoncore
Type number -or- string
Description A comma separated list of Common Core standard group (identifiers or constants) to search with.
Examples https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?findlesson&search=apples&commoncore=2,4
https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?findlesson&search=apples&commoncore=READ,WRITE
GETParameter grade
Type number -or- string
Description A comma separated list of grade abbreviations or grade band abbreviations to search with.
Example https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?findlesson&search=apples&grade=K,1,2
https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?findlesson&search=apples&grade=MS,EE
GETParameter contentarea
Type number -or- string
Description A comma separated list of Content Area (identifiers or constants) to search with.
Examples https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?findlesson&search=apples&contentarea=2,4
https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?findlesson&search=apples&contentarea=GEOGRAPHY,HISTORY
GETParameter theme
Type number -or- string
Description A comma separated list of theme (identifiers or constants) to search with.
Example https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?findlesson&search=apples&theme=5
https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?findlesson&search=apples&theme=ANIMALS,CULTURE
GETParameter mediatype
Type number(s) -or- string
Description A comma separated list of media type (identifiers or constants) to search with.
Examples https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?findresource&search=apples&mediatype=2,4
https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?findresource&search=apples&mediatype=POSTER
GETParameter currentlessonpage
Type number
Description Used in pagination, the current lesson page - used in conjunction with "lessonlimit"
Examples https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?findlesson&search=apples&currentlessonpage=2
GETParameter lessonlimit
Type number
Description Used in pagination, the maximum number of lesson results that should be returned from the search - used in conjunction with "currentlessonpage"
Examples https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?findlesson&search=apples&lessonlimit=10
GETParameter currentresourcepage
Type number
Description Used in pagination, the current Companion Resource page - used in conjunction with "resourcelimit"
Examples https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?findresource&search=apples&currentresourcepage=2
GETParameter resourcelimit
Type number
Description Used in pagination, the maximum number of Companion Resource results that should be returned from the search - used in conjunction with "currentresourcepage"
Examples https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?findresource&search=apples&resourcelimit=10
GETParameter locationonly
Description A flag to only return lessons that have been saved as "APPROVE-LOCATION". The API will look at the API key of the call first, but the key can be overridden by adding the "locationoverride" parameter with a location "id". Using this flag will cause the search call to not be tracked.
Examples https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?findlesson&search=agriculture&locationonly
GETParameter locationoverride
Type number
Description (Developer or admin only) Used with the "locationonly" override, this overrides the API key and tells the API which location to use. This number is given in the "/location" call. There can only be ONE identifier.
Examples https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?findlesson&search=apples&locationonly&locationoverride=10
GETParameter featured
Description Only return lessons and Companion Resources marked as "Featured" on the backend and scheduled to be shown on the frontend.
Examples https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?findlesson&search=agriculture&featured
GETParameter majorasc / majordesc
Description Sorts lessons (not Companion Resources) by the last major revision, either ASC (oldest first) or DESC (newest first)
Examples https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?findresource&search=agriculture&majorasc
https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?findresource&search=agriculture&majordesc
GETParameter notrack
Description (Developer or admins only) Tells the search API not to track this call
Examples https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?findresource&search=agriculture&notrack
GETParameter showsaved
Description (Developer or admins only) An override to get all of the lessons marked "SAVED".
Examples https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?findresource&search=agriculture&showsaved
GETParameter showreview
Description (Developer or admins only) An override to get all of the lessons marked "UNDER-REVIEW".
Examples https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?findresource&search=agriculture&showreview
GETParameter showprivate
Description (Developer or admins only) An override to get all of the lessons marked "APPROVE-PRIVATE".
Examples https://api.agclassroom.org/api/search/ade32765c9f5487efa15/?findresource&search=agriculture&showprivate

HTTP Method

 GET

Requires authentication:

 Yes

Return Format:

 JSON

Return Example:

{

success:true

message:Found.

lessoncount:8

resourcecount:23

paginated:false

lessons: [...]

0 {...}

id:374

title:A is for Apples

purpose:Students will use the five senses to investigate apples, identify and model the parts of an apple, make applesauce, and learn how apples are grown.

grades:7-9

band:Middle School

cover_image:https://cdn.agclassroom.org/media/uploads/test.jpg

cover_author:Yasuko Grow / Lynn Wallin

cover_alt:A test image for the API

cover_source:National Ag in the Classroom

1 {...}

id:673

title:An Apple a Day Keeps the Doctor Away

purpose:Students will explore organic and conventional farming practices by analyzing multimedia texts to investigate the differences between conventionally and organically grown apples.

grades:K-2

band:Early Elementary School

cover_image:https://cdn.agclassroom.org/media/uploads/test.jpg

cover_author:Lynn Wallin / Yasuko Grow

cover_alt:A test image for the API

cover_source:National Ag in the Classroom

2 {...}

. . .

resources: {...}

ACTIVITY {...}

media:2

shorttitle:ACTIVITY

title:Activity

count:2

resources: [...]

0 {...}

id:132

mediatype:Activity

title:Farm Pop-Ups

description:Students use this template to create a pop-up game to reinforce agricultural concepts....

thumbnail:https://cdn.agclassroom.org/media/uploads/test.jpg

cover_image:https://cdn.agclassroom.org/media/uploads/test.jpg

cover_author:Yasuko Grow / Lynn Wallin

cover_alt:A test image for the API

cover_source:National Ag in the Classroom

1 {...}

id:847

mediatype:Activity

title:The Very Hungry Western Caterpillar

description:Based off of Erik Carle's "Very Hungry Caterpillar", this caterpillar takes a journey....

thumbnail:https://cdn.agclassroom.org/media/uploads/CR1010/test.jpg

cover_image:https://cdn.agclassroom.org/media/uploads/CR1010/test.jpg

cover_author:Debra Speilmaker

cover_alt:A test image for the API

cover_source:National Ag in the Classroom

BOOK {...}

. . .

}