Search

Search users, schools, groups and courses.

Table of Contents

Fields

There are 3 different types of search results: users, groups, and courses. Depending on the type of search result, the result object will contain different properties.

User search result object

Field Name Description Type Required
uid User ID

The user id of the user

 integer
name User display name

The display name of the user

 string
picture_url User picture URL

The full URL of the user’s profile picture

 string
school School display name

The display name of the user’s school

 string
school_id School ID

The id of the user’s school

 integer

Course search result object

Field Name Description Type Required
id Course ID

The id of the course

 integer
course_title Course title

The display name of the course

 string
dep_code Department code

The course’s department code

 string
course_code Course Code

The course code

 string
course_description Course description

The course description

 string
picture_url The course's profile picture URL

The full URL of the course’s profile picture

 string
school School display name

The display name of the user’s school

 string
school_id School ID

The id of the user’s school

 integer

Group search result object

Field Name Description Type Required
id Group ID

The id of the group

 integer
group_title Group title

The display name of the group

 string
picture_url The group's profile picture URL

The full URL of the group’s profile picture

 string
school School display name

The display name of the group’s school

 string
school_id School ID

The id of the group’s school

 integer

Operations

There is only 1 operation available for search, the GET list call. The 2 URL parameters used with this call are ‘keywords’ and ‘type’. The ‘keyword’ parameter is used to specify the search phrase. The ‘type’ parameter is used to specify which, if any, search type result you want to limit your search to. For example, if you want to search for users named ‘Avilo’, the URI would look something like this:

 /search?keywords=avilo&type=user

Note that all searches are case-insensitive.

Path

GET https://api.schoology.com/v1/search

Content

none
Return

A collection of search objects, each one containing search fields. JSON

JSON 
{
    "users": {
        "search_result": [
            {
                "uid": "48289",
                "name": "James Howlett",
                "picture_url": "http:\/\/...",
                "school": "Hill Valley High School",
                "school_id": "344232"
            }
        ],
        "total": 1,
        "links": {
            "self": "http:\/\/...&limit=10&page=0"
        }
    }
}
XML 
<?xml version="1.0" encoding="utf-8" ?>
<result>
    <users>
        <search_result>
            <uid>48289</uid>
            <name>James Howlett</name>
            <picture_url>http:\/\/...</picture_url>
            <school>Hill Valley High School</school>
            <school_id>344232</school_id>
        </search_result>
        <total>1</total>
        <links>
            <self>http:\/\/...&amp;limit=10&amp;page=0</self>
        </links>
    </users>
</result>