Note: The use of this API requires the Custom Integrations API Add-on to be added to your account. Please contact your account representative for more details.
Public API
Base URI
https://partnerapi.goilobby.com/
Data Format: json
Authentication
Send issued API key in http request header X-ApiKey
1. Events
1.1. Get list of scheduled event for a period
|
Route |
Method(s) |
Description |
|
/events |
GET |
|
Request DTO Parameters
|
Name |
Data type |
Mandatory |
Description |
|
startDate |
date |
M |
Period start. Format: yyyy-MM-dd (2017-02-04) or yyyy/MM/dd (2017/02/04). |
|
endDate |
|
M |
Period end. Format: yyyy-MM-dd (2017-02-04) or yyyy/MM/dd (2017/02/04). |
Response DTO
|
Name |
Data type |
Mandatory |
Description |
|
items |
EventDetails[] |
M |
Array of events |
|
responseStatus |
ResponseStatus |
O |
Response details when request is failed due to validation or internal error |
EventDetails
|
Name |
Data type |
Mandatory |
Description |
|
siteName |
string |
M |
|
|
hostName |
string |
M |
|
|
title |
string |
M |
Event title |
|
eventStart |
date |
M |
|
|
eventEnd |
date |
O |
|
|
visitorType |
string |
M |
|
|
notes |
string |
O |
|
|
lastUpdatedBy |
string |
O |
|
|
lastUpdated |
date |
O |
|
|
reasonForVisitation |
string |
O |
|
|
meetingRoom |
string |
O |
|
|
welcome |
bool |
O |
|
|
hotel |
string |
O |
|
|
arrivalDate |
date |
O |
|
|
departureDate |
date |
O |
|
|
eventGuests |
EventGuest[] |
O |
|
EventGuest
|
Name |
Data type |
Mandatory |
Description |
|
emailAddress |
string |
M |
Email address |
|
firstName |
string |
O |
|
|
lastName |
string |
O |
|
ResponseStatus
|
Name |
Data type |
Mandatory |
Description |
|
ErrorCode |
string |
M |
|
|
Message |
string |
O |
|
|
Errors |
string |
O |
|
1.2. Get list of active event for a specific date
|
Route |
Method(s) |
Description |
|
/activeevents |
GET |
|
Request DTO Parameters
|
Name |
Data type |
Mandatory |
Description |
|
date |
date |
M |
Period start. Format: yyyy-MM-dd (2017-02-04) or yyyy/MM/dd (2017/02/04). |
Response DTO
|
Name |
Data type |
Mandatory |
Description |
|
items |
EventDetails[] |
M |
Array of events, same structure as in #1. Events |
|
responseStatus |
ResponseStatus |
O |
Response details when request is failed due to validation or internal error |
1.3. Get list of expected guests for all events active on a specific date
|
Route |
Method(s) |
Description |
|
/expectedvisitors |
GET |
|
Request DTO Parameters
|
Name |
Data type |
Mandatory |
Description |
|
date |
date |
M |
Period start. Format: yyyy-MM-dd (2017-02-04) or yyyy/MM/dd (2017/02/04). |
Response DTO
|
Name |
Data type |
Mandatory |
Description |
|
items |
ExpectedEventGuest[] |
M |
Array of events |
|
responseStatus |
ResponseStatus |
O |
Response details when request is failed due to validation or internal error |
ExpectedEventGuest
|
Name |
Data type |
Mandatory |
Description |
|
siteName |
string |
M |
|
|
hostName |
string |
M |
|
|
hostCompany |
string |
M |
|
|
eventTitle |
string |
M |
Event title |
|
eventStart |
date |
M |
|
|
eventEnd |
date |
O |
|
|
visitorType |
string |
M |
|
|
firstName |
string |
M |
Guest first name |
|
lastName |
string |
M |
Guest last name |
|
emailAddress |
string |
M |
Guest email |
|
companyName |
string |
M |
Guest company |
ResponseStatus
|
Name |
Data type |
Mandatory |
Description |
|
ErrorCode |
string |
M |
|
|
Message |
string |
O |
|
|
Errors |
string |
O |
|
2. Badge Holders
2.1. Get list of all visitors that have badge with specified QR code
|
Route |
Method(s) |
Description |
|
/badgeholders/{qrcode} |
GET |
|
|
/badgeholders |
GET |
|
Request DTO Parameters
|
Name |
Data type |
Mandatory |
Description |
|
qrcode |
string |
M |
QR code to find. |
Response DTO
|
Name |
Data type |
Mandatory |
Description |
|
items |
VisitorDetails[] |
M |
Array of visitors |
|
responseStatus |
ResponseStatus |
O |
Response details when request is failed due to validation or internal error |
VisitorDetails
|
Name |
Data type |
Mandatory |
Description |
|
firstName |
string |
O |
Fist name |
|
lastName |
string |
O |
Last name |
|
fullName |
string |
M |
Full name |
|
companyName |
string |
O |
Company name |
|
|
string |
O |
Email address |
|
siteName |
string |
M |
Site name |
|
hostName |
string |
M |
Host's full name |
|
hostCompany |
string |
M |
Host's department |
|
visitStartUtc |
date |
M |
Sign in time (in UTC) |
|
visitEndUtc |
date |
O |
Sign out time (in UTC) |
|
visitorType |
string |
M |
|
|
deviceTag |
string |
O |
|
|
qrCode |
string |
M |
QR Code |
|
AdditionalData |
dictionary<string, string> |
O |
Additional visitor details, Key-Value array, (i.e. CountryOfOrigin, Phone etc.) |
ResponseStatus
|
Name |
Data type |
Mandatory |
Description |
|
ErrorCode |
string |
M |
|
|
Message |
string |
O |
|
|
Errors |
string |
O |
|
3. Visitors
3.1. Get list of all visitors for a specified period of time
|
Route |
Method(s) |
Description |
|
/visitors |
GET |
|
Request DTO Parameters
|
Name |
Data type |
Mandatory |
Description |
|
StartDate |
date |
M |
Period start |
|
EndDate |
date |
M |
Period end |
Response DTO
|
Name |
Data type |
Mandatory |
Description |
|
items |
VisitorDetails[] |
M |
Array of visitors |
|
responseStatus |
ResponseStatus |
O |
Response details when request is failed due to validation or internal error |
VisitorDetails
|
Name |
Data type |
Mandatory |
Description |
|
firstName |
string |
O |
Fist name |
|
lastName |
string |
O |
Last name |
|
fullName |
string |
M |
Full name |
|
companyName |
string |
O |
Company name |
|
|
string |
O |
Email address |
|
siteName |
string |
M |
Site name |
|
hostName |
string |
M |
Host's full name |
|
hostCompany |
string |
M |
Host's department |
|
visitStartUtc |
date |
M |
Sign in time (in UTC) |
|
visitEndUtc |
date |
O |
Sign out time (in UTC) |
|
visitorType |
string |
M |
|
|
deviceTag |
string |
O |
|
|
qrCode |
string |
M |
QR Code |
|
AdditionalData |
dictionary<string, string> |
O |
Additional visitor details, Key-Value array, (i.e. CountryOfOrigin, Phone etc.) |
ResponseStatus
|
Name |
Data type |
Mandatory |
Description |
|
ErrorCode |
string |
M |
|
|
Message |
string |
O |
|
|
Errors |
string |
O |
|