Menu
Thème
Ouvrir la console
APIVersion de l’API v1
Ouvrir la consoleEnglish

Événements

L’objet event

Un événement de votre organisation : une conférence, un congrès, un salon… Ses inscriptions, ses appels à communications et ses communications y renvoient par son id.

Attributs

idstring
Identifiant unique de l’objet : la référence de l’événement sur la plateforme.
objectenum
Texte qui indique le type de l’objet. Toujours event.
Valeurs possibles
  • event
titlestring
Le titre de l’événement.
statusenum
Le statut de l’événement. Un client doit accepter une valeur qu’il ne connaît pas : l’ajout d’une valeur est une évolution compatible.
Valeurs possibles
  • draft
  • scheduled
  • opened
  • suspended
  • reported
  • closed
  • canceled
typeenumpeut être null
La nature de l’événement ; null s’il n’en a pas. Un client doit accepter une valeur qu’il ne connaît pas.
Valeurs possibles
  • conference
  • race
  • fundraiser
  • ceremony
  • festival
  • business
  • virtual
starts_attimestamppeut être null
Le début de l’événement, en secondes Unix (UTC) ; null s’il n’est pas fixé.
ends_attimestamppeut être null
La fin de l’événement, en secondes Unix (UTC) ; null si elle n’est pas fixée.
timezonestringpeut être null
Le fuseau horaire de l’événement, un nom IANA comme Europe/Paris : le fuseau dans lequel afficher ses dates ; null s’il n’est pas fixé.
languagesarray of stringabsent des listes par défaut
Les langues de l’événement (codes ISO 639-1, triés) ; [] s’il n’en a aucune. Toujours présent dans une lecture unitaire ; absent par défaut des listes : demandez-le avec expand[]=data.languages.
venueobjectpeut être nullabsent des listes par défaut
Le lieu de l’événement (le premier qui lui est rattaché) ; null s’il n’en a aucun. Toujours présent dans une lecture unitaire ; absent par défaut des listes : demandez-le avec expand[]=data.venue.
Attributs enfants
namestringpeut être null
Le nom du lieu.
streetstringpeut être null
La rue (numéro et nom de la voie).
postal_codestringpeut être null
Le code postal.
citystringpeut être null
La ville.
countrystringpeut être null
Le pays, tel que l’organisateur l’a saisi.
urlstring
La page publique d’inscription à l’événement.
createdtimestamp
La date de création de l’objet, en secondes Unix (UTC).
updatedtimestamppeut être null
La date de la dernière modification de l’objet, en secondes Unix (UTC) ; null si la plateforme n’en a pas.
Exemple d’objet
{
  "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
}

Lire un événement

GET/v1/events/{id}

Renvoie l’événement de cet identifiant, ses langues et son lieu compris. Un événement d’une autre organisation renvoie resource_missing, comme un identifiant qui n’existe pas.

Demande le droit events_read.

Paramètres de chemin

idstringobligatoire
L’identifiant de l’événement.

Paramètres de requête

expand[]array of stringfacultatif
Un événement n’a rien à développer (ses langues et son lieu sont toujours présents dans une lecture unitaire) : toute valeur renvoie parameter_invalid.

Renvoie

Renvoie l’objet event.

Codes d’erreur

Requête

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()
Réponse
{
  "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
}

Lister les événements

GET/v1/events

Renvoie une page des événements de votre organisation, du plus récent au plus ancien (created décroissant, puis id décroissant). Parcourez les pages avec starting_after (ou ending_before). Les languages et le venue de chaque événement sont absents par défaut : demandez-les avec expand[]=data.languages et expand[]=data.venue (chacun coûte une lecture de plus par événement de la page).

Demande le droit events_read.

Paramètres de requête

statusarray of enumfacultatif
Seulement les événements de ce statut. Répétez le paramètre pour en donner plusieurs (status=opened&status=scheduled).
Valeurs possibles
  • draft
  • scheduled
  • opened
  • suspended
  • reported
  • closed
  • canceled
limitintegerfacultatif
Le nombre d’objets de la page, de 1 à 100 ; au plus 20 quand la requête a un expand[] (chaque champ développé ou inclus coûte des lectures par objet de la page).

Valeur par défaut : 10.

starting_afterstringfacultatif
Un curseur pour la page suivante : l’identifiant d’un objet de cette liste (le dernier de la page que vous avez) ; la page contient les objets qui le suivent. Pas avec ending_before.
ending_beforestringfacultatif
Un curseur pour la page précédente : l’identifiant d’un objet de cette liste (le premier de la page que vous avez) ; la page contient les objets qui le précèdent, dans le même ordre. Pas avec starting_after.
include[]array of enumfacultatif
total_count : ajouter total_count, le nombre d’objets de toute la liste.
Valeurs possibles
  • total_count
expand[]array of enumfacultatif
data.languages, data.venue : inclure ces champs dans chaque événement de la page. Répétez le paramètre pour les deux.
Valeurs possibles
  • data.languages
  • data.venue

Renvoie

Renvoie un objet list dont les data sont des objets event.

Codes d’erreur

Requête

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()
Réponse
{
  "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
    }
  ]
}