This article provides the definitions for different API endpoints. Click a collapsible header below to display the fields and definitions for that specific category.
Note: EDU API is currently in beta and as a result, your institution may not have access to it. Reach out to your relationship manager for any inquiries!
Applications
This table contains data of your institution's student applications attached to any jobs on Handshake.
| Field | Definition |
| id | Handshake generated identification number for each application |
| job_id | Handshake generated identification number for each job |
| employer_id | Randomly generated identification number for each employer |
| status | Status of Applications. e.g. Pending, Reviewed, Primary, Declined |
| applicable_type | Type of application, ex: Job, InterviewSchedule |
| withdrawn | Indicates if an application was withdrawn (True/False) |
| created_at | Date when application was created |
| updated_at | Date when application was updated |
Appointments
This table contains data of your institution's student and career staff appointment engagement.
| Field | Definition |
| id | Handshake generated identification number for each appointment |
| student_id | ID generated by Handshake for student account |
| checked_in | Indicates if a student checked in to appointment |
| start_date_time | Start date/time of appointment |
| end_date_time | End date/time of appointment |
| walk_in | Indicates whether the appointment block was available for walk-ins |
| categories | Array with the names of categories the appointment belongs to |
| type | Name of appointment type connected to the appointment |
| medium | Appointment medium name attached to appointment |
| staff_member_first_name | First name of staff member who participated |
| staff_member_last_name | Last name of staff member who participated |
| staff_member_email | Email address of staff member who participated |
| notes | Notes attached to an appointment |
| length_in_minutes | Duration of appointment type |
| school_year | Name of school year at time of appointment (e.g. Freshman, Alumni) |
| created_at | Date when appointment was created |
Career fairs
This table contains data of your institution's career fairs.
| Field | Definition |
| id | Handshake generated identification number for each career fair |
| name | Name of career fair |
| start_date_time | Date when career fair time starts |
| end_date_time | Date when career fair time ends |
| location | Full address of the event location (i.e. Auburn University, Auburn, AL 36849) |
| location_type | Indicates whether fair is virtual or in-person |
| status | Career fair status (either published or drafting) |
| medium | Internal ID – 1 for in-person, 0 for virtual (see location_type) |
| public | Indicates whether the fair is public |
| responsible_contact_first_name | Fair contact’s first name |
| responsible_contact_last_name | Fair contact’s last name |
| responsible_contact_email | Fair contact’s email address |
| career_center_id | Handshake generated identification number for each career center |
| career_center | Name of career center (e.g. Main Career Center) |
| student_registration_start_date_time | First date students may register for fair |
| student_registration_end_date_time | Last date students may register for fair |
| employer_registration_start_date_time | First date employers may register |
| employer_registration_end_date_time | Last date employers may register |
| survey_id | Survey ID associated with the event |
| created_at | Date when fair was created |
| updated_at | Date when fair was last updated |
Career fair attendance
This table contains data of your institution's student career fair attendance.
| Field | Definition |
| student_id | ID generated by Handshake for student account |
| career_fair_session_id | Handshake generated ID for each career fair session |
| is_registered | Indicates if attendee pre-registered |
| registered_at_date_time | Date attendee pre-registered |
| is_checked_in | Indicates if student checked in to career fair |
| checked_in_at_date_time | Date student checked in to career fair |
| created_at | Date student attendee record was created |
| updated_at | Date student attendee record was updated |
Career fair employer engagement
This table contains data of your institution's employer engagement at fairs.
| Field | Definition |
| career_fair_id | Handshake generated identification number for each career fair |
| employer_id | Employer ID of employer who participated in the fair |
| employer_division | Name of Employer Division |
| responsible_contact_first_name | Fair contact's first name |
| responsible_contact_last_name | Fair contact's last name |
| responsible_contact_email | Fair contact's email address |
| registration_status | Status of employer registrations (approved, cancelled, declined, pending) |
| payment_status | Payment status of registrations (unpaid, paid, invoiced) |
| created_at | Date the employer registration was created |
| updated_at | Date the employer registration was last updated |
Career fair sessions
This table contains data of your institution's career fair sessions
| Field | Definition |
| id | Handshake generated identification number for each career fair session name |
| name | Career fair session name |
| identifier | The identifier helps users distinguish between multiple sessions of the same career fair |
| start_date_time | Date when career fair session starts |
| end_date_time | Date when career fair session ends |
| career_fair_id | Handshake generated identification number for each career fair |
| created_at | Date when career fair session was created |
| updated_at | Date when career fair session was last updated |
Collections
This table contains data of your institution's collections
| Field | Definition |
| id | Handshake generated identification number for each collection |
| name | Name of collection |
| employer id | Employer ID associated with a collection |
| job id | Job ID associated with a collection |
| event id | Event ID associated with a collection |
| career fair id | Career Fair ID associated with a collection |
| created at | Date collection was created |
| updated at | Date collection was last updated |
Contacts
This table contains data of your institution's contacts
| Field | Definition |
| id | Handshake generated identification number for each contact |
| first_name | Contact's first name |
| last_name | Contact's last name |
| Contact's email | |
| title | Contact's title |
| employer_id | Contact's employer id |
| cell_phone | Contact's cell phone |
| phone | Contact's phone |
| alum_year | Graduating year of alum contact |
| contact_source | Source type name which identifies how the contact was created (ie. requested approval, attended interview, posted interview, posted event, attended career fair, posted job, alum) |
| is_archived | Indicates whether contact is archived |
| created_at | Date contact was created |
| updated_at | Date contact was last updated |
Educations
This table contains data of on educations on your students' profiles
| Field | Definition |
| id | Handshake generated identification number for each of the educations connected to a student's profile |
| student_id | ID generated by Handshake for student account |
| education_level | Name of Education Level. One of: Masters, Doctorate, or Bachelors |
| cumulative_gpa | Student's cumulative gpa connected to their education |
| is_primary | Indicates if this is their primary education (this is the education entry that will be updated from a student sync) |
| description | Description of student education |
| school_name | Name of school connected to the education |
| colleges | Name of college |
| majors | Name of major connected to student's education |
| minors | Name of minor connected to student's education |
| created_at | Date education was created |
| updated_at | Date education was last updated |
Employers
This table contains data on employers
| Field | Definition |
| id | Randomly generated identification number for each employer |
| name | Name of employer |
| description | Description of employer |
| Employer email | |
| duns number | Employer DUNS Number |
| size | The approximate range of employees employed by the employer |
| phone | Employer phone number |
| website | Employer website |
| address | Employer address |
| industry id | Handshake generated identification number for each Employer Industry |
| affiliation parent employer ids | views.employer_affiliations.parent_employer_id.description. |
| is suspended | Indicates if an employer is suspended |
| created at | Date employer was created |
| updated at | Date employer was last updated |
Employer labels
This table contains data on employer labels
| Field | Definition |
| employer id | Randomly generated identification number for each employer |
| label | Label associated with the employer |
| updated at | Date employer label was last updated |
Events
Data on events posted on Handshake
| Field | Definition |
| id | Handshake generated identification number for each event |
| name | Name of event |
| start_date_time | Start date of event |
| end_date_time | End date of event |
| type | Type of event — e.g. Info Session, Networking, Speaker/Panel |
| medium | Event medium name |
| categories | Event category name |
| status | Status of event approval (Approved, Declined, Pending) |
| public | Indicates a public event |
| host_id | ID of the host institution that is hosting the event |
| host_type | Whether host is a school or employer |
| owner_id | ID of the institution that created the event |
| owner_type | Whether owner is a school or employer |
| career_center_id | Handshake generated ID for each career center |
| career_center | Name of career center (e.g. Main Career Center) |
| location | Full address of the event location (e.g. Auburn University, Auburn AL) |
| responsible_contact_first_name | Event contact’s first name |
| responsible_contact_last_name | Event contact’s last name |
| responsible_contact_email | Event contact’s email |
| survey_id | Survey ID associated with the event |
| created_at | Date when event was created |
| updated_at | Date when event was updated |
Event attendance
Data on event attendance on Handshake (including registered and checked-in students)
| Field | Definition |
| id | ID linking student to event attended |
| student_id | ID generated by Handshake for student account |
| event_id | Handshake generated ID for each event |
| is_registered | Indicates if attendee registered (True/False) |
| registered_at_date_time | Date when attendee registered |
| checkedin_in_at_date_time | Date when student checked into event |
| created_at | Date when attendee record was created |
| updated_at | Date when attendee record was updated |
Event employer engagement
Data on employers engaged in an event
| Field | Definition |
| event_id | Handshake generated ID for each event |
| employer_id | Randomly generated ID for each employer |
| responsible_contact_first_name | Event contact’s first name |
| responsible_contact_last_name | Event contact’s last name |
| created_at | Date when employer first engaged with the event |
| updated_at | Date when employer engagement on the event was last updated |
Event labels
Data on labels associated with events
| Field | Definition |
| event_id | Handshake generated identification number for each event |
| label | Institution created label names |
Experiences
This table contains data on experiences on student profiles at your institution
| Field | Definition |
| student_id | ID generated by Handshake for student account |
| employer_id | Unique identifier for employer associated with the experience |
| job_id | Handshake generated ID for each job |
| employer_name | Name of employer |
| job_title | Job title |
| industry_name | Name of Employer Industry (e.g. Internet & Software, Oil & Gas, Insurance) |
| term_name | Term name of the experience |
| created_at | Date experience was created |
| updated_at | Date experience was last updated |
First destination responses
This table contains data on the first destination survey
| Field | Definition |
| id | Handshake generated identification number for each survey response |
| first_destination_survey_id | Handshake generated identification number for each first destination survey |
| student_id | ID generated by Handshake for student account |
| seeking_option | Name of seeking option. Either employment or continuing education |
| response_type | Indicates destination outcome: Working, not seeking, military, still looking, continuing education, or volunteering |
| recipient_campus | Name of campus of recipient |
| recipient_primary_major | Name of major connected to student's education |
| not_seeking_option | Name of non seeking option. Either Taking time off, Traveling, Taking a gap year, or Other |
| pay_schedule | Name of pay schedule: Annual salary, Monthly Stipent, or Hourly Wage |
| primary_major | Name of major connected to student's education |
| military_rank | Name of military rank. Either Officer or Enlisted |
| military_branch | Name of Military Branch. One of Marine Corps, Army, Navy, or Air Force |
| Email address entered on response for student | |
| employer_id | Randomly generated identification number for each employer |
| graduate_program_months | Captures the length/duration of graduate programs in months |
| job_position | Name of job position entered on survey response |
| offer_date | Offer date of work outcome on survey response |
| start_date | Captures when a student will start or has started their job/position after graduation |
| created_at | Date response was created |
| updated_at | Date response was last updated |
Industries
This table contains data on industries
| Field | Definition |
| id | Handshake generated identification number for each Employer Industry |
| name | Name of Employer Industry. One of 62 industry names. Ex: Internet & Software, Oil & Gas, Insurance |
| created at | Date industry was created |
| updated at | Date industry was last updated |
Interview schedules
This table contains data on on campus interview schedules hosted at your institution
| Field | Definition |
| id | Handshake generated identification number for each Interview Schedule |
| identifier | Optional string field that allows users to provide a custom name or label for an interview schedule |
| employer_id | Randomly generated identification number for each employer |
| contacts_ids | Handshake generated identification number for each contact |
| interview_slot_ids | Handshake generated identification number for interview slots connected to interview schedule |
| status | Status of Interview Schedule. One of: approved, cancelled, declined, or pending |
| type | Name of Interview Schedule Type. One of: Open, Preselect, Preselect Continuous, or Room Only |
| schedule_dates | Date of interview schedule |
| job_ids | Handshake generated identification number for each job |
| career_center | Name of career center. Ex: Main Career Center |
| career_center_id | Handshake generated identification number for each career center |
| created_at | Date interview schedule was created |
| updated_at | Date interview schedule was last updated |
Jobs
This table contains data on jobs that have been posted to your institution.
| Field | Definition |
| id | Handshake generated identification number for each job |
| title | Job title |
| employer_id | Randomly generated identification number for each employer |
| start_date_time | Start date of job |
| employment_type | Name of employment type. One of full-time, seasonal, or part-time |
| type | Name of Job Type. One of 8 job types. Ex: Job, Internship, Volunteer |
| pay_rate | The pay indicated for a job |
| remote | Indicates if the job is remote |
| external_url | The URL of the site where students should apply to the job |
| on_site | Indicates if the job is on-site (True/ False) |
| hybrid | Indicates if the job is hybrid (True / False) |
| archived | Indicates whether job has been archived (True/False) |
| duration | Duration of job position. Ex: Permanent, Temporary/Seasonal, Full time, 10 weeks |
| salary_type | Name of salary type: paid or unpaid |
| created_at | Date when application was created |
| updated_at | Date when application was updated |
Jobs labels
Contains data on job labels that are specific to a school
| Field | Definition |
| job_id | Handshake generated identification number for each job |
| labels | Institution created label names |
| updated_at | Date when label was updated in school settings |
Job student qualifications
Contains data on qualifications associated with a job.
| Field | Definition |
| id | Unique id for criteria that students must achieve to be eligible for applying to the particular job |
| job_id | Handshake generated identification number for each job |
| posting_id | Handshake generated identification number for each posting |
| accepts_opt_cpt_candidates | Indicates if an employer will accept OPT/CPT candidates |
| cumulative_gpa | Minimum required cumulative gpa |
| cumulative_gpa_required | Indicates if the cumulative gpa is required for a job (Trust / False) |
| earliest_graduation_date | Earliest date when a student can graduate |
| latest_graduation_date | Lastest date a student can graduate |
| located_in_us | Indicates if student is required to have US work authorization for job posting |
| willing_to_sponsor_candidate | Indicates if an employer is willing to sponsor a candidate |
| school_years | Name of school year. Ex: Freshman, Alumni, Accelerated Masters |
Job locations
Data on the location associated with the job
| Field | Definition |
| id | Randomly generated identification number for each Location |
| job_id | Handshake generated identification number for each job |
| location | Full address for the location of a job i.e. Atlanta, Georgia, United States of America |
| region | Region where job is located (i.e. Midwest) |
| created_at | Date when location was created |
| updated_at | Date when location was updated |
Job role groups
Data on the job role group associated with the job
| Field | Definition |
| job_id | Handshake generated identification number for each job |
| job_role_group_id | Handshake generated identification number for each job role group |
| job_role_group_name | Name of Job Role Groups. One of 354 job role groups. Ex: Nurse Practitioners, Environmental Engineers, High School Teachers |
| created_at | Date when job role was created in Handshake |
| updated_at | Date when job role was updated in Handshake |
Meetings
This table contains data on meetings hosted with your students. This could include employer-hosted meetings or career fair meetings.
| Field | Definition |
| id | ID of the meeting session |
| name | Name of the meeting |
| owner_first_name | Owner of the meeting first name |
| owner_last_name | Owner of the meeting last name |
| owner_institution_email_address | Owner of the meeting email address |
| medium | Indicates Handshake virtual or external service |
| session_type | 1-1 or Group Session |
| filled | Is the session filled |
| available | Is the session available to join |
| description | Description of the session |
| employer_participant_limit | Maximum number of employer reps within the session |
| student_participant_limit | Maximum number of students within the session |
| start_date_time | Session Start Date/Time |
| end_date_time | Session End Date/Time |
| cancelled_date_time | Date the session was cancelled |
| employer_id | Randomly generated identification number for each employer |
| career_fair_session_id | Handshake generated identification number for each career fair session name |
| created_at | Date meeting was created |
| updated_at | Date meeting was last updated |
Postings
This table contains data on all of the jobs posted to your institution. A note on the difference between jobs and postings: An employer can create one job and post it to multiple schools — each posting is unique to an institution.
Also important to note: The API data only includes postings that have expired within the past 30 days. Looker postings data includes data from all time.
| Field | Definition |
| id | Handshake generated identification number for each posting |
| status | Status of Postings (expired, declined, approved, pending, in progress) |
| requested_on_date_time | Date job posting was requested at your school |
| responded_on_date_time | Date the job posting was responded to |
| expiration_date_time | Date when job posting expires at your school |
| auto_approved | Indicates if a job was auto-approved |
| apply_start_date_time | Date when students can apply to job posting |
| decline_comment | Decline comment (if provided) when posting is declined |
| decline_reasons | Reason provided for posting decline |
| posted_by_alum | Indicates whether the job is posted by an alumnus (Yes / No) |
| has_attached_interview_schedule | Indicates if the job posting is connected to an interview schedule at your school |
| job_id | Handshake generated identification number for each job |
| created_at | Date when job posting was created at your school |
| updated_at | Date when job posting was updated at your school |
Students
This table contains data on students at your institution
| Field | Definition |
| id | ID generated by Handshake for student account |
| username | Institution specific identifier for students. |
| first_name | First name of student |
| last_name | Last name of student |
| middle_name | Middle name of student |
| preferred_name | A student's preferred name |
| is_archived | Indicates if a student's profile is archived/disabled |
| institution_email | Email address imported by your institution |
| ethnicity | Ethnicity of student |
| gender | Gender of student |
| is_activated | Indicates if a student has agreed to Terms of Service |
| status | Indicates if a student's profile is active or blocked |
| colleges | Name of college |
| majors | Name of major connected to student's education |
| minors | Name of minor connected to student's education |
| school_year | Name of school year. Ex: Freshman, Alumni, Accelerated Masters |
| card_id | Numerical value stored on student's school ID card. This value is used to the Handshake Checkin Kiosk / Card Swipe |
| is_profile_completed | Indicates if a student's profile is complete |
| primary_education_level | Name of Education Level. One of: Masters, Doctorate, or Bachelors |
| primary_cumulative_gpa | Student's cumulative gpa connected to their education |
| education_ids | Handshake generated identification number for each of the educations connected to a student's profile |
| created_at | Date when student account was created |
| updated_at | Date when the student's account settings were last updated |
Student interests
This table contains data on student interests
| Field | Definition |
| student_id | ID generated by Handshake for student account |
| personal_goals | [In student user settings] Name of personal goal. One of “I want a job”, “I want an internship”, “I'm interested in grad school”, “I want to find out about career center events”, “I want to build my network”, or “I'm not sure / just checking it out” |
| post_graduation_goals | [In student user settings] Name of post-graduation goal (i.e. working, graduate school, etc.) |
| job_types | Name of Job Type. One of 8 job types (e.g. Job, Internship, Volunteer) |
| job_role_groups | Name of Job Role Groups. One of 354 job role groups (e.g. Nurse Practitioners, Environmental Engineers, High School Teachers) |
| job_functions | Name of job functions – one of 46 job functions |
| industries | Name of Employer Industry. One of 62 industry names (e.g. Internet & Software, Oil & Gas, Insurance) |
| career_clusters | Name of custom career clusters |
| updated_at | Date when custom career interest was updated |
Student labels
This table contains data on student labels
| Field | Definition |
| student_id | ID generated by Handshake for student account |
| labels | Institution-created label names. |
| updated_at | Date when the student label was last updated |
Student skills
This table contains data on student skills
| Field | Definition |
| id | Handshake generated identification number for each skill |
| student_id | ID generated by Handshake for student account |
| skill_name | Name of skill |
| created_at | Date when skill was created |
| updated_at | Date when skill was updated |
Surveys
This table contains data on surveys
| Field | Definition |
| id | Handshake generated identification number for each survey |
| title | Title of the survey |
| start_date_time | Controls when a survey becomes available for completion |
| end_date_time | Controls when a survey is no longer available for completion |
| required | Indicates whether survey was required |
| description | Description associated with the survey |
| finished | Indicates whether the survey is closed |
| status | Indicates whether the survey is active, drafting, or closed |
| created_at | Date when survey was created |
| updated_at | Date when survey was last updated |
Survey responses
This table contains data on survey responses
| Field | Definition |
| id | Handshake generated identification number for each survey response |
| survey_id | Handshake generated identification number for each survey |
| survey_title | Title of the survey |
| question_id | Handshake generated identification number for each survey question |
| question_text | Question text |
| question_response_text | Response text |
| responder_id | ID of the user who responded to the survey |
| responder_username | Username of the responder |
| responder_institution_email | Email of the responder |
| responder_first_name | First name of the responder |
| responder_last_name | Last name of the responder |
| created_at | Date when survey response was created |
| updated_at | Date when survey response was last updated |