> ## Documentation Index
> Fetch the complete documentation index at: https://dev.schoolcues.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List a collection

> A page of a collection’s entities, under the collection’s own key, such as `users`. The total before paging is in `X-Total-Count`.



## OpenAPI

````yaml /reference/oneroster.json get /ims/oneroster/v1p1/{collection}
openapi: 3.1.0
info:
  title: SchoolCues OneRoster 1.1
  version: '1'
  description: >-
    Give roster tools the school’s classes, teachers, students and enrollments.
    Generated from @schoolcues/contracts by `pnpm docs:api`; don't edit it by
    hand.
servers:
  - url: https://portal.schoolcues.com
    description: Production
security: []
tags:
  - name: Access Tokens
  - name: Collections
paths:
  /ims/oneroster/v1p1/{collection}:
    get:
      tags:
        - Collections
      summary: List a collection
      description: >-
        A page of a collection’s entities, under the collection’s own key, such
        as `users`. The total before paging is in `X-Total-Count`.
      operationId: list_oneroster_collection
      parameters:
        - name: collection
          in: path
          required: true
          description: >-
            The collection. `schools`, `terms`, `students` and `teachers` are
            OneRoster’s views of `orgs`, `academicSessions` and `users`.
          schema:
            type: string
            enum:
              - orgs
              - schools
              - academicSessions
              - terms
              - courses
              - classes
              - users
              - students
              - teachers
              - enrollments
        - name: limit
          in: query
          required: false
          description: >-
            Entities per page, a whole number from 1 to 1000. The default is
            100.
          schema:
            type: integer
        - name: offset
          in: query
          required: false
          description: How many entities to skip. The default is 0.
          schema:
            type: integer
        - name: sort
          in: query
          required: false
          description: The field to sort by.
          schema:
            type: string
            maxLength: 60
        - name: orderBy
          in: query
          required: false
          description: The sort order. The default is `asc`.
          schema:
            type: string
            enum:
              - asc
              - desc
        - name: filter
          in: query
          required: false
          description: >-
            OneRoster's filter, such as `role='student'`, with `=`, `!=`, `>`,
            `>=`, `<`, `<=` or `~` (contains), joined by ` AND ` or ` OR ` (not
            both).
          schema:
            type: string
            maxLength: 1000
        - name: fields
          in: query
          required: false
          description: Only these fields, separated by commas.
          schema:
            type: string
            maxLength: 1000
      responses:
        '200':
          description: The entities.
          headers:
            X-Total-Count:
              description: How many entities match, across every page.
              schema:
                type: integer
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: array
                  items:
                    type: object
                    description: >-
                      A OneRoster 1.1 entity, as the OneRoster specification
                      defines it.
                    additionalProperties: true
              example:
                users:
                  - sourcedId: 7d9e8f1a-2b3c-4d5e-8f6a-7b8c9d0e1f2a
                    status: active
                    dateLastModified: '2026-11-16T01:02:03.456Z'
                    username: alex.rivera@school.example
                    userIds: []
                    enabledUser: 'true'
                    givenName: Alex
                    familyName: Rivera
                    middleName: ''
                    role: student
                    identifier: '10423'
                    email: alex.rivera@school.example
                    sms: ''
                    phone: ''
                    agents: []
                    orgs:
                      - href: >-
                          /ims/oneroster/v1p1/orgs/f3b1c2d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d
                        sourcedId: f3b1c2d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d
                        type: org
                    grades:
                      - '07'
        '400':
          description: >-
            A query parameter isn’t valid. The message says which. Fix the
            request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: >-
            The key or token is missing, revoked or expired. Ask the school for
            a new one.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: The resource or record doesn’t exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - accessToken: []
components:
  schemas:
    Error:
      type: object
      description: Why the request was refused.
      properties:
        statusCode:
          type: integer
          description: The HTTP status.
        statusMessage:
          type: string
          description: What went wrong, in words to show.
      required:
        - statusCode
        - statusMessage
  securitySchemes:
    accessToken:
      type: http
      scheme: bearer
      description: >-
        An access token from [Create an access
        token](/reference/oneroster/access-tokens/create-an-access-token).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.