Retrieve a list of events
get
/api/bulk/2.0/events
Retrieves all events that match the criteria specified in the URL parameters.
Request
Supported Media Types
- application/json
- text/csv
Query Parameters
Back to Top
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : EventSearchResponse
Type:
object
Title:
Show Source
EventSearchResponse
-
count(optional):
integer
Title:
count
-
hasMore(optional):
boolean
Title:
hasMore
-
items(optional):
array items
Title:
items
-
limit(optional):
integer
Title:
limit
-
offset(optional):
integer
Title:
offset
-
totalResults(optional):
integer(int64)
Title:
totalResults
Nested Schema : Event
Type:
object
Title:
Show Source
Event
-
createdAt(optional):
string(date-time)
Title:
createdAt
-
createdBy(optional):
string
Title:
createdBy
-
displayNameFieldUri(optional):
string
Title:
displayNameFieldUri
-
emailAddressFieldUri(optional):
string
Title:
emailAddressFieldUri
-
name(optional):
string
Title:
name
-
uniqueFieldUri(optional):
string
Title:
uniqueFieldUri
-
updatedAt(optional):
string(date-time)
Title:
updatedAt
-
updatedBy(optional):
string
Title:
updatedBy
-
uri(optional):
string
Title:
uri
400 Response
Bad request. See Status Codes for information about other possible HTTP status codes.
401 Response
Unauthorized. See Status Codes for information about other possible HTTP status codes.
403 Response
Forbidden. See Status Codes for information about other possible HTTP status codes.
404 Response
The requested resource was not found. See Status Codes for information about other possible HTTP status codes.
409 Response
There was a conflict. See Status Codes for information about other possible HTTP status codes.
410 Response
The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes.
412 Response
The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes.
413 Response
Storage space exceeded. See Status Codes for information about other possible HTTP status codes.
500 Response
The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes.
503 Response
There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes.
Examples
Retrieve a list of the first 2 events in your database:
GET /events?limit=2
Response:
{
"items": [
{
"name": "Example Event",
"displayNameFieldUri": "/events/5/fields/34",
"emailAddressFieldUri": "/events/5/fields/34",
"uniqueFieldUri": "/events/5/fields/34",
"createdBy": "API.User",
"createdAt": "2016-03-23T15:04:21.8400000Z",
"updatedBy": "API.User",
"updatedAt": "2016-05-30T18:00:46.9200000Z",
"uri": "/events/5"
},
{
"name": "Summer 2016 Hotdog Eating Contest",
"createdBy": "API.User",
"createdAt": "2016-10-21T20:51:56.8470000Z",
"updatedBy": "API.User",
"updatedAt": "2016-10-21T21:03:44.8500000Z",
"uri": "/events/12"
}
],
"totalResults": 5,
"limit": 2,
"offset": 0,
"count": 2,
"hasMore": true
}