List users
List users in an Apple School Manager organization.
URL
GET https://api-school.apple.com/rosterapi/v1/usersQuery Parameters
| Name | Type | Description |
|---|---|---|
limit Optional | string | The maximum amount of user objects to return. The default is 100. |
pageToken Optional | string | A token to retrieve the next set of records when the number of users is greater than the |
role Optional | string | The role of the user in the organization. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | Users | The request was successful. |
| 401 | Unauthorized | The access token was invalid. | |
| 403 | Forbidden | Access to the requested user was forbidden. | |
| 429 | The client made too many requests. The response includes an | ||
| 500 | Internal Server Error | The server encountered an internal error. |