Docy

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

fieldtypedescription
contactEmailmandatory stringthe primary email display name and contact
descriptionoptional stringadditional information about the event
endmandatory ISO8601 date/timeUTC event end date/time
idmandatory stringvisit unique ID
namemandatory stringevent name
referenceoptional stringfor storing foreign id. Not enforced to be unique amongst other events.
revisionmandatory longincremental number for change tracking
startmandatory ISO8601 date/timeUTC event start date
timezonemandatory stringlocal timezone in country of event

CONTENTS