OpenAPI definition

Register a new user

POSThttps://api.openreview.net/register

Body

application/json

emailstring

Email that will be used to log in to OpenReview.

passwordstring

nameobject

idstring

This is a Profile id. This parameter is only required when claiming an existing a Profile in OpenReview.

Response

200

The Profile that is saved to the database.

Body

application/json

id*string

activeboolean

passwordboolean

invitation*string

content*ProfileContent (object)

metaContentobject

tcdateinteger

tmdateinteger

tauthorstring

readers*array of string

nonreadersarray of string

writers*array of string

signatures*array of string

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/register', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "active": false,
  "password": false,
  "invitation": "text",
  "content": {
    "preferredEmail": "text",
    "gender": "text",
    "homepage": "text",
    "dblp": "text",
    "gscholar": "text",
    "wikipedia": "text",
    "linkedin": "text",
    "orcid": "text",
    "names": [
      {
        "preferred": false,
        "first": "text",
        "middle": "text",
        "last": "text",
        "username": "text"
      }
    ],
    "emails": [
      "text"
    ],
    "history": [
      {
        "position": "text",
        "institution": {
          "name": "text",
          "domain": "text"
        }
      }
    ],
    "relations": [
      {
        "relation": "text",
        "name": "text",
        "email": "text"
      }
    ],
    "expertise": [
      {
        "keywords": [
          "text"
        ]
      }
    ]
  },
  "tauthor": "text",
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatures": [
    "text"
  ]
}

Reset a user password

PUThttps://api.openreview.net/reset/{token}

Path parameters

token*string

reset token

Body

application/json

password*string

Response

200

User is logged in after the password is reset.

Body

application/json

tokenstring

userobject

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/reset/{token}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "password": "text"
    }),
});
const data = await response.json();

Response

{
  "token": "text",
  "user": {
    "id": "text",
    "profile": {
      "id": "text",
      "first": "text",
      "middle": "text",
      "last": "text",
      "emails": [
        "text"
      ],
      "preferredEmail": "text",
      "usernames": [
        "text"
      ],
      "preferredId": "text"
    }
  }
}

Impersonate a user

POSThttps://api.openreview.net/impersonate

Body

application/json

groupId*string

Response

200

User token of the impersonated user and details of the impersonation.

Body

application/json

tokenstring

userobject

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/impersonate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "groupId": "text"
    }),
});
const data = await response.json();

Response

{
  "token": "text",
  "user": {
    "id": "text",
    "profile": {
      "id": "text",
      "first": "text",
      "middle": "text",
      "last": "text",
      "emails": [
        "text"
      ],
      "preferredEmail": "text",
      "usernames": [
        "text"
      ],
      "preferredId": "text"
    },
    "impersonator": {
      "id": "text",
      "first": "text",
      "middle": "text",
      "last": "text",
      "emails": [
        "text"
      ],
      "preferredEmail": "text",
      "usernames": [
        "text"
      ],
      "preferredId": "text"
    },
    "disallowDataModification": false,
    "impersonatables": [
      "text"
    ]
  }
}

Gets the next available OpenReview username for the passed names.

GEThttps://api.openreview.net/tildeusername

Query parameters

Response

200

Next available tilde username

Body

application/json

usernamestring

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/tildeusername', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "username": "text"
}

Download an attachment

GEThttps://api.openreview.net/attachment

Query parameters

Response

200

Attachment

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/attachment', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Upload an attachment

PUThttps://api.openreview.net/attachment

Body

multipart/form-data

file*string (binary)

name*string

Attachment field name. This is usually pdf or supplementary_material.

invitationId*string

The id of the Invitation that allows to upload the attachment.

Response

200

Path to the attachment.

Body

application/json

urlstring

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/attachment', {
    method: 'PUT',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "file": "binary",
      "name": "text",
      "invitationId": "text"
    }),
});
const data = await response.json();

Response

{
  "url": "text"
}

Download a PDF

GEThttps://api.openreview.net/pdf

Query parameters

Response

200

PDF

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/pdf', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get edges

GEThttps://api.openreview.net/edges

Query parameters

Response

200

edges

Body

application/json

idstring

invitation*string

head*string

tail*string

labelstring

weightany of

numberstring

tcdateinteger

tmdateinteger

ddatenullable integer

tauthorstring

readersarray of string

nonreadersarray of string

writersarray of string

signatures*array of string

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/edges', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "invitation": "text",
    "head": "text",
    "tail": "text",
    "label": "text",
    "weight": 0,
    "tauthor": "text",
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatures": [
      "text"
    ]
  }
]

Create an edge

POSThttps://api.openreview.net/edges

Body

application/json

idstring

invitation*string

head*string

tail*string

labelstring

weightany of

numberstring

tcdateinteger

tmdateinteger

ddatenullable integer

tauthorstring

readersarray of string

nonreadersarray of string

writersarray of string

signatures*array of string

Response

200

Edge

Body

application/json

idstring

invitation*string

head*string

tail*string

labelstring

weightany of

numberstring

tcdateinteger

tmdateinteger

ddatenullable integer

tauthorstring

readersarray of string

nonreadersarray of string

writersarray of string

signatures*array of string

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/edges', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "invitation": "text",
      "head": "text",
      "tail": "text",
      "signatures": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "invitation": "text",
  "head": "text",
  "tail": "text",
  "label": "text",
  "weight": 0,
  "tauthor": "text",
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatures": [
    "text"
  ]
}

Delete an Edge

DELETEhttps://api.openreview.net/edges

Body

application/json

idstring

Edge id of the Edge to delete.

invitation*string

Invitation id used to create the Edge.

labelstring

Label of the Edge to delete.

tailstring

Tail value of the Edge to delete.

headstring

Head value of the Edge to delete.

softDeleteboolean

Whether to soft delete the Edge. When the Edge is soft deleted, the action can be reversed.

waitToFinishboolean

Whether to wait for the Edge(s) to be deleted.

Response

200

edge

Body

application/json

statusstring

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/edges', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "invitation": "text"
    }),
});
const data = await response.json();

Response

{
  "status": "text"
}

Send feedback to the OpenReview team

PUThttps://api.openreview.net/feedback

Body

application/json

from*string

Email address of the user sending the feedback.

subjectnullable string

Subject of the feedback.

message*string

The feedback.

Response

200

feedback

Body

application/json

statusstring

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/feedback', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "message": "text",
      "from": "text"
    }),
});
const data = await response.json();

Response

{
  "status": "text"
}

Get user profiles

GEThttps://api.openreview.net/profiles

Query parameters

Response

200

Profile response

Body

application/json

id*string

activeboolean

passwordboolean

invitation*string

content*ProfileContent (object)

metaContentobject

tcdateinteger

tmdateinteger

tauthorstring

readers*array of string

nonreadersarray of string

writers*array of string

signatures*array of string

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/profiles', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "active": false,
    "password": false,
    "invitation": "text",
    "content": {
      "preferredEmail": "text",
      "gender": "text",
      "homepage": "text",
      "dblp": "text",
      "gscholar": "text",
      "wikipedia": "text",
      "linkedin": "text",
      "orcid": "text",
      "names": [
        {
          "preferred": false,
          "first": "text",
          "middle": "text",
          "last": "text",
          "username": "text"
        }
      ],
      "emails": [
        "text"
      ],
      "history": [
        {
          "position": "text",
          "institution": {
            "name": "text",
            "domain": "text"
          }
        }
      ],
      "relations": [
        {
          "relation": "text",
          "name": "text",
          "email": "text"
        }
      ],
      "expertise": [
        {
          "keywords": [
            "text"
          ]
        }
      ]
    },
    "tauthor": "text",
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatures": [
      "text"
    ]
  }
]

Save user Profile

POSThttps://api.openreview.net/profiles

Body

application/json

Add a new piece of evidence to an existent Profile.

idstring

invitationstring

referentstring

tcdateinteger

tmdateinteger

ddatenullable integer

packagingobject

activeboolean

passwordboolean

tauthorstring

contentobject

metaContentobject

readersarray of string

nonreadersnullable array of string

writersarray of string

signatures*array of string

Response

200

Profile response

Body

application/json

id*string

activeboolean

passwordboolean

invitation*string

content*ProfileContent (object)

metaContentobject

tcdateinteger

tmdateinteger

tauthorstring

readers*array of string

nonreadersarray of string

writers*array of string

signatures*array of string

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/profiles', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "signatures": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "active": false,
  "password": false,
  "invitation": "text",
  "content": {
    "preferredEmail": "text",
    "gender": "text",
    "homepage": "text",
    "dblp": "text",
    "gscholar": "text",
    "wikipedia": "text",
    "linkedin": "text",
    "orcid": "text",
    "names": [
      {
        "preferred": false,
        "first": "text",
        "middle": "text",
        "last": "text",
        "username": "text"
      }
    ],
    "emails": [
      "text"
    ],
    "history": [
      {
        "position": "text",
        "institution": {
          "name": "text",
          "domain": "text"
        }
      }
    ],
    "relations": [
      {
        "relation": "text",
        "name": "text",
        "email": "text"
      }
    ],
    "expertise": [
      {
        "keywords": [
          "text"
        ]
      }
    ]
  },
  "tauthor": "text",
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatures": [
    "text"
  ]
}

Get user profiles

GEThttps://api.openreview.net/profiles/search

Query parameters

Response

200

Profile response

Body

application/json

id*string

activeboolean

passwordboolean

invitation*string

content*ProfileContent (object)

metaContentobject

tcdateinteger

tmdateinteger

tauthorstring

readers*array of string

nonreadersarray of string

writers*array of string

signatures*array of string

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/profiles/search', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "active": false,
    "password": false,
    "invitation": "text",
    "content": {
      "preferredEmail": "text",
      "gender": "text",
      "homepage": "text",
      "dblp": "text",
      "gscholar": "text",
      "wikipedia": "text",
      "linkedin": "text",
      "orcid": "text",
      "names": [
        {
          "preferred": false,
          "first": "text",
          "middle": "text",
          "last": "text",
          "username": "text"
        }
      ],
      "emails": [
        "text"
      ],
      "history": [
        {
          "position": "text",
          "institution": {
            "name": "text",
            "domain": "text"
          }
        }
      ],
      "relations": [
        {
          "relation": "text",
          "name": "text",
          "email": "text"
        }
      ],
      "expertise": [
        {
          "keywords": [
            "text"
          ]
        }
      ]
    },
    "tauthor": "text",
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatures": [
      "text"
    ]
  }
]

Returns groups

GEThttps://api.openreview.net/groups

Query parameters

Response

200default

Group response

Body

application/json

id*string

tcdateinteger

tmdateinteger

tauthorstring

readersarray of string

nonreadersarray of string

writersarray of string

signatoriesarray of string

signatures*array of string

membersarray of string

webnullable string

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/groups', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "tauthor": "text",
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatories": [
      "text"
    ],
    "signatures": [
      "text"
    ],
    "members": [
      "text"
    ],
    "web": "text"
  }
]

Creates or edit a Group

POSThttps://api.openreview.net/groups

Body

application/json

Group object

id*string

tcdateinteger

tmdateinteger

tauthorstring

readersarray of string

nonreadersarray of string

writersarray of string

signatoriesarray of string

signatures*array of string

membersarray of string

webnullable string

Response

200default

Group response

Body

application/json

id*string

tcdateinteger

tmdateinteger

tauthorstring

readersarray of string

nonreadersarray of string

writersarray of string

signatoriesarray of string

signatures*array of string

membersarray of string

webnullable string

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/groups', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "ICLR.cc",
      "readers": [
        "everyone"
      ],
      "writers": [
        "ICLR.cc"
      ],
      "signatories": [
        "ICLR.cc"
      ],
      "signatures": [
        "~Super_User1"
      ]
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "tauthor": "text",
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatories": [
    "text"
  ],
  "signatures": [
    "text"
  ],
  "members": [
    "text"
  ],
  "web": "text"
}

Adds members to a Group

PUThttps://api.openreview.net/groups/members

Body

application/json

Group object

id*string

Group id to which memebers will be added.

members*array of string

Members to add to the Group.

Response

200default

Group response

Body

application/json

id*string

tcdateinteger

tmdateinteger

tauthorstring

readersarray of string

nonreadersarray of string

writersarray of string

signatoriesarray of string

signatures*array of string

membersarray of string

webnullable string

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/groups/members', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "members": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "tauthor": "text",
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatories": [
    "text"
  ],
  "signatures": [
    "text"
  ],
  "members": [
    "text"
  ],
  "web": "text"
}

Removes members from a Group

DELETEhttps://api.openreview.net/groups/members

Body

application/json

Group object

id*string

Group id from which memebers will be removed.

members*array of string

Members to remove from the Group.

Response

200default

Group response

Body

application/json

id*string

tcdateinteger

tmdateinteger

tauthorstring

readersarray of string

nonreadersarray of string

writersarray of string

signatoriesarray of string

signatures*array of string

membersarray of string

webnullable string

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/groups/members', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "members": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "tauthor": "text",
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatories": [
    "text"
  ],
  "signatures": [
    "text"
  ],
  "members": [
    "text"
  ],
  "web": "text"
}

Returns all the Notes by filter.

GEThttps://api.openreview.net/notes

Query parameters

Response

200default

Note response

Body

application/json

idnullable string

invitation*string

numbernullable integer

forumnullable string

replytonullable string

referentnullable string

originalnullable string

content*object

cdatenullable integer

ddatenullable integer

mdatenullable integer

tcdatenullable integer

tmdatenullable integer

tauthorstring

readersnullable array of string

nonreadersnullable array of string

writersnullable array of string

signatures*array of string

detailsobject

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/notes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "invitation": "text",
    "forum": "text",
    "replyto": "text",
    "referent": "text",
    "original": "text",
    "tauthor": "text",
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatures": [
      "text"
    ],
    "details": {
      "writable": false,
      "revisions": false,
      "overwritting": [
        "text"
      ],
      "tags": [
        {
          "id": "text",
          "invitation": "text",
          "forum": "text",
          "replyto": "text",
          "tag": "text",
          "tauthor": "text",
          "readers": [
            "text"
          ],
          "nonreaders": [
            "text"
          ],
          "signatures": [
            "text"
          ]
        }
      ],
      "invitation": {
        "id": "text",
        "super": "text",
        "reply": {
          "referent": "text",
          "forum": "text",
          "replyto": "text"
        },
        "final": [],
        "tauthor": "text",
        "hideOriginalRevisions": false,
        "multiReply": false,
        "transform": "text",
        "replyForumViews": [
          {
            "id": "text",
            "label": "text",
            "filter": "text",
            "sort": "text"
          }
        ],
        "preprocess": "text",
        "process": "text",
        "web": "text",
        "readers": [
          "text"
        ],
        "nonreaders": [
          "text"
        ],
        "writers": [
          "text"
        ],
        "signatures": [
          "text"
        ],
        "invitees": [
          "text"
        ],
        "noninvitees": [
          "text"
        ]
      },
      "directReplies": [],
      "replies": []
    }
  }
]

Create a Note or reference, edit a Note or reference

POSThttps://api.openreview.net/notes

Body

application/json

Note object

idnullable string

invitation*string

numbernullable integer

forumnullable string

replytonullable string

referentnullable string

originalnullable string

content*object

cdatenullable integer

ddatenullable integer

mdatenullable integer

tcdatenullable integer

tmdatenullable integer

tauthorstring

readersnullable array of string

nonreadersnullable array of string

writersnullable array of string

signatures*array of string

detailsobject

Response

200default

Note response

Body

application/json

idnullable string

invitation*string

numbernullable integer

forumnullable string

replytonullable string

referentnullable string

originalnullable string

content*object

cdatenullable integer

ddatenullable integer

mdatenullable integer

tcdatenullable integer

tmdatenullable integer

tauthorstring

readersnullable array of string

nonreadersnullable array of string

writersnullable array of string

signatures*array of string

detailsobject

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/notes', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "invitation": "ICLR.cc/2018/Conference/-/Submission",
      "content": {
        "title": "Paper title",
        "abstract": "Paper abstract",
        "authors": [
          "Author name 1",
          "Author name 2"
        ],
        "authorids": [
          "[e-mail]",
          "[e-mail]"
        ],
        "pdf": "/pdf/12345.pdf"
      },
      "readers": [
        "everyone"
      ],
      "writers": [
        "ICLR.cc/2018/Conference"
      ],
      "signatures": [
        "~Super_User1"
      ]
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "invitation": "text",
  "forum": "text",
  "replyto": "text",
  "referent": "text",
  "original": "text",
  "tauthor": "text",
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatures": [
    "text"
  ],
  "details": {
    "writable": false,
    "revisions": false,
    "overwritting": [
      "text"
    ],
    "tags": [
      {
        "id": "text",
        "invitation": "text",
        "forum": "text",
        "replyto": "text",
        "tag": "text",
        "tauthor": "text",
        "readers": [
          "text"
        ],
        "nonreaders": [
          "text"
        ],
        "signatures": [
          "text"
        ]
      }
    ],
    "invitation": {
      "id": "text",
      "super": "text",
      "reply": {
        "referent": "text",
        "forum": "text",
        "replyto": "text"
      },
      "final": [],
      "tauthor": "text",
      "hideOriginalRevisions": false,
      "multiReply": false,
      "transform": "text",
      "replyForumViews": [
        {
          "id": "text",
          "label": "text",
          "filter": "text",
          "sort": "text"
        }
      ],
      "preprocess": "text",
      "process": "text",
      "web": "text",
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "writers": [
        "text"
      ],
      "signatures": [
        "text"
      ],
      "invitees": [
        "text"
      ],
      "noninvitees": [
        "text"
      ]
    },
    "directReplies": [],
    "replies": []
  }
}

Search Notes

GEThttps://api.openreview.net/notes/search

Query parameters

Response

200default

Note response

Body

application/json

idnullable string

invitation*string

numbernullable integer

forumnullable string

replytonullable string

referentnullable string

originalnullable string

content*object

cdatenullable integer

ddatenullable integer

mdatenullable integer

tcdatenullable integer

tmdatenullable integer

tauthorstring

readersnullable array of string

nonreadersnullable array of string

writersnullable array of string

signatures*array of string

detailsobject

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/notes/search', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "invitation": "text",
  "forum": "text",
  "replyto": "text",
  "referent": "text",
  "original": "text",
  "tauthor": "text",
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatures": [
    "text"
  ],
  "details": {
    "writable": false,
    "revisions": false,
    "overwritting": [
      "text"
    ],
    "tags": [
      {
        "id": "text",
        "invitation": "text",
        "forum": "text",
        "replyto": "text",
        "tag": "text",
        "tauthor": "text",
        "readers": [
          "text"
        ],
        "nonreaders": [
          "text"
        ],
        "signatures": [
          "text"
        ]
      }
    ],
    "invitation": {
      "id": "text",
      "super": "text",
      "reply": {
        "referent": "text",
        "forum": "text",
        "replyto": "text"
      },
      "final": [],
      "tauthor": "text",
      "hideOriginalRevisions": false,
      "multiReply": false,
      "transform": "text",
      "replyForumViews": [
        {
          "id": "text",
          "label": "text",
          "filter": "text",
          "sort": "text"
        }
      ],
      "preprocess": "text",
      "process": "text",
      "web": "text",
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "writers": [
        "text"
      ],
      "signatures": [
        "text"
      ],
      "invitees": [
        "text"
      ],
      "noninvitees": [
        "text"
      ]
    },
    "directReplies": [],
    "replies": []
  }
}

Returns all the references by filter

GEThttps://api.openreview.net/references

Query parameters

Response

200default

Note response

Body

application/json

idnullable string

invitation*string

numbernullable integer

forumnullable string

replytonullable string

referentnullable string

originalnullable string

content*object

cdatenullable integer

ddatenullable integer

mdatenullable integer

tcdatenullable integer

tmdatenullable integer

tauthorstring

readersnullable array of string

nonreadersnullable array of string

writersnullable array of string

signatures*array of string

detailsobject

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/references', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "invitation": "text",
    "forum": "text",
    "replyto": "text",
    "referent": "text",
    "original": "text",
    "tauthor": "text",
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatures": [
      "text"
    ],
    "details": {
      "writable": false,
      "revisions": false,
      "overwritting": [
        "text"
      ],
      "tags": [
        {
          "id": "text",
          "invitation": "text",
          "forum": "text",
          "replyto": "text",
          "tag": "text",
          "tauthor": "text",
          "readers": [
            "text"
          ],
          "nonreaders": [
            "text"
          ],
          "signatures": [
            "text"
          ]
        }
      ],
      "invitation": {
        "id": "text",
        "super": "text",
        "reply": {
          "referent": "text",
          "forum": "text",
          "replyto": "text"
        },
        "final": [],
        "tauthor": "text",
        "hideOriginalRevisions": false,
        "multiReply": false,
        "transform": "text",
        "replyForumViews": [
          {
            "id": "text",
            "label": "text",
            "filter": "text",
            "sort": "text"
          }
        ],
        "preprocess": "text",
        "process": "text",
        "web": "text",
        "readers": [
          "text"
        ],
        "nonreaders": [
          "text"
        ],
        "writers": [
          "text"
        ],
        "signatures": [
          "text"
        ],
        "invitees": [
          "text"
        ],
        "noninvitees": [
          "text"
        ]
      },
      "directReplies": [],
      "replies": []
    }
  }
]

Get a PDF

GEThttps://api.openreview.net/references/pdf

Query parameters

Response

200

pdf

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/references/pdf', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get a reference attachment

GEThttps://api.openreview.net/references/attachment

Query parameters

Response

200

attachment

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/references/attachment', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Returns Invitations

GEThttps://api.openreview.net/invitations

Query parameters

Response

200default

Invitation response

Body

application/json

id*string

superstring

replyobject

finalnullable array

cdatenullable integer

ddatenullable integer

duedatenullable integer

expdatenullable integer

tcdatenullable integer

tmdatenullable integer

tauthorstring

detailsobject

hideOriginalRevisionsboolean

multiReplynullable boolean

transformnullable string

taskCompletionCountnullable integer

replyForumViewsnullable array of object

preprocessnullable string

processany of

nullable stringnullable object

webnullable string

readersnullable array of string

nonreadersnullable array of string

writersnullable array of string

signatures*array of string

inviteesnullable array of string

noninviteesnullable array of string

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/invitations', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "super": "text",
    "reply": {
      "referent": "text",
      "forum": "text",
      "replyto": "text"
    },
    "final": [],
    "tauthor": "text",
    "hideOriginalRevisions": false,
    "multiReply": false,
    "transform": "text",
    "replyForumViews": [
      {
        "id": "text",
        "label": "text",
        "filter": "text",
        "sort": "text"
      }
    ],
    "preprocess": "text",
    "process": "text",
    "web": "text",
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatures": [
      "text"
    ],
    "invitees": [
      "text"
    ],
    "noninvitees": [
      "text"
    ]
  }
]

Create or edit an Invitation

POSThttps://api.openreview.net/invitations

Body

application/json

Invitation object

id*string

superstring

replyobject

finalnullable array

cdatenullable integer

ddatenullable integer

duedatenullable integer

expdatenullable integer

tcdatenullable integer

tmdatenullable integer

tauthorstring

detailsobject

hideOriginalRevisionsboolean

multiReplynullable boolean

transformnullable string

taskCompletionCountnullable integer

replyForumViewsnullable array of object

preprocessnullable string

processany of

nullable stringnullable object

webnullable string

readersnullable array of string

nonreadersnullable array of string

writersnullable array of string

signatures*array of string

inviteesnullable array of string

noninviteesnullable array of string

Response

200default

Invitation response

Body

application/json

id*string

superstring

replyobject

finalnullable array

cdatenullable integer

ddatenullable integer

duedatenullable integer

expdatenullable integer

tcdatenullable integer

tmdatenullable integer

tauthorstring

detailsobject

hideOriginalRevisionsboolean

multiReplynullable boolean

transformnullable string

taskCompletionCountnullable integer

replyForumViewsnullable array of object

preprocessnullable string

processany of

nullable stringnullable object

webnullable string

readersnullable array of string

nonreadersnullable array of string

writersnullable array of string

signatures*array of string

inviteesnullable array of string

noninviteesnullable array of string

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/invitations', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "ICLR.cc/2018/Conference/-/Submission",
      "reply": {
        "readers": {
          "description": "<p>The users who will be allowed to read the above content.</p>",
          "values": [
            "everyone"
          ],
          "__$markdownParsed": true
        },
        "writers": {
          "values": [
            "ICLR.cc/2018/Conference"
          ]
        },
        "signatures": {
          "description": "<p>Your authorized identity to be associated with the above content.</p>",
          "values-regex": "~.*|ICLR.cc/2018/Conference",
          "__$markdownParsed": true
        }
      },
      "content": {
        "title": {
          "required": true,
          "order": 1,
          "description": "<p>Title of the paper</p>",
          "value-regex": ".{1,250}",
          "__$markdownParsed": true
        },
        "abstract": {
          "required": true,
          "order": 2,
          "description": "<p>Abstract of the paper</p>",
          "value-regex": ".{1,2500}",
          "__$markdownParsed": true
        },
        "authors": {
          "required": true,
          "order": 3,
          "description": "<p>Comma separated values of author names</p>",
          "values-regex": "[^;,\\\\n]+(,[^,\\\\n]+)*",
          "__$markdownParsed": true
        },
        "authorids": {
          "required": true,
          "order": 4,
          "description": "<p>Comma separated values of author email addresses</p>",
          "values-regex": "[^;,\\\\n]+(,[^,\\\\n]+)*",
          "__$markdownParsed": true
        }
      },
      "invitees": [
        "everyone"
      ],
      "readers": [
        "everyone"
      ],
      "writers": [
        "~Super_User1"
      ],
      "signatures": [
        "~Super_User1"
      ]
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "super": "text",
  "reply": {
    "referent": "text",
    "forum": "text",
    "replyto": "text"
  },
  "final": [],
  "tauthor": "text",
  "hideOriginalRevisions": false,
  "multiReply": false,
  "transform": "text",
  "replyForumViews": [
    {
      "id": "text",
      "label": "text",
      "filter": "text",
      "sort": "text"
    }
  ],
  "preprocess": "text",
  "process": "text",
  "web": "text",
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatures": [
    "text"
  ],
  "invitees": [
    "text"
  ],
  "noninvitees": [
    "text"
  ]
}

Find tags by different filters

GEThttps://api.openreview.net/tags

Query parameters

Response

200default

Tag response

Body

application/json

idnullable string

invitation*string

forumstring

replytonullable string

tag*string

cdatenullable integer

ddatenullable integer

tcdatenullable integer

tmdateinteger

tauthorstring

readersarray of string

nonreadersnullable array of string

signatures*array of string

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/tags', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "invitation": "text",
    "forum": "text",
    "replyto": "text",
    "tag": "text",
    "tauthor": "text",
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "signatures": [
      "text"
    ]
  }
]

Create or edit a Tag

POSThttps://api.openreview.net/tags

Body

application/json

Tag object

idnullable string

invitation*string

forumstring

replytonullable string

tag*string

cdatenullable integer

ddatenullable integer

tcdatenullable integer

tmdateinteger

tauthorstring

readersarray of string

nonreadersnullable array of string

signatures*array of string

Response

200default

Tag response

Body

application/json

idnullable string

invitation*string

forumstring

replytonullable string

tag*string

cdatenullable integer

ddatenullable integer

tcdatenullable integer

tmdateinteger

tauthorstring

readersarray of string

nonreadersnullable array of string

signatures*array of string

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/tags', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "invitation": "ICLR.cc/2018/Conference/-/Add_Bid",
      "forum": "SJeI6e62XQ",
      "tag": "I want to review",
      "readers": [
        "everyone"
      ],
      "signatures": [
        "~Super_User1"
      ]
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "invitation": "text",
  "forum": "text",
  "replyto": "text",
  "tag": "text",
  "tauthor": "text",
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "signatures": [
    "text"
  ]
}

Find messages by different filters

GEThttps://api.openreview.net/messages

Query parameters

Response

200default

message response

Body

application/json

idstring

deliveredboolean

cdateinteger

tauthorstring

referrernullable string

statusstring

executedOnstring

timestampinteger

contentobject

logsarray of object

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/messages', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "delivered": false,
    "tauthor": "text",
    "referrer": "text",
    "status": "text",
    "executedOn": "text",
    "content": {
      "from": "text",
      "fromname": "text",
      "to": "text",
      "replyto": "text",
      "subject": "text",
      "text": "text"
    },
    "logs": []
  }
]

Create a direct message

POSThttps://api.openreview.net/messages

Body

application/json

Message object

subject*string

Subject of the message.

message*string

Message body.

groups*array of string

Groups the message is sent to.

ignoreGroupsnullable array of string

Groups the message should not be sent to.

parentGroupnullable string

Parent group that the groups belong to.

sendAtnullable integer

Send the message at a specific UTC time in milliseconds in the future. Maximum is 70 hours.

replyTonullable string

Email address the recipient should replyto.

useJobnullable boolean

Whether to wait for messages to be sent.

fromnullable object

Email address the message is sent from.

Response

200default

message response

Body

application/json

any of

objectobjectobject

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/messages', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "subject": "text",
      "message": "text",
      "groups": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

{
  "groups": {
    "id": "text",
    "message": {
      "id": "text",
      "delivered": false,
      "tauthor": "text",
      "referrer": "text",
      "status": "text",
      "executedOn": "text",
      "content": {
        "from": "text",
        "fromname": "text",
        "to": "text",
        "replyto": "text",
        "subject": "text",
        "text": "text"
      },
      "logs": []
    }
  }
}

Get logs by different filters

GEThttps://api.openreview.net/logs/process

Query parameters

Response

200default

log response

Body

application/json

idstring

jobIdstring

invitationstring

userstring

executedOnstring

sdateinteger

statusstring

lognullable array of string

edateinteger

expireAtstring

errorobject

Request

JavaScriptCurl

const response = await fetch('https://api.openreview.net/logs/process', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "jobId": "text",
    "invitation": "text",
    "user": "text",
    "executedOn": "text",
    "status": "text",
    "log": [
      "text"
    ],
    "expireAt": "text"
  }
]