Profile
The profile's schema fields (see GET /apis/profiles/schema) are returned at the top level under their names, alongside the keys below. Timestamps are Unix time in seconds.
- activatedType: integernullable
_at Integer numbers.
- canvasType: stringnullable
_external _id Canvas SIS identifier for this profile. Globally unique. Changing it triggers an async re-key in Canvas. Cannot be cleared once set. Only present when the Canvas integration is enabled.
- canvasType: stringnullable
_id Canvas LMS identifier for this profile. Only present when the Canvas integration is enabled.
- contractsType: array of objectProperties: 3
Professional history. Each entry also carries the contract schema fields, such as
position,start_dateandend_date. - createdType: integer
_at Integer numbers.
- diplomasType: array of objectProperties: 3
Academic history. Each entry also carries the diploma schema fields, such as
degree,field_of_study,start_dateandend_date. - emailType: string
- firstType: string
_name - idType: string
- lastType: string
_name - lastType: integernullable
_seen Integer numbers.
- middleType: stringnullable
_name - originalType: object
_photo Properties: 5Empty object when there is no photo.
- photoType: objectProperties: 5
Empty object when there is no photo.
- policiesType: objectProperties: 1
The latest acceptance of each published policy, keyed by policy version id. Present only when the institution has a published policy.
- rolesType:Properties: 13
The profile's
prospect,applicant,studentandalumnusroles. Roles in any other state, such asstafforuser, are not returned. - sourceType: stringnullable
_category - sourceType: stringnullable
_method - tagsType: array of string
- updatedType: integernullable
_at Changes on any update to the profile.
- updatedType: integernullable
_data _at Changes only when schema fields or roles change.