API Guide

Tawnya -

This guide covers all currently available endpoints exposed to the API, and some details regarding certain queries.  Our API is still under development (currently in an "as-is" state) and we will take product feedback regarding additional endpoints and use-cases, but cannot guarantee and additions or changes at this time.

Here are our currently available endpoints and params:

    • appointment_types_controller.rb
      • Create
      • Update
      • Create or update
    • Appointments_controller.rb
      • Create
    • Attendees_controller.rb
      • Create
      • Create or update

 

  • Index

 

        • AttendeeSerializer (only bottom)
          • Id
          • User id
          • Attendable id
          • Checked in
          • Survey response id
          • Registered
          • Created by id
          • Updated by id
          • Registered at
          • Checked in at
          • Invited at
    • Buildings_controller.rb
      • Index
        • BuildingSerializer
          • Id
          • School id
          • School name
          • Photo updated at
          • Created at
          • Updated at
          • Created by id
          • Updated by id
      • Create
    • Campuses_controller.rb

 

  • Index

 

        • CampusSerializer
          • Id
          • Name
          • Description
          • Created at
          • Updated at
      • Create
    • Career_fairs_controller.rb

 

  • Index

 

        • CareerFairSerializer
          • Id
          • Name
          • Created by id
          • Institution id
          • Institution type
          • Automatic invoices
          • Student limit
          • Student registration start
          • Employer registration end
          • Created at
          • Updated at
          • Refund policy
          • Maximum company description length
          • Student description
          • Employer description
          • Employer instructions
          • Student cost
          • Default approval message
          • Welcome student email
          • Allow all majors
          • Status
          • Time zone
          • Hidden
          • Import identifier
          • Invite only
    • Career_interests_controller.rb

 

  • Index

 

        • CustomJobInterestOptionSerializer
          • Id
          • Name
      • Show
    • Colleges_controller.rb

 

  • Index

 

        • ?
    • Contacts_controller.rb

 

  • Index

 

        • ContactSerializer
          • Id
          • Name
          • Title
          • Employer name
          • Institution type
          • Email Address
          • Phone
          • Cell phone
          • Fax
          • Created at
          • Updated at
          • Institution id
          • Description
          • Assigned to id
          • Created by id
          • Updated by id
          • First name
          • Last name
          • Alum year
      • Create
      • Update
      • Create or Update
    • Divisions_controller.rb
      • Create
    • Educations_controller.rb
      • Create
    • Employers_controller.rb

 

  • Index

 

        • EmployerSerializer
          • Id
          • Name
          • Website
          • Website host
          • Created at
          • Updated at
          • Description
          • Email
          • Phone
          • Students can message
          • Time zone
          • Aliases
          • Facebook URL
          • Twitter URL
          • LinkedIn URL
          • Glassdoor URL
          • Pitch
      • Create
    • Events_controller.rb

 

  • Index

 

      • EventSerializer
        • Id
        • Name
        • Description
        • Status
        • Invite only
        • Start date
        • End date
        • Attendee limit
        • Created at
        • Updated at
    • Create
  • first_destination_recipients_controller.rb
    • Create or update
  • First_destination_responses_controller.rb
    • Create
  • Jobs_controller.rb
    • Index
    • Create
  • Labels_controller.rb
    • Create
  • Majors_controller.rb
    • Index
    • Create
  • Minors_controller.rb
    • Index
    • Create
  • Notes_controller.rb
    • Create
  • Registrations_controller.rb
    • Index
      • RegistrationSerializer
        • Id
        • Career fair id
        • Employer id
        • Created by id
        • Payment method id
        • Status
        • Payment status
        • Message
        • Created at
        • Updated at
        • Representatives count
        • Representatives names
        • Refund policy agreement
        • Company description
        • Survey response id
        • Accept all majors
        • Job titles
        • Division id
        • Updated by id
        • Located in us
        • Accepts opt cpt candidates
        • Willing to sponsor candidates
        • Registrant contract id
  • Rooms_controller.rb
    • Index
      • RoomSerializer
        • Id
        • Building id
        • School id
        • School name
        • Capacity
        • Created at
        • Updated at
        • Available start
        • Available end
        • Created by id
        • Updated by id
        • Available for interviews
    • Create
  • Users_controller.rb <-- Limited to first 10k results, cannot increase due to performance issues this causes for all users.
    • Index
      • UserSerializer
        • Id
        • Username
        • Created at
        • First name
        • Last name
        • Email address
        • Card id
        • Institution id
        • Institution type
        • Is confirmed
        • Is public
        • Is contact
        • Bio
        • Start progress
        • School year id
        • Progress
        • Work auth id
        • Institution id type
        • User type
        • Title
        • Work study eligible
        • Document review status
        • Profile review status
        • Disabled
        • Time zone
        • Status
        • Profile or document submit time
        • Last logged in
        • Assigned to id
        • Campus id
        • Third party recruiter
        • Auth identifier
    • Create
  • Work_experiences_controller.rb
    • Create

 

How to submit a product feature request for API:

-Help form? 

 

How to request an API key (if endpoints listed above fulfill your requirements):

https://joinhandshake.wufoo.com/forms/handshake-api-key-request-form/

 

API cURL call and query examples can be found here:

https://documentation.joinhandshake.com/v1.0/reference#section-1-introduction

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request