Events

The event object

An event of your organization: a conference, a congress, a trade fair… Its registrations, calls for papers and papers link to it by its id.

Attributes

idstring

Unique identifier for the object: the event's reference on the platform.

objectenum

String representing the object's type. Always event.

Possible values

event

titlestring

The event's title.

statusenum

The event's status. A client must accept a value it does not know: adding a value is a compatible change.

Possible values

draft
scheduled
opened
suspended
reported
closed
canceled

typeenumnullable

The kind of event; null when it has none. A client must accept a value it does not know.

Possible values

conference
race
fundraiser
ceremony
festival
business
virtual

starts_attimestampnullable

When the event starts, in Unix seconds (UTC); null when it is not set.

ends_attimestampnullable

When the event ends, in Unix seconds (UTC); null when it is not set.

timezonestringnullable

The event's time zone, an IANA name such as Europe/Paris: the zone to show its dates in; null when it is not set.

languagesarray of stringnot included in lists by default

The languages the event is held in (ISO 639-1 codes, sorted); [] when none. Always in a retrieve; not included by default in lists: ask for it with expand[]=data.languages.

venueobjectnullablenot included in lists by default

The event's venue (the first one attached); null when it has none. Always in a retrieve; not included by default in lists: ask for it with expand[]=data.venue.

Child attributes

namestringnullable: The venue's name.
streetstringnullable: The street (number and street name).
postal_codestringnullable: The postal code.
citystringnullable: The city.
countrystringnullable: The country, as the organizer wrote it.

urlstring

The event's public registration page.

createdtimestamp

Time at which the object was created, in Unix seconds (UTC).

updatedtimestampnullable

Time at which the object was last modified, in Unix seconds (UTC); null when the platform holds none.

Example object

{
  "id": "EVT-5a1f0c2e-3b7d-4e91-9c2a-1d6e8f4b7a30",
  "object": "event",
  "title": "International Conference on Renewable Energy 2027",
  "status": "opened",
  "type": "conference",
  "starts_at": 1810112400,
  "ends_at": 1810314000,
  "timezone": "Europe/Paris",
  "languages": [
    "en",
    "fr"
  ],
  "venue": {
    "name": "Palais des congrès",
    "street": "2 place de la Porte Maillot",
    "postal_code": "75017",
    "city": "Paris",
    "country": "France"
  },
  "url": "https://register.masterconf.com/events/EVT-5a1f0c2e-3b7d-4e91-9c2a-1d6e8f4b7a30",
  "created": 1780304400,
  "updated": 1791892800
}

Retrieve an event

GET/v1/events/{id}

Retrieves the event with this id, its languages and its venue included. An event of another organization answers resource_missing, like an id that does not exist.

Requires the scope events_read.

Path parameters

idstringrequired: The id of the event.

Query parameters

expand[]array of stringoptional: An event has nothing to expand (its languages and its venue are always in a retrieve): any value answers parameter_invalid.

Returns

Returns the event object.

Error codes

Request

curl

curl -G https://api.masterconf.com/v1/events/EVT-5a1f0c2e-3b7d-4e91-9c2a-1d6e8f4b7a30 \
  -H "Authorization: Bearer mcf_your_key"

JavaScript

const res = await fetch("https://api.masterconf.com/v1/events/EVT-5a1f0c2e-3b7d-4e91-9c2a-1d6e8f4b7a30", {
  headers: { Authorization: "Bearer mcf_your_key" },
});
const data = await res.json();

Python

import requests

res = requests.get(
    "https://api.masterconf.com/v1/events/EVT-5a1f0c2e-3b7d-4e91-9c2a-1d6e8f4b7a30",
    headers={"Authorization": "Bearer mcf_your_key"},
)
data = res.json()

Response

{
  "id": "EVT-5a1f0c2e-3b7d-4e91-9c2a-1d6e8f4b7a30",
  "object": "event",
  "title": "International Conference on Renewable Energy 2027",
  "status": "opened",
  "type": "conference",
  "starts_at": 1810112400,
  "ends_at": 1810314000,
  "timezone": "Europe/Paris",
  "languages": [
    "en",
    "fr"
  ],
  "venue": {
    "name": "Palais des congrès",
    "street": "2 place de la Porte Maillot",
    "postal_code": "75017",
    "city": "Paris",
    "country": "France"
  },
  "url": "https://register.masterconf.com/events/EVT-5a1f0c2e-3b7d-4e91-9c2a-1d6e8f4b7a30",
  "created": 1780304400,
  "updated": 1791892800
}

List events

GET/v1/events

Returns a page of your organization's events, newest first (created descending, then id descending). Walk the pages with starting_after (or ending_before). The languages and the venue of each event are not included by default: ask for them with expand[]=data.languages and expand[]=data.venue (each costs one more read per event of the page).

Requires the scope events_read.

Query parameters

statusarray of enumoptional: Only the events in this status. Repeat the parameter for several (status=opened&status=scheduled).
Possible values
draft
scheduled
opened
suspended
reported
closed
canceled
limitintegeroptional: The number of objects of the page, from 1 to 100; at most 20 when the request has an expand[] (each expanded or included field costs reads per object of the page).
Defaults to 10.
starting_afterstringoptional: A cursor for the next page: the id of an object of this list (the last one of the page you have); the page holds the objects that follow it. Not with ending_before.
ending_beforestringoptional: A cursor for the previous page: the id of an object of this list (the first one of the page you have); the page holds the objects that precede it, in the same order. Not with starting_after.
include[]array of enumoptional: total_count: add total_count, the number of objects of the whole list.
Possible values
total_count
expand[]array of enumoptional: data.languages, data.venue: include these fields in each event of the page. Repeat the parameter for both.
Possible values
data.languages
data.venue

Returns

Returns a list object whose data are event objects.

Error codes

Request

curl

curl -G https://api.masterconf.com/v1/events \
  -H "Authorization: Bearer mcf_your_key"

JavaScript

const res = await fetch("https://api.masterconf.com/v1/events", {
  headers: { Authorization: "Bearer mcf_your_key" },
});
const data = await res.json();

Python

import requests

res = requests.get(
    "https://api.masterconf.com/v1/events",
    headers={"Authorization": "Bearer mcf_your_key"},
)
data = res.json()

Response

{
  "object": "list",
  "url": "/v1/events",
  "has_more": true,
  "data": [
    {
      "id": "EVT-5a1f0c2e-3b7d-4e91-9c2a-1d6e8f4b7a30",
      "object": "event",
      "title": "International Conference on Renewable Energy 2027",
      "status": "opened",
      "type": "conference",
      "starts_at": 1810112400,
      "ends_at": 1810314000,
      "timezone": "Europe/Paris",
      "url": "https://register.masterconf.com/events/EVT-5a1f0c2e-3b7d-4e91-9c2a-1d6e8f4b7a30",
      "created": 1780304400,
      "updated": 1791892800
    }
  ]
}