Skip to main content
GET
/
ims
/
oneroster
/
rostering
/
v1p2
/
users
/
{sourcedId}
Get a specific User
curl --request GET \
  --url https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/users/{sourcedId} \
  --header 'Authorization: Bearer <token>'
{
  "user": {
    "sourcedId": "<string>",
    "status": "active",
    "enabledUser": "true",
    "givenName": "<string>",
    "familyName": "<string>",
    "roles": [],
    "agents": [],
    "userProfiles": [],
    "email": "jsmith@example.com",
    "dateLastModified": "2023-11-07T05:31:56Z",
    "metadata": {},
    "userMasterIdentifier": "<string>",
    "username": "<string>",
    "userIds": [
      {
        "type": "<string>",
        "identifier": "<string>"
      }
    ],
    "middleName": "<string>",
    "primaryOrg": {
      "href": "<string>",
      "sourcedId": "<string>",
      "type": "<string>",
      "name": "<string>"
    },
    "identifier": "<string>",
    "preferredFirstName": "<string>",
    "preferredMiddleName": "<string>",
    "preferredLastName": "<string>",
    "pronouns": "<string>",
    "grades": [
      "3"
    ],
    "password": "<string>",
    "sms": "<string>",
    "phone": "<string>",
    "demographics": {
      "sourcedId": "<string>",
      "status": "active",
      "birthDate": "<string>",
      "sex": "male",
      "americanIndianOrAlaskaNative": "<string>",
      "asian": "<string>",
      "blackOrAfricanAmerican": "<string>",
      "nativeHawaiianOrOtherPacificIslander": "<string>",
      "white": "<string>",
      "demographicRaceTwoOrMoreRaces": "<string>",
      "hispanicOrLatinoEthnicity": "<string>",
      "countryOfBirthCode": "<string>",
      "stateOfBirthAbbreviation": "<string>",
      "cityOfBirth": "<string>",
      "publicSchoolResidenceStatus": "<string>",
      "dateLastModified": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.timeback.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
sourcedId
string
required

The sourcedId of the user

Query Parameters

​
fields
string

Comma-separated list of fields to include in the response

Example:

"sourcedId,name"

Response

Successful response with the user

​
user
object
required

Represents a user of the system. Can be a student, teacher, guide, parent etc.