OneTap has an open API so you can integrate with 3rd party forms.
Things you can use the API for:
Create participants/guests on OneTap from 3rd party registration forms.
Create profiles on OneTap from 3rd party registration forms.
Check-in participants/guests on OneTap.
Integrate OneTap with other products.
Register Participants/Guests using the API
Goal: Add a participant/guest into a specific list on OneTap using our API.
Request Method:
POST
Request URL
Step 1 - copy this text below:
https://api.onetapcheckin.com/api/register
Step 2 - Add the following text snippets to the previous URL text:
apiKey=CHANGE_THIS
⚠️ Replace the CHANGE_THIS subtext with your API Key
listId=CHANGE_THIS
How do I find my List ID?
⚠️ Replace the CHANGE_THIS subtext with your List ID
accountId=CHANGE_THIS
⚠️ Replace the CHANGE_THIS subtext with your Account ID
Step 3 - The final URL should look like this:
https://api.onetapcheckin.com/api/register?apiKey=CHANGE_THIS&listId=CHANGE_THIS&accountId=CHANGE_THIS
Step 4 - Plug in this URL into your 3rd party form.
You should receive the following response from our server:
{
"status": "success",
"message": "registered"
}
Data Format
You can send the following fields (JSON keys) inside the data payload:
Reserved fields:
name
email
phone
address
avatar (or avatar url, picture)
ℹ️Note: Any other fields send over are saved as custom fields on our system.
Custom Field Examples:
notes
rsvp
paid
membership type
Testing & Debugging
Simple Test (Browser)
Step 1 - Change the endpoint from '/register' to '/test', the final URL should look like this:
https://api.onetapcheckin.com/api/test?apiKey=CHANGE_THIS&listId=CHANGE_THIS&accountId=CHANGE_THIS
Step 2 - Paste this into your chrome browser URL and press enter
Paste the HTML page content into this tool.
Step 3 - You should see a message like this:
{
"status": "passed",
"list": "LIST_NAME",
"user": "me@emailaddress.com",
"organization": "ORGANIZATION_NAME",
"message": "you are authenticated as me@emailaddress.com under ORGANIZATION_NAME"
}
Advance Test
Follow the instructions on this screenshot:

Written Instructions:
Change the HTTP method from 'GET' to 'POST'
Paste the full URL (see below)
Paste some data (see below)
Template URL:
https://api.onetapcheckin.com/api/test?apiKey=_____&listId=_____&accountId=_____
Example Data:
{
"name": "Testing OneTap API",
"email": "testing@onetapcheckin.io",
"avatar": "https://i.pinimg.com/originals/95/49/ff/9549ff7f5600476511721eade4f4b91f.png",
"phone": "8333815657",
"address": "1 OneTap Ave",
"notes": "Edit me"
}