Table of Contents
Fields
Field | Name | Description | Type | Required |
---|---|---|---|---|
uid | User ID | The user ID of the listed user | integer | |
name | User display name | The display name of the listed user | string |
Operations
list
View a list of users in the given user’s network. The following query strings can (optionally) be appended to the path to filter results:
- search: show only results matching the given search string. Matching is a case-insensitive comparison performed on user names for both exact and partial phrases (i.e. searching for ‘john’ will return users named ‘John Doe’ and ‘William johnson’).
- page: the current response body limit is 30 records per page. Use this query string to specify which page of the results you’d like to see.
- NOTE: If you are looking for a list of users in the given users school, you should make a call to https://api.schoology.com/v1/users. For more information see: API - User.
Path | |
Content | none |
Return | A collection of network objects, each one containing network fields JSON XML
|