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

# Get Demographics

> Return collection of all student demographics.



## OpenAPI

````yaml /api-reference/openapi.json get /ims/oneroster/v1p2/demographics
openapi: 3.1.0
info:
  title: Scout API
  version: 1.0.0
  description: >-
    Programmatic access to Scout rostering data (IMS OneRoster 1.1 & 1.2) and
    related endpoints, authenticated with an API access token.
servers:
  - url: https://api.teachwithscout.com/v1
    description: Production
security: []
paths:
  /ims/oneroster/v1p2/demographics:
    get:
      summary: Get Demographics
      description: Return collection of all student demographics.
      parameters:
        - name: limit
          in: query
          description: >-
            To define the download segmentation value i.e. the maximum number of
            records to be contained in the response.
          required: false
          schema:
            type: integer
            format: int32
            minimum: 1
            default: 100
        - name: offset
          in: query
          description: >-
            The number of the first record to be supplied in the segmented
            response message.
          required: false
          schema:
            type: integer
            format: int32
            minimum: 0
            default: 0
        - name: sort
          in: query
          description: >-
            Identifies the sort criteria to be used for the records in the
            response message. Use with the orderBy parameter.
          required: false
          schema:
            type: string
        - name: orderBy
          in: query
          description: >-
            The form of ordering for response to the sorted request i.e.
            ascending (asc) or descending (desc).
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
            default: asc
        - name: filter
          in: query
          description: >-
            The filtering rules to be applied when identifying the records to be
            supplied in the response message.
          required: false
          schema:
            type: string
        - name: fields
          in: query
          description: >-
            To identify the range of fields that should be supplied in the
            response message.
          required: false
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: OK
          headers:
            X-Total-Count:
              description: The total number of resources that are available
              schema:
                type: integer
          content:
            application/json:
              schema:
                type: object
                properties:
                  demographics:
                    type: array
                    items:
                      type: object
                      properties:
                        sourcedId:
                          type: string
                        status:
                          type: string
                          enum:
                            - active
                            - tobedeleted
                        dateLastModified:
                          type: string
                          format: date-time
                        birthDate:
                          type: string
                          format: date
                        sex:
                          type: string
                          enum:
                            - male
                            - female
                            - unspecified
                        americanIndianOrAlaskaNative:
                          type: string
                          enum:
                            - 'true'
                            - 'false'
                        asian:
                          type: string
                          enum:
                            - 'true'
                            - 'false'
                        blackOrAfricanAmerican:
                          type: string
                          enum:
                            - 'true'
                            - 'false'
                        nativeHawaiianOrOtherPacificIslander:
                          type: string
                          enum:
                            - 'true'
                            - 'false'
                        white:
                          type: string
                          enum:
                            - 'true'
                            - 'false'
                        demographicRaceTwoOrMoreRaces:
                          type: string
                          enum:
                            - 'true'
                            - 'false'
                        hispanicOrLatinoEthnicity:
                          type: string
                          enum:
                            - 'true'
                            - 'false'
                        countryOfBirthCode:
                          type: string
                        stateOfBirthAbbreviation:
                          type: string
                        cityOfBirth:
                          type: string
                        publicSchoolResidenceStatus:
                          type: string
                      required:
                        - sourcedId
                        - status
                        - dateLastModified
                        - birthDate
                        - sex
                        - americanIndianOrAlaskaNative
                        - asian
                        - blackOrAfricanAmerican
                        - nativeHawaiianOrOtherPacificIslander
                        - white
                        - demographicRaceTwoOrMoreRaces
                        - hispanicOrLatinoEthnicity
                        - countryOfBirthCode
                        - stateOfBirthAbbreviation
                        - cityOfBirth
                        - publicSchoolResidenceStatus
                required:
                  - demographics
      security:
        - accessToken: []
components:
  securitySchemes:
    accessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Bearer access token obtained from the OneRoster token endpoint. Send it
        as `Authorization: Bearer <access_token>` on every request. Tokens
        expire after 1 hour.

````