Papers

The paper object

A paper submitted to a call for papers: its title, its summary, its authors (names and affiliations, never an e-mail), its themes and its verified journal references. Its reviews, reviewers and scores are never part of it.

Attributes

idstring

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

objectenum

String representing the object's type. Always paper.

Possible values

paper

call_for_papersstring or expanded call_for_papers objectexpandable

The call for papers the paper was submitted to: its id, or the call object when it is expanded (expand[]=call_for_papers, or expand[]=data.call_for_papers in a list).

eventstring or expanded event objectexpandable

The event of the paper's call: its id, or the event object when it is expanded (expand[]=event, or expand[]=data.event in a list; needs events_read).

titlestringnullable

The paper's title.

summarystringnullable

The paper's summary, as plain text.

statusenum

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

Possible values

draft
submitted
reviewed
approved
refused
backup
waiting_for_poster
published
presented
canceled

categoryenumnullable

The paper's category; null when it has none. A client must accept a value it does not know.

Possible values

research
review
case_study
short_communication
perspective
technical
empirical
conceptual
meta_analysis
book_review
abstract
other

authorsarray of object

The paper's authors, by position; [] when none.

Child attributes

namestringnullable: The author's name.
positionintegernullable: The author's position in the list of authors, from 1; null when it is not set.
affiliationsarray of string: The author's affiliations, one readable line each (name, department, institution, city, country: the parts given, in that order); [] when none.

themesarray of string

The names of the paper's themes, sorted; [] when none.

journal_referencesarray of object

The paper's journal references verified against their index; [] when none (a reference not verified yet is left out).

Child attributes

providerenum: The index the reference was verified against. A client must accept a value it does not know.
Possible values
scimago
scopus
pubmed
crossref
wos
kindenum: indexed: the paper is published in the journal; planned: it will be submitted to it. A client must accept a value it does not know.
Possible values
indexed
planned
identifierstringnullable: The identifier of the record in the index; null when there is none.
doistringnullable: The paper's DOI; null when there is none.
journal_titlestringnullable: The journal's title; null when it is not known.

published_attimestampnullable

When the paper was published, in Unix seconds (UTC); null when it was not.

presented_attimestampnullable

When the paper was presented, in Unix seconds (UTC); null when it was not.

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": "PAP-6e4a1b93-5c2d-4f7e-a8b0-9d3c71e2f548",
  "object": "paper",
  "call_for_papers": "CFP-2d9b6f14-7a3c-4b58-8e01-c4f7a2d95b83",
  "event": "EVT-5a1f0c2e-3b7d-4e91-9c2a-1d6e8f4b7a30",
  "title": "Seasonal storage of solar heat in district networks",
  "summary": "We report two years of measurements of a borehole store coupled to a district heating network.",
  "status": "approved",
  "category": "research",
  "authors": [
    {
      "name": "Grace Hopper",
      "position": 1,
      "affiliations": [
        "Energy Lab, Department of Physics, University of Lyon, Lyon, France"
      ]
    },
    {
      "name": "Alan Turing",
      "position": 2,
      "affiliations": []
    }
  ],
  "themes": [
    "Energy storage",
    "Solar power"
  ],
  "journal_references": [
    {
      "provider": "crossref",
      "kind": "indexed",
      "identifier": "10.1016/j.energy.2027.01.042",
      "doi": "10.1016/j.energy.2027.01.042",
      "journal_title": "Energy"
    }
  ],
  "published_at": null,
  "presented_at": null,
  "created": 1792843200,
  "updated": 1801483200
}

Retrieve a paper

GET/v1/papers/{id}

Retrieves the paper with this id, with its authors (names and affiliations, never an e-mail address), its themes and its verified journal references. expand[]=call_for_papers gives the call object and expand[]=event the event object in place of their ids (the event needs events_read). Needs the calls for papers module in your organization's plan. A paper of another organization answers resource_missing, like an id that does not exist.

Requires the scope calls_for_papers_read.

Path parameters

idstringrequired: The id of the paper.

Query parameters

expand[]array of enumoptional: call_for_papers: the call object in place of its id; event: the event object in place of its id (needs events_read). Repeat the parameter for both.
Possible values
call_for_papers
event

Returns

Returns the paper object.

Error codes

Request

curl

curl -G https://api.masterconf.com/v1/papers/PAP-6e4a1b93-5c2d-4f7e-a8b0-9d3c71e2f548 \
  -H "Authorization: Bearer mcf_your_key"

JavaScript

const res = await fetch("https://api.masterconf.com/v1/papers/PAP-6e4a1b93-5c2d-4f7e-a8b0-9d3c71e2f548", {
  headers: { Authorization: "Bearer mcf_your_key" },
});
const data = await res.json();

Python

import requests

res = requests.get(
    "https://api.masterconf.com/v1/papers/PAP-6e4a1b93-5c2d-4f7e-a8b0-9d3c71e2f548",
    headers={"Authorization": "Bearer mcf_your_key"},
)
data = res.json()

Response

{
  "id": "PAP-6e4a1b93-5c2d-4f7e-a8b0-9d3c71e2f548",
  "object": "paper",
  "call_for_papers": "CFP-2d9b6f14-7a3c-4b58-8e01-c4f7a2d95b83",
  "event": "EVT-5a1f0c2e-3b7d-4e91-9c2a-1d6e8f4b7a30",
  "title": "Seasonal storage of solar heat in district networks",
  "summary": "We report two years of measurements of a borehole store coupled to a district heating network.",
  "status": "approved",
  "category": "research",
  "authors": [
    {
      "name": "Grace Hopper",
      "position": 1,
      "affiliations": [
        "Energy Lab, Department of Physics, University of Lyon, Lyon, France"
      ]
    },
    {
      "name": "Alan Turing",
      "position": 2,
      "affiliations": []
    }
  ],
  "themes": [
    "Energy storage",
    "Solar power"
  ],
  "journal_references": [
    {
      "provider": "crossref",
      "kind": "indexed",
      "identifier": "10.1016/j.energy.2027.01.042",
      "doi": "10.1016/j.energy.2027.01.042",
      "journal_title": "Energy"
    }
  ],
  "published_at": null,
  "presented_at": null,
  "created": 1792843200,
  "updated": 1801483200
}

List the papers of a call for papers

GET/v1/papers

Returns a page of the papers of one call for papers (the call_for_papers parameter is required), newest first (created descending, then id descending). Walk the pages with starting_after (or ending_before). Needs the calls for papers module in your organization's plan. A call of another organization answers resource_missing on call_for_papers.

Requires the scope calls_for_papers_read.

Query parameters

call_for_papersstringrequired: The id of the call for papers whose papers are listed. Required.
statusarray of enumoptional: Only the papers in this status. Repeat the parameter for several (status=approved&status=published).
Possible values
draft
submitted
reviewed
approved
refused
backup
waiting_for_poster
published
presented
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.call_for_papers, data.event: the call or the event object in place of its id in each paper (the event needs events_read). Repeat the parameter for both.
Possible values
data.call_for_papers
data.event

Returns

Returns a list object whose data are paper objects.

Error codes

Request

curl

curl -G https://api.masterconf.com/v1/papers \
  -H "Authorization: Bearer mcf_your_key" \
  --data-urlencode "call_for_papers=CFP-2d9b6f14-7a3c-4b58-8e01-c4f7a2d95b83"

JavaScript

const params = new URLSearchParams({
  "call_for_papers": "CFP-2d9b6f14-7a3c-4b58-8e01-c4f7a2d95b83",
});

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

Python

import requests

res = requests.get(
    "https://api.masterconf.com/v1/papers",
    params={"call_for_papers": "CFP-2d9b6f14-7a3c-4b58-8e01-c4f7a2d95b83"},
    headers={"Authorization": "Bearer mcf_your_key"},
)
data = res.json()

Response

{
  "object": "list",
  "url": "/v1/papers",
  "has_more": true,
  "data": [
    {
      "id": "PAP-6e4a1b93-5c2d-4f7e-a8b0-9d3c71e2f548",
      "object": "paper",
      "call_for_papers": "CFP-2d9b6f14-7a3c-4b58-8e01-c4f7a2d95b83",
      "event": "EVT-5a1f0c2e-3b7d-4e91-9c2a-1d6e8f4b7a30",
      "title": "Seasonal storage of solar heat in district networks",
      "summary": "We report two years of measurements of a borehole store coupled to a district heating network.",
      "status": "approved",
      "category": "research",
      "authors": [
        {
          "name": "Grace Hopper",
          "position": 1,
          "affiliations": [
            "Energy Lab, Department of Physics, University of Lyon, Lyon, France"
          ]
        },
        {
          "name": "Alan Turing",
          "position": 2,
          "affiliations": []
        }
      ],
      "themes": [
        "Energy storage",
        "Solar power"
      ],
      "journal_references": [
        {
          "provider": "crossref",
          "kind": "indexed",
          "identifier": "10.1016/j.energy.2027.01.042",
          "doi": "10.1016/j.energy.2027.01.042",
          "journal_title": "Energy"
        }
      ],
      "published_at": null,
      "presented_at": null,
      "created": 1792843200,
      "updated": 1801483200
    }
  ]
}