Endpoint Reference

GET User Extended (Ignore profile publish)

Get additional User information, regardless of publish settings.

Request URL

https://{school}.myschoolapp.com/api/user/extended/all/userId/?t={token}

Request Parameters

ParameterRequiredTypeDescription
userIDProperty is required The ID of the user to return record entries for. The UserID is returned in the GET Users call.
relationshipbool Enter True if the userID's relationship should be returned.

Response 200

The user information with the specified user ID (does not following directory publish security).

Properties

NameDescriptionType
UserIDRead onlyinteger
FirstNamestring
LastNamestring
Emailstring
HostIdstring
Greetingstring
MaidenNamestring
NickNamestring
Prefixstring
Suffixstring
MiddleNamestring
OtherLastNamestring
Affiliationstring
Genderstring
BirthDatedate

Extended Properties

These fields are returned by /user/extended/(userID)/ in addition to the above field(s).

NameDescriptionType
EthnicityTypeinteger
Citizenshipstring
PersonalWebsiteinteger
BoardingOrDayinteger
IsDeceasedboolean
DeceasedDatedate
LivingStatusstring
IsAbroadboolean
ScreenNamestring
IMServicestring
IsLostboolean
CustomField1 - 10string

Audit Properties

These fields are returned by /user/audit/.

NameDescriptionType
PrimaryKeyinteger
FieldNamestring
SourceBeforestring
SourceAfterstring
ChangeDatedate
DeceasedDatedate
HandledIndboolean
DownloadedIndboolean

Connections

NameDescriptionType
StudentInfoBasic information about enrollment status.StudentInfo

Extended Connections

These connections are returned by /user/extended/(userID)/ in addition to the above connection(s).

NameDescriptionType
AddressListArray of Address
PhoneListArray of Phone
OccupationListArray of Occupation
EducationListArray of Education
RelationshipsArray of Relationship
ProfilePhotoPhotoItem