Welcome to the Integrate Events public API documentation. Here you can find out how to build customised applications and share your event lead data with Integrate Events.
Designed and built using REST principles - if you have experience working with APIs, then the decisions we’ve made here should be familiar. API responses (and in some instances, requests) are in JSON.
You’ll need to get your unique Client Credentials from the Integrate Events dashboard; you can do this by logging in and navigating to Settings > API. Your client credentials are used to retrieve an access token from the API, which is used to authorise each request. For more information on this, including step-by-step instructions, see Help Centre article: Using the Integrate Events public API
Direct questions to our Support team, [email protected].
Cross-Origin Resource Sharing (CORS) is enabled for the API, which allows for XHR requests to be processed. This can be acheieved by sending an OPTIONS preflight request, to which the server will respond with the following headers:
Access-Control-Allow-Origin
Access-Control-Allow-Headers
Access-Control-Allow-Methods
To read more about Cross-Origin Resource Sharing, read a detailed explanation by Mozilla
Add filters to your API requests to determine the query outcome. The filter query string must:
filters[]
Build your filter parameters in the following format:
{logic}-{field}-{operator}-{value}
The valid values for logic are and
and or
.
These are used to split the filters[]
array into groups of filters based on the position on the position of the logic value or
.
This allows more complex queries to be constructed specifying multiple groups of conditions.
Example:
?filters[]=and-event.name-like-%Data%20Capture%20Event%
&filters[]=and-event.type-eq-1
&filters[]=or-event.name-like-%Guest%20List%20Event%
&filters[]=and-event.type-eq-2
This could be represented as the following SQL query:
SELECT ..
WHERE
(`event.name` LIKE '%Data Capture Event%' AND `event.type`=1)
OR
(`event.name` LIKE '%Guest List Event%' AND `event.type`=2)
The field name to be queried in the condition. You can check what fields are available to query on each collection endpoint schema.
Valid operators include:
eq
: Equals toneq
: Not equals tolt
: Less thanlte
: Less than or equals togt
: Greater thangte
: Greater than or equals tolike
: Like
This is the value for which the query is searching.
This will be smartly parsed while the filter string is being transformed to convert the type to int
, float
and null
.
To sort the the results returned by a collection endpoint, the request should:
sorts[]
Build your sort parameter with the following format:
{field}-{direction}
Below is an example of sorting events in ascending order by the endDate
and then by name
:
/v2.1/events/{eventID}?sorts[]=event.endDate-asc&sorts[]=event.name-asc
The field name the collection will be sorted by. You can check what fields you can use to sort a collection on each endpoint schema.
Define how the results should be ordered using one of the following:
asc
: Ascendingdesc
: Descending
The results returned from a collection endpoint will be paginated by default with the maximum number of results set to 50
.
This value can be changed by specifying the query parameter per_page
or limit
. The maximum value that can be specified is 200
.
The header Link
will be returned with the response following the format specified in RFC5988.
Example:
</v2.1/events?per_page=50&page=1>; rel="self",
</v2.1/events?per_page=50&page=2>; rel="next",
</v2.1/events?per_page=50&page=3>; rel="last"
The available pagination query parameters are:
per_page
- The number of results per pagepage
- The page number to fetch the results for
Includes allows related data to be included in the response from the server.
For example, when querying Records
, the Resources
are not included in the response by default.
To include the resources, supply the query parameter include
(use comma separators to define multiple includes).
Here is an example query string, which would retrieve an event, plus template and records:
/v2.1/events/{eventID}?include=template,records
Integrate Events domains only support requests using encryption with TLS 1.2 or greater. Any requests using TLS versions less than 1.2 will be blocked. Unsecured connections are not allowed, and are redirected to HTTPS (port 443). We also send a HTTP Strict Transport Security header to help protect against Man-In-The-Middle attacks.
We want to ensure all customers have the best possible experience using our API. The number of API requests that customers make is therefore logged, and if deemed to be excessive, we may impose limits to usage. For more information, you can request access to our Fair Usage Policy.
In order to provide Enterprise level security and other authentication related features we leverage Auth0 as an authentication provider across the entire Integrate platform, including the Integrate Events API.
The API endpoints require requests to contain an access token with the Authorization header. This is a relatively straightforward process; use the API Secret Key and Client ID (generated in your account dashboard - Settings > API) to perform a POST to the authorization endpoint. This will return your access (bearer) token on success.
You should then store the access (bearer) token in your application until it expires; it will be used in every subsequent API request for authorization.
The Authentication request to retrieve an access (bearer) token should use the following structure and the Auth0 /oauth/token
endpoint.
Please note: The Server URL for the Authentication request is different from the Server URLs for other API requests as it is provided by Auth0. Make sure that the the following Server URL is used: https://auth.integrate.com
Content-Type | string <uuid> Type of the content used on response; it should always be |
grant_type required | string Value: "client_credentials" |
client_id required | string non-empty The Integrate Events Client ID that was generated in the dashboard |
client_secret required | string non-empty The Integrate Events API Secret Key that was generated in the dashboard |
audience required | string non-empty Must contain the API Server URL you are trying to authenticate, e.g. https://api.integrate-events.com/ |
{- "grant_type": "client_credentials",
- "client_id": "wexler",
- "client_secret": "secret_here",
}
{- "access_token": "eyJz93a...k4laUWw",
- "expires_in": 86400,
- "token_type": "Bearer"
}
Retrieves the currently logged in user
Content-Type | string <uuid> Type of the content used on response; it should always be |
Authorization required | string Example: Bearer <token> The bearer token obtained through authentication |
{- "id": 1,
- "username": "wexler",
- "name": "Welxer Inc",
- "email": "[email protected]"
}
Events consist of defined questions and expected data responses. They also contain a collection of records.
The type of event is indicated by an integer value for the property type
. There are two types of events:
An event type used for capturing and editing records through forms built using the event template.
This event type is primarily used to track attendance at an event, by storing an “attended” state on each visitor or guest’s record. The event usually contains a list pre-populated records (uploaded, pre-registered, or partially complete records) that were added prior to the event start date. These records can be queried and updated to indicate whether somebody attended an event. This event type also supports the creation of new records (for example, walk-ins).
Type ID | Event Type |
---|---|
1 | Data Capture |
5 | Check-in |
Please note, the following Event Type IDs have been deprecated as of API v2 and are no longer supported:
Type ID | Event Type |
---|---|
2 | (Deprecated) Check-in (no Registration) |
3 | (Deprecated) Check-in or Register |
4 | (Deprecated) Check-in then Data Capture (no Registration) |
It’s no longer possible to create events with the deprecated IDs. Any existing events using the event types 2
, 3
and 4
should be treated as event type 5
.
The status of an event is indicated by the property status
and may be filtered when requesting a list of events.
The value of status
may be one of the following:
Status | Description |
---|---|
1 |
Active
The event can be used to collect records |
2 |
Archived
The event shouldn’t be used to collect records and is displayed within the Archived section of the Integrate Events Dashboard |
3 |
Deleted
The event shouldn’t be used to collected records and is not displayed within the Integrate Events Dashboard |
An event template defines the attributes of an event form. To see an example of how an event template is structured go to the event response schema and expand the template property.
Event templates also include an array of questions that are answered by a user. In this documentation, event questions are referred to as fields.
Every field must contain an ID and type (while some fields require additional specific parameters). Common parameters are defined below.
Attribute
* = Required |
Type | Example | Description |
---|---|---|---|
id* | string | "firstName" |
Identifies the question and associates it with collected data. It is an alphanumeric camel case string with no spaces. When created in Integrate Events dashboard, the ID is auto-generated based on the label entered for the question. |
type* | string | "text" |
Identifies the type of question. See the fields types definitions for all the allowed types. |
label | text | "First name" |
The label to be displayed as question text. |
required | boolean | true |
Defines whether the response to a question is mandatory. It is valid on all question types (except label, note and divider). If this parameter is not defined, the default is false (ie. a response is not required). |
displayed | object | See display logic |
Determines whether a question should be visible or hidden. It is valid on all question types. If not defined, the default value is true (ie. the question is displayed). See the display logic section for information on more complex logic |
successMessage | string | "Success message" |
The message to be displayed once the value of the field has been entered correctly. |
warningMessage | string | "Warning message" |
The warning message to be displayed before the field is interacted with. |
errorMessages | object |
{ |
The error message to be displayed when:
|
This section describes what type of form fields should be displayed by the client and how they should behave.
Field Type | Description | Example |
---|---|---|
text |
Used to input free text. autoCapitalize
If subtype is |
|
Used to input correctly formatted email addresses. autoCapitalize
|
|
|
number |
Used to input number characters. minVal The minimum number. maxVal The maximum number. |
|
tel |
Used to input a phone number.
|
|
url |
Used to input a web url. |
|
autocomplete |
Used to select a value from a pre-populated list or input a new value. limit The number of maximum visible suggestions selectedQuantity Maximum number of items that can be selected. allowNewEntries Allow options not defined in the list to be submitted options Autocomplete options; this can be an array of strings or objects. |
|
date |
Used to input a date
subtype
This option can be startRange Timestamp that defines the minimum date endRange Timestamp that defines the maximum date startTimeRange Minimum time range endTimeRange Maximum time range |
|
label |
Used to display a text label without requiring any input. subtype
|
|
checkbox |
Used to set a true/false or yes/no value. initialValIndicates if the checkbox should be ticked by default |
|
checkboxGroup |
Used to set true/false or yes/no values from a list of options. options Autocomplete options; this can be an array of strings or objects |
|
select |
Used to select a value from a dropdown list of options. addEmpty Defines whether a first option is empty or not multiSelect Allows multi-selection of options |
|
radio |
Used to select a value from a displayed list of options. |
|
rating |
Used to select a number of stars to indicate a rating. maxRating The number of stars to display; either 5 or 10 |
|
linkbuilder |
Used to set true/false or yes/no values from a list of options, which have an associated url. links An array of urls and labels |
|
cameraPhoto |
Used to capture a photo with a device’s camera. |
|
businessCard |
Used to capture a photo of a business card with a device’s camera. |
|
barcodeScanner |
Used to extract a value from a barcode using a device's camera. |
|
Logic works by defining expressions for displayed fields. Logic expressions work like MongoDB queries on the values already entered into the form.
Any questions that are set as not displayed, are not considered required by the form validation.
{
...,
displayed: {
OTHER_FIELD_ID: {
"$OPERATOR": "VALUE"
},
...
},
...
}
Operator | Description | Example |
---|---|---|
$displayed | Determines whether a field is displayed (or not) according to another field. |
|
$eq | Displays a field if the other field is equal to a value. This operator also accepts a regular expression. |
or
|
$ne | Displays a field if the other field is not equal to a value. This operator also accepts a regular expression. |
|
$in | Displays a field if the other field value is one of the values defined in the condition. |
|
$nin | Displays a field if the other field value is not in the array of values defined in the condition. |
|
$and | Displays a field if all conditions are true. |
|
$or | Displays a field if at least one of the conditions is true. |
|
The availble includes are:
records
- records captured for the eventresources
- resources associated with the eventtemplate
- event template containing the form questionsrecordsLastModified
- datetime representing the last time a record was modified for the eventFor more information see the includes explanation
Below is the list of available filters and sorts that can be used when listing events.
For more information see the filters and sorts explanation.
Filters | Sorts |
---|---|
|
|
filters | Array of strings Example: filters=?filters[]={LOGIC}-{FIELD}-{OPERATOR}-{VALUE} An array of filter strings. |
sorts | Array of strings Example: sorts=?sorts[]={FIELD}-{DIRECTION} An array of sort strings. |
page | number Example: page=?page={PAGE_NUMBER} The page number to retrieve. |
per_page | number Example: per_page=?per_page={QUANTITY} The number of items per page to retrieve. |
withTrashed | number Enum: 0 1 Example: withTrashed=?withTrashed=1 Includes soft deleted resources. |
include | string Example: include=?include=resources Comma separated string of related data to include in the response. |
Authorization required | string The access token obtained through authentication. |
X-Request-ID | string <uuid> The Request ID to be used for replaying requests in case of an unstable internet connection. |
Content-Type | string <uuid> Type of the content used on response; it should always be |
[- {
- "id": 1,
- "lastModified": "2019-01-01T00:00:00+00:00",
- "created": "2019-01-01T00:00:00+00:00",
- "name": "My Event",
- "type": 1,
- "status": 1,
- "date": "2019-01-01T00:00:00+00:00",
- "endDate": "2019-01-01T00:00:00+00:00",
- "preRegEndDate": "2019-01-01T00:00:00+00:00",
- "preRegCount": 0,
- "preRegMaxCount": 0,
- "webFormAccess": true,
- "styleJSON": {
- "toolbar-button": {
- "background-color": "#000000",
- "color": "#FFFFFF"
}, - "toolbar": {
- "background-color": "#000000"
}, - "toolbar-font": {
- "color": "#FFFFFF"
}, - "app-background": {
- "background-color": "#FFFFFF"
}, - "app-font": {
- "background-color": "#FFFFFF"
}, - "tooltip": {
- "background-color": "#FFFFFF"
}, - "tooltip-font": {
- "color": "#FFFFFF"
}, - "styleData": { }
}, - "collection": "Test Events",
- "tags": { },
- "appSchema": { },
- "badgeProviders": [
- {
- "question_id": "scanBadge",
- "name": "genericDevKit",
- "realTime": true
}
], - "template": {
- "name": "Test Event",
- "questions": [
- {
- "id": "emailAddress",
- "type": "email",
- "label": "Email address",
- "scanType": "aztec",
- "scanRegex": "/.*/",
- "required": true
}
], - "registerButton": "/.*/",
- "brandingImageResourceName": "string"
}, - "resources": [
- {
- "id": "57bc22499056057bc2249905",
- "type": "image/jpeg",
- "created": "2019-01-01T00:00:00+00:00",
- "lastModified": "2019-01-01T00:00:00+00:00"
}
], - "recordsLastModified": "2019-01-01T00:00:00+00:00"
}
]
eventID required | string The unique identifier of the event to be retrieved. |
include | string Example: include=?include=resources Comma separated string of related data to include in the response. |
Authorization required | string The access token obtained through authentication. |
X-Request-ID | string <uuid> The Request ID to be used for replaying requests in case of an unstable internet connection. |
Content-Type | string <uuid> Type of the content used on response; it should always be |
{- "id": 1,
- "lastModified": "2019-01-01T00:00:00+00:00",
- "created": "2019-01-01T00:00:00+00:00",
- "name": "My Event",
- "type": 1,
- "status": 1,
- "date": "2019-01-01T00:00:00+00:00",
- "endDate": "2019-01-01T00:00:00+00:00",
- "preRegEndDate": "2019-01-01T00:00:00+00:00",
- "preRegCount": 0,
- "preRegMaxCount": 0,
- "webFormAccess": true,
- "styleJSON": {
- "toolbar-button": {
- "background-color": "#000000",
- "color": "#FFFFFF"
}, - "toolbar": {
- "background-color": "#000000"
}, - "toolbar-font": {
- "color": "#FFFFFF"
}, - "app-background": {
- "background-color": "#FFFFFF"
}, - "app-font": {
- "background-color": "#FFFFFF"
}, - "tooltip": {
- "background-color": "#FFFFFF"
}, - "tooltip-font": {
- "color": "#FFFFFF"
}, - "styleData": { }
}, - "collection": "Test Events",
- "tags": { },
- "appSchema": { },
- "badgeProviders": [
- {
- "question_id": "scanBadge",
- "name": "genericDevKit",
- "realTime": true
}
], - "template": {
- "name": "Test Event",
- "questions": [
- {
- "id": "emailAddress",
- "type": "email",
- "label": "Email address",
- "scanType": "aztec",
- "scanRegex": "/.*/",
- "required": true
}
], - "registerButton": "/.*/",
- "brandingImageResourceName": "string"
}, - "resources": [
- {
- "id": "57bc22499056057bc2249905",
- "type": "image/jpeg",
- "created": "2019-01-01T00:00:00+00:00",
- "lastModified": "2019-01-01T00:00:00+00:00"
}
], - "recordsLastModified": "2019-01-01T00:00:00+00:00"
}
eventID required | string The unique identifier of the event from which to retrieve resources. |
Authorization required | string The access token obtained through authentication. |
X-Request-ID | string <uuid> The Request ID to be used for replaying requests in case of an unstable internet connection. |
[- {
- "id": "57bc22499056057bc2249905",
- "type": "image/jpeg",
- "created": "2019-01-01T00:00:00+00:00",
- "lastModified": "2019-01-01T00:00:00+00:00"
}
]
A record consists of a collection of data from an individual. It includes:
The answers to questions defined for an event are stored in the record’s values object, which needs to be structured in the following format:
value
Below are example values for each field type:
{
"values" : {
// Full Name
"fullName": {
"value": "John Doe"
},
// Email
"email": {
"value": "[email protected]"
},
// Phone Number
"phone": {
"value": "+447000000000"
},
// Company
"company": {
"value": "Integrate"
},
// Job Title
"jobTitle": {
"value": "Software Engineer"
},
// Opt in
"emailMe": {
"value": true
},
// Business Card Scan
"businessCard" : {
"value": "e9535020-ac60-11e9-880c-1fb645532f1f", // The ID returned from uploading binary data for a resource
"metadata" : {
"uploadGUID" : "e9535020-ac60-11e9-880c-1fb645532f1f" // The ID returned from uploading binary data for a resource
}
},
// Badge Scan
"badgeScan" : {
"value": "8374;Tilly;Stewart;Assistant Director;Gustr;Building;Road;City;State;AB1 2CD;United Kingdom;ZZ1 1ZZ;Some Province;07826354611;+1;09876543210;[email protected]"
},
// Text
"text": {
"value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do..."
},
// Number
"number": {
"value": 1
},
// Multiple Choice
"radio": {
"value": "Yes"
},
// Drop-down List
"title": {
"value": "Mr"
},
// Checkboxes
"checkbox": {
"value": [
"Product 1",
"Product 2"
]
},
// Date or Time
"dateOfBirth": {
"value": "1989-01-01T00:00:00+00:00"
},
// Rating / Stars
"rating": {
"value": 8
},
// Link Collection
"moreInformation": {
"value" : [
'https://test.com/product_one_brochure.pdf',
'https://test.com/product_three_brochure.pdf'
]
},
// Autocomplete
"country": {
"value": "United Kingdom"
},
// Website
"websiteUrl": {
"value": "https://www.integrate-events.com"
},
// Take a Photo
"photo" : {
"value": "e95217a0-ac60-11e9-880c-1fb645532f1f", // The ID returned from uploading binary data for a resource
"metadata" : {
"uploadGUID" : "e95217a0-ac60-11e9-880c-1fb645532f1f", // The ID returned from uploading binary data for a resource
}
},
// Signature
"signature": {
"value": "0adac260-b209-11ea-8587-3bbc2ebcbdd8", // The ID returned from uploading binary data for a resource
"metadata": {
"private": true, // Must be always "true"
"uploadGUID": "0adac260-b209-11ea-8587-3bbc2ebcbdd8" // The ID returned from uploading binary data for a resource
}
}
}
}
The availble includes are:
event
- The event to which the record belongsresources
- The resources that are related to the recordparent
- If a duplicate record: the parent record (main duplicate)children
- If a main duplicate record: The child records (duplicates)For more information see the includes explanation
The properties available for filtering and sorting records are not limited and any property may be used. You can also use the dot notation to indicate that nested properties are to be queried..
Example:
and-values.firstName.value-eq-John
For more information see the filters and sorts explanation.
eventID required | string The unique identifier of the event from which records should be retrieved. |
filters | Array of strings Example: filters=?filters[]={LOGIC}-{FIELD}-{OPERATOR}-{VALUE} An array of filter strings. |
sorts | Array of strings Example: sorts=?sorts[]={FIELD}-{DIRECTION} An array of sort strings. |
page | number Example: page=?page={PAGE_NUMBER} The page number to retrieve. |
per_page | number Example: per_page=?per_page={QUANTITY} The number of items per page to retrieve. |
withTrashed | number Enum: 0 1 Example: withTrashed=?withTrashed=1 Includes soft deleted resources. |
include | string Example: include=?include=resources Comma separated string of related data to include in the response. |
Authorization required | string The access token obtained through authentication. |
X-Request-ID | string <uuid> The Request ID to be used for replaying requests in case of an unstable internet connection. |
Content-Type | string <uuid> Type of the content used on response; it should always be |
[- {
- "id": "string",
- "isCheckIn": true,
- "isAttending": true,
- "publicUserID": 0,
- "source": "upload",
- "eventID": 0,
- "values": { },
- "companyID": 0,
- "lastModified": "2019-01-01T00:00:00+00:00",
- "created": "2019-01-01T00:00:00+00:00",
- "timeArrived": "2019-01-01T00:00:00+00:00",
- "versions": [ ],
- "valueValidationErrors": [ ],
- "deleted": {
- "dateDeleted": "2019-01-01T00:00:00+00:00",
- "userID": 0
}, - "updated": {
- "dateUpdated": "2019-01-01T00:00:00+00:00",
- "appUserID": 0
}, - "resources": [
- {
- "id": "57bc22499056057bc2249905",
- "type": "image/jpeg",
- "created": "2019-01-01T00:00:00+00:00",
- "lastModified": "2019-01-01T00:00:00+00:00"
}
], - "parent": { },
- "children": { },
- "starred": true,
- "badgeIntegrationSuccess": true,
- "isDuplicate": true,
- "isMainDuplicate": true,
- "duplicateOf": "string",
- "isCheckedIn": true,
- "statuses": [ ],
- "badgeIntegrationHistory": {
- "success": true,
- "response": "string",
- "timestamp": "2019-01-01T00:00:00+00:00"
}
}
]
eventID required | string The unique identifier of the event for which the record will be created. |
Authorization required | string The access token obtained through authentication. |
Content-Type | string <uuid> Type of the content used on response; it should always be |
X-Request-ID required | string <uuid> The Request ID to be used for replaying requests in case of an unstable internet connection. |
isCheckIn | boolean Indicates if the record was uploaded as part of a check-in list. |
required | object The responses to questions defined for the event. See the values section for more information. |
required | RFC3339 UTC Date (string) or null Indicates when the record was created on the client. |
starred | boolean Flag indicating if the record is important. |
Array of arrays or null Statuses of a lead. |
{- "isCheckIn": true,
- "isAttending": true,
- "publicUserID": 0
}
{- "id": "57178e112798716007123456",
- "isCheckIn": true,
- "appUserID": null,
- "source": "upload",
- "eventID": 1,
- "values": {
- "firstName": {
- "value": "Jane"
}, - "lastName": {
- "value": "Dow"
}
}, - "companyID": 1,
- "created": "2018-04-20T15:11:29+01:00",
- "lastModified": "2018-04-20T15:11:29+01:00"
}
eventID required | string The unique identifier of the event from which the record should be retrieved. |
recordID required | string The unique identifier of the record to be retrieved. |
includeParent | string Example: includeParent=?include=parent Includes parent record if duplicate |
includeChildren | string Example: includeChildren=?include=children Includes child records if duplicate |
include | string Example: include=?include=resources Comma separated string of related data to include in the response. |
Authorization required | string The access token obtained through authentication. |
X-Request-ID | string <uuid> The Request ID to be used for replaying requests in case of an unstable internet connection. |
Content-Type | string <uuid> Type of the content used on response; it should always be |
[- {
- "id": "string",
- "isCheckIn": true,
- "isAttending": true,
- "publicUserID": 0,
- "source": "upload",
- "eventID": 0,
- "values": { },
- "companyID": 0,
- "lastModified": "2019-01-01T00:00:00+00:00",
- "created": "2019-01-01T00:00:00+00:00",
- "timeArrived": "2019-01-01T00:00:00+00:00",
- "versions": [ ],
- "valueValidationErrors": [ ],
- "deleted": {
- "dateDeleted": "2019-01-01T00:00:00+00:00",
- "userID": 0
}, - "updated": {
- "dateUpdated": "2019-01-01T00:00:00+00:00",
- "appUserID": 0
}, - "resources": [
- {
- "id": "57bc22499056057bc2249905",
- "type": "image/jpeg",
- "created": "2019-01-01T00:00:00+00:00",
- "lastModified": "2019-01-01T00:00:00+00:00"
}
], - "parent": { },
- "children": { },
- "starred": true,
- "badgeIntegrationSuccess": true,
- "isDuplicate": true,
- "isMainDuplicate": true,
- "duplicateOf": "string",
- "isCheckedIn": true,
- "statuses": [ ],
- "badgeIntegrationHistory": {
- "success": true,
- "response": "string",
- "timestamp": "2019-01-01T00:00:00+00:00"
}
}
]
eventID required | string The unique identifier of the event for which the record is to be updated. |
recordID required | string The unique identifier of the record to be updated. |
Authorization required | string The access token obtained through authentication. |
Content-Type | string <uuid> Type of the content used on response; it should always be |
X-Request-ID required | string <uuid> The Request ID to be used for replaying requests in case of an unstable internet connection. |
isCheckIn | boolean Indicates if the record was uploaded as part of a check-in list. |
object The responses to questions defined for the event. See the values section for more information. | |
RFC3339 UTC Date (string) or null Indicates when the record was created on the client. | |
starred | boolean Flag indicating if the record is important. |
Array of arrays or null Statuses of a lead. |
{- "isCheckIn": true,
- "values": { },
- "timeArrived": "2019-01-01T00:00:00+00:00",
- "starred": true,
- "statuses": [ ]
}
{- "id": "string",
- "isCheckIn": true,
- "isAttending": true,
- "publicUserID": 0,
- "source": "upload",
- "eventID": 0,
- "values": { },
- "companyID": 0,
- "lastModified": "2019-01-01T00:00:00+00:00",
- "created": "2019-01-01T00:00:00+00:00",
- "timeArrived": "2019-01-01T00:00:00+00:00",
- "versions": [ ],
- "valueValidationErrors": [ ],
- "deleted": {
- "dateDeleted": "2019-01-01T00:00:00+00:00",
- "userID": 0
}, - "updated": {
- "dateUpdated": "2019-01-01T00:00:00+00:00",
- "appUserID": 0
}, - "resources": [
- {
- "id": "57bc22499056057bc2249905",
- "type": "image/jpeg",
- "created": "2019-01-01T00:00:00+00:00",
- "lastModified": "2019-01-01T00:00:00+00:00"
}
], - "parent": { },
- "children": { },
- "starred": true,
- "badgeIntegrationSuccess": true,
- "isDuplicate": true,
- "isMainDuplicate": true,
- "duplicateOf": "string",
- "isCheckedIn": true,
- "statuses": [ ],
- "badgeIntegrationHistory": {
- "success": true,
- "response": "string",
- "timestamp": "2019-01-01T00:00:00+00:00"
}
}
eventID required | string The unique identifier of the event for which the record should be deleted. |
recordID required | string The unique identifier of the record to be deleted. |
Authorization required | string The access token obtained through authentication. |
Content-Type | string <uuid> Type of the content used on response; it should always be |
X-Request-ID required | string <uuid> The Request ID to be used for replaying requests in case of an unstable internet connection. |
{- "error": {
- "message": "Unauthorized"
}
}
eventID required | string The unique identifier of the event containing the record for which the resources should be retrieved. |
recordID required | string The unique identifier of the record for which resources should be retrieved. |
Authorization required | string The access token obtained through authentication. |
X-Request-ID | string <uuid> The Request ID to be used for replaying requests in case of an unstable internet connection. |
Content-Type | string <uuid> Type of the content used on response; it should always be |
[- {
- "id": "57bc22499056057bc2249905",
- "type": "image/jpeg",
- "created": "2019-01-01T00:00:00+00:00",
- "lastModified": "2019-01-01T00:00:00+00:00",
- "turkCompleted": "string"
}
]
Creates the metadata entry for a record resource and provides a URL for uploading the binary data.
The URL used to upload the binary data is contained within the Location
header of the response which is essentially
a pre-populated link to the endpoint upload the binary data for a resource.
eventID required | string The unique identifier of the event for which the record resource should be created. |
recordID required | string The unique identifier of the record for which the resource should be created. |
Authorization required | string The access token obtained through authentication. |
Content-Type | string <uuid> Type of the content used on response; it should always be |
X-Upload-Content-Type required | string Example: image/jpeg The mime-type of the resource that will be uploaded. |
X-Upload-Content-Length | string Example: 856000 The size (bytes) of the resource that will be uploaded. |
X-Request-ID required | string <uuid> The Request ID to be used for replaying requests in case of an unstable internet connection. |
id | string The GUID which will be associated with the resource. If not supplied this will value be auto-generated. |
null
null
eventID required | string The unique identifier of the event containing the record for which the resource should be retrieved. |
recordID required | string The unique identifier of the record for which the resource should be retrieved. |
resourceID required | string The unique identifier of the resource. |
Authorization required | string The access token obtained through authentication. |
X-Request-ID | string <uuid> The Request ID to be used for replaying requests in case of an unstable internet connection. |
Content-Type | string <uuid> Type of the content used on response; it should always be |
{- "id": "57bc22499056057bc2249905",
- "type": "image/jpeg",
- "created": "2019-01-01T00:00:00+00:00",
- "lastModified": "2019-01-01T00:00:00+00:00",
- "turkCompleted": "string"
}
A Resource is comprised of metadata and binary data of an asset (image/document) and is associated with a record or an event. To create and retrieve record resources, see Create the metadata for a record's resource.
Please note, the maximum file size that can be uploaded is limited to 25mb. The number of binaries that customers upload is logged, and if deemed to be excessive, we may impose limits to usage. For more information, you can request access to our Fair Usage Policy.
id required | string Example: id=id=startup-2048x1496.png The unique identifer of the resource to which the binary data should be uploaded. |
type required | integer <int32> The mime type of the resource being uploaded. |
source required | string Example: source=source=event The source of the image: |
Authorization required | string The access token obtained through authentication. |
Content-Type | string <uuid> Type of the content used on response; it should always be |
X-Request-ID required | string <uuid> The Request ID to be used for replaying requests in case of an unstable internet connection. |
{- "id": "d70fb9cfa2fc31318123a755d03c4157f6afe920b29bb3ef550c913cb8ebe818"
}
resourceID required | string The unique identifier of the resource for which the binary data should be downloaded. |
type required | string The type of the resource to be retrieved. This should be |
Authorization required | string The access token obtained through authentication. |
Content-Type | string <uuid> Type of the content used on response; it should always be |
{- "error": {
- "message": "Unauthorized"
}
}