Check-in API

This guide provides an intro to the check-in API. If you want to make a custom application for checking in attendees, this is the right place to start.

Authentication

End-pointhttp://www.yoursite.com/tc-api/your_api_key_here/check_credentials

Purpose: Use this to check if api key is valid. We use it during the first / login screen

Example Call:

Example Response 1 (api key is invalid):

Example Response 2 (api key is valid):

In this response, you'll only use "pass" argument. In this case "pass": true means that api key is valid.

Event Information (Essentials)

End-pointhttp://www.yoursite.com/tc-api/your_api_key_here/event_essentials

Purpose: Use this to get some basic information about the event like event name, location, number of tickets sold and number of checked-in attendees

Example Call:

Example Response

Attendees & Tickets

End-pointhttp://www.yoursite.com/tc-api/your_api_key_here/tickets_info/results_per_page/page_number/

Purpose: Use this to get a list of attendees / tickets and also custom field values

Example Call:

Example Response

Check-in

End-pointhttp://www.yoursite.com/tc-api/your_api_key_here/check_in/checksum - checksum is a ticket number obtained via tickets_info end-point

Purpose: Use this to check-in attendee

Example Call:

Example Response 1:

Example Response 2:

This is unique response which isn't in the JSON format.

Check-ins

End-pointhttp://www.yoursite.com/tc-api/your_api_key_here/ticket_checkins/checksum - checksum is a ticket number obtained via tickets_info end-point

Purpose: Use this to get all check-in records for a particular ticket (determined by checksum / ticket code)

Example Call:

Example Response:

 


Leave Us A Message!