OneRoster 1.2
Queries and sync
Paging, filtering, sorting, field selection and delta sync.
Parameters
| Parameter | Meaning | Example |
|---|---|---|
limit, offset | Paging; limit 1–1000, default 100 | limit=200&offset=400 |
filter | = != > >= < <= ~ (contains); join with AND or OR; values in single quotes; dotted paths for nested fields | filter=identifier='SV2026001' |
sort, orderBy | Sort by one field, asc or desc; text in Vietnamese alphabetical order (Đ after D), numbers in text by value (SV9 before SV10) | sort=familyName&orderBy=asc |
fields | Return only these fields | fields=sourcedId,identifier,email |
Notes: URL-encode values; one filter uses only AND or only OR; ~ ignores case; an unknown field in filter or sort returns 400; sort takes top-level fields only, filter also takes dotted paths.
Paging
List responses carry X-Total-Count (matching records) and Link (first, prev, next, last).
Delta sync
Every record has dateLastModified. Keep the start time of each sync and ask only for what changed since:
GET /ims/oneroster/rostering/v1p2/users?filter=dateLastModified>'2026-11-10T00:00:00.000Z'Removed records are still returned with status = tobedeleted. The platform never hard-deletes.