GET
/expos
Returns a list of events available for the API key in use. The number of items returned is capped at 100. Where more than 100 events are available, use the fromRevision parameter to get the additional items.
Optional Parameters
?limit=[n]
Limits the number of events returned to [n], where n is an integer value between 1 and 100.
?fromRevision=[n]
Returns events where the revision number is equal to [n] or higher.
?reference=[ref]
Returns events where the reference matches the supplied value [ref]. Visit does not enforce the reference to be unique within an account, therefore multiple events may be returned. The match is case-sensitive.
Sample Response
[
{
"contactEmail": "\"Sample Event 1\"",
"description": "",
"end": "2013-05-08T00:00:00Z",
"id": "0blufbaj2mqf9",
"name": "Event 1",
"reference": "",
"revision": 5757450217,
"start": "2013-05-01T00:00:00Z",
"timezone": "Asia/Bangkok"
},
{
"contactEmail": "\"Sample Event 2\"",
"description": "",
"end": "2013-10-01T00:00:00Z",
"id": "38srplt51jyiw",
"name": "Event 2",
"reference": "",
"revision": 5757450476,
"start": "2013-09-30T00:00:00Z",
"timezone": "Europe/Amsterdam"
}
]
Field List
field | type | description |
---|---|---|
contactEmail | mandatory string | the primary email display name and contact |
description | optional string | additional information about the event |
end | mandatory ISO8601 date/time | UTC event end date/time |
id | mandatory string | visit unique ID |
name | mandatory string | event name |
reference | optional string | for storing foreign id. Not enforced to be unique amongst other events. |
revision | mandatory long | incremental number for change tracking |
start | mandatory ISO8601 date/time | UTC event start date |
timezone | mandatory string | local timezone in country of event |