OpenAPI definition

PreviousAPI V1 NextEntities

Last updated 2 years ago

Was this helpful?

#141: add registration stage info

Change request updated 1 year ago

Returns all the Notes by filter.

get

/notes

Authorizations

Query parameters

idstring · min: 1

Note id.

idsany of

Note ids.

invitationstring · min: 1

Invitation id used to create the Note(s).

Example: ICLR.cc/2018/Conference/-/Blind_Submission

invitationsany of

Invitation ids.

referentstring · min: 1

Reference referent.

forumany of

Note id of the forum field.

replytoany of

Note id of the replyto field.

numberany of

Note number.

content.titlestring · min: 1

Note title.

content.confidencestring · min: 1

Note content confidence field value.

content.strengthsstring · min: 1

Note content strengths field value.

content.weaknessesstring · min: 1

Note content weaknesses field value.

content.decisionstring · min: 1

Note content decision field value.

content.certificationsstring · min: 1

Note content certification field values.

content.previous_URLstring · min: 1

Note content previous_URL field value.

content.userstring · min: 1

User email in recruitment.

content.responsestring · min: 1

User response in recruitment.

content.submission_idstring · min: 1

content.venuestring · min: 1

Note venue.

content.venueidstring · min: 1

Note venueid.

content.venue_idstring · min: 1

Note venue_id.

content.presentation_typestring · min: 1

Presentation Type.

content.sessionsstring · min: 1

Sessions.

content.trackstring · min: 1

Track.

content.authoridsany of

List of tilde ids of registered users or of emails either registered or not.

trashboolean | nullable

Whether to get deleted Notes.

paperhashstringDeprecated

paperhash of the Note if exists.

Example: das|go_for_a_walk_and_arrive_at_the_answer_reasoning_over_paths_in_knowledge_bases_using_reinforcement_learning.

tauthorboolean

Get Notes authored by user.

writerstring · min: 1

Get Notes written by user.

signaturestring · min: 1

Get Notes signed by user.

signaturesstring · min: 1[]

Get Notes signed by users.

originalany of

get Notes that are originals

selectstring · min: 1

Comma separated string with specific fields of the Note object to return.

Example: id,content.title,content.abstract

detailsstring · min: 1

Comma separated values of fields to add to details. Valid values are: replyCount: Number of replies in a forum. Only available if the Note is a forum. original: Include original Note if available. revisions: Boolean indicating whether the Note has revisions. writable: Boolean indicating whether the Note is writable by the user. originalWritable: Boolean indicating whether the original Note is writable by the user. tags: Tags of the Note. invitation: Invitation of the Note. originalInvitation: Invitation of the original Note. directReplyCount: Number of direct replies to the Note. directReplies: Direct replies to the Note. replies: Replies to the Note. Only available if the Note is a forum.

Example: all

inviteeboolean

invitee

mintcdateinteger

minimum creation date

duedateboolean

due date

sortstring · min: 1

Sort returned Notes by field.

limitinteger · int32

Maximum number of results to return.

offsetinteger · int32

Offset of the result shown.

cacheboolean

Get result from cache. Without the right privileges this parameter will be ignored.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.openreview.net/notes'

200

default

[]

Note response

post

/register

Authorizations

Body

emailstring · min: 1 · max: 254

Email that will be used to log in to OpenReview.

passwordstring

idstring

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

nameobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.openreview.net/register' \
  --header 'Content-Type: application/json' \
  --data '{"name":{"first":"text","last":"text"}}'

200

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

The Profile that is saved to the database.

Reset a user password

put

/reset/{token}

Authorizations

Path parameters

tokenstringrequired

reset token

Body

passwordstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.openreview.net/reset/{token}' \
  --header 'Content-Type: application/json'

200

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

User is logged in after the password is reset.

Impersonate a user

post

/impersonate

Authorizations

Body

groupIdstring · min: 1required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.openreview.net/impersonate' \
  --header 'Content-Type: application/json'

200

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

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

Gets the next available OpenReview username for the passed names.

get

/tildeusername

Authorizations

Query parameters

firststring

first name

middlestring

middle name

laststring

last name

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.openreview.net/tildeusername'

200

{
  "username": "text"
}

Next available tilde username

Download an attachment

get

/attachment

Authorizations

Query parameters

idstringrequired

Note id that contains the attachment.

namestringrequired

Attachment field name inside the content of the Note. This is usually pdf or supplementary_material.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.openreview.net/attachment?id=text&name=text'

200

No body

Attachment

Upload an attachment

put

/attachment

Authorizations

Body

filestring · binaryrequired

namestring · min: 1required

Attachment field name. This is usually pdf or supplementary_material.

invitationIdstring · min: 1required

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.openreview.net/attachment' \
  --header 'Content-Type: multipart/form-data' \
  --data '{"file":"text","name":"text","invitationId":"text"}'

200

{
  "url": "text"
}

Path to the attachment.

Download a PDF

get

/pdf

Authorizations

Query parameters

idstring · min: 1required

Note id that contains the PDF.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.openreview.net/pdf?id=text'

200

No body

PDF

Get edges

get

/edges

Authorizations

Query parameters

idstring · min: 1

Edge id

limitinteger · min: 1

Maximum number of results to return.

offsetinteger

Offset of the result shown.

sortstring · min: 1

Sort returned Edges by field.

invitationstring · min: 1

Invitation id used to create the Edge(s).

headstring · min: 1

head value of the Edge(s).

tailstring · min: 1

tail value of the Edge(s).

labelstring | nullable

label of the Edge(s).

trashboolean

Whether to return deleted Edges as well.

groupBystring · min: 1

Group result by different Edge fields.

selectany of

Fields of the Edge to return in the result. Requires groupBy.

detailsstring · min: 1

Comma separated values of fields to add to details. Valid values are head, tail, writable and all.

Example: head,tail

cacheboolean

Get result from cache. Without the right privileges this parameter will be ignored.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.openreview.net/edges'

200

[]

edges

Create an edge

post

/edges

Authorizations

Body

idstring

invitationstringrequired

headstringrequired

tailstringrequired

labelstring

tcdateinteger

tmdateinteger

ddateinteger | nullable

tauthorstring

readersstring[]

nonreadersstring[]

writersstring[]

signaturesstring[]required

weightany of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.openreview.net/edges' \
  --header 'Content-Type: application/json'

200

{
  "id": "text",
  "invitation": "text",
  "head": "text",
  "tail": "text",
  "label": "text",
  "tcdate": 1,
  "tmdate": 1,
  "ddate": 1,
  "tauthor": "text",
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatures": [
    "text"
  ],
  "weight": 1
}

Edge

Delete an Edge

delete

/edges

Authorizations

Body

idstring · min: 1

Edge id of the Edge to delete.

invitationstring · min: 1required

Invitation id used to create the Edge.

labelstring · min: 1

Label of the Edge to delete.

tailstring · min: 1

Tail value of the Edge to delete.

headstring · min: 1

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.openreview.net/edges' \
  --header 'Content-Type: application/json' \
  --data '{"invitation":"text"}'

200

{
  "status": "text"
}

edge

Send feedback to the OpenReview team

put

/feedback

Authorizations

Body

fromstring · min: 1required

Email address of the user sending the feedback.

subjectstring | nullable

Subject of the feedback.

messagestring · min: 1required

The feedback.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.openreview.net/feedback' \
  --header 'Content-Type: application/json' \
  --data '{"from":"text","message":"text"}'

200

{
  "status": "text"
}

feedback

Get user profiles

get

/profiles

Authorizations

Query parameters

idstring · min: 1

Profile id

idsstring · min: 1[]

Profile ids

emailstring · min: 1

Email associated with the Profile.

emailsany of

Email(s) associated with the Profile.

confirmedEmailstring · min: 1

Confirmed email associated with the Profile.

confirmedEmailsany of

Confirmed email(s) associated with the Profile.

firststring · min: 1

First name associated with the Profile.

middlestring | nullable

Middle name associated with the Profile.

laststring · min: 1

Last name associated with the Profile.

termstring · min: 1

Email, Fullname or part of the fullname associated with the Profile.

groupstring · min: 1

Group id where to get all the member profiles.

trashboolean

Whether to include deleted profiles.

withBlockedboolean

Whether to include blocked profiles.

needsModerationboolean

Whether to return Profiles that need moderation.

selectstring · min: 1

Comma separated string with specific fields of the Profile object to return.

Example: id,content.names,content.emails

sortstring · min: 1

Sort returned Profiles by field.

limitinteger · int32 · min: 1

Maximum number of results to return.

offsetinteger · int32

Offset of the result shown.

cacheboolean

Get result from cache. Without the right privileges this parameter will be ignored.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.openreview.net/profiles'

200

[]

Profile response

Save user Profile

post

/profiles

Authorizations

Body

idstring · min: 1

invitationstring · min: 1

referentstring · min: 1

tcdateinteger

tmdateinteger

ddateinteger | nullable

packagingobject

activeboolean

passwordboolean

tauthorstring

readersstring · min: 1[]

nonreadersstring · min: 1[] | nullable

writersstring · min: 1[]

signaturesstring · min: 1[]required

contentobject

metaContentobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.openreview.net/profiles' \
  --header 'Content-Type: application/json'

200

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

Profile response

Get user profiles

get

/profiles/search

Authorizations

Query parameters

idstring · min: 1

Profile id.

idsstring · min: 1[]

Profile ids.

emailstring · min: 1

Email associated with the Profile.

emailsany of

Email(s) associated with the Profile.

confirmedEmailstring · min: 1

Confirmed email associated with the Profile.

confirmedEmailsany of

Confirmed email(s) associated with the Profile.

firststring · min: 1

First name associated with the Profile.

middlestring | nullable

Middle name associated with the Profile.

laststring · min: 1

Last name associated with the Profile.

termstring · min: 1

Email, Fullname or part of the fullname associated with the Profile.

groupstring · min: 1

Group id where to get all the member profiles.

trashboolean

Whether to include deleted profiles.

withBlockedboolean

Whether to include blocked profiles.

needsModerationboolean

Whether to return Profiles that need moderation.

selectstring · min: 1

Comma separated string with specific fields of the Profile object to return.

Example: id,content.names,content.emails

sortstring · min: 1

Sort returned Profiles by field.

limitinteger · int32 · min: 1

Maximum number of results to return.

offsetinteger · int32

Offset of the result shown.

cacheboolean

Get result from cache. Without the right privileges this parameter will be ignored.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.openreview.net/profiles/search'

200

[]

Profile response

Returns groups

get

/groups

Authorizations

Query parameters

idstring · min: 1

Group id.

idsstring · min: 1[]

Group ids.

regexstring · min: 1

Group id regular expression.

memberstring · min: 1

Group id to get its transitive members.

signaturestring · min: 1

Group id used to sign the returned Groups.

signatorystring · min: 1

Group id that can is allowed to sign with the returned Groups.

writerstring · min: 1

Group id that is writer of the returned Groups.

selectstring · min: 1

Comma separated string with specific fields of the Group object to return.

Example: id,members

detailsstring · min: 1

Comma separated values of fields to add to details. Valid value is writable.

Example: writable

limitinteger · int32 · min: 1

Maximum number of results to return.

offsetinteger · int32

Offset of the result shown.

webboolean

Whether to return web ui code

cacheboolean

Get result from cache. Without the right privileges this parameter will be ignored.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.openreview.net/groups'

200

default

[]

Group response

Creates or edit a Group

post

/groups

Authorizations

Body

idstringrequired

tcdateinteger

tmdateinteger

tauthorstring

webstring | nullable

readersstring[]

nonreadersstring[]

writersstring[]

signatoriesstring[]

signaturesstring[]required

membersstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.openreview.net/groups' \
  --header 'Content-Type: application/json' \
  --data '{"id":"ICLR.cc","readers":["everyone"],"writers":["ICLR.cc"],"signatories":["ICLR.cc"],"signatures":["~Super_User1"]}'

200

default

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

Group response

Adds members to a Group

put

/groups/members

Authorizations

Body

idstring · min: 1required

Group id to which memebers will be added.

membersstring · min: 1[]required

Members to add to the Group.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.openreview.net/groups/members' \
  --header 'Content-Type: application/json'

200

default

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

Group response

Removes members from a Group

delete

/groups/members

Authorizations

Body

idstring · min: 1required

Group id from which memebers will be removed.

membersstring · min: 1[]required

Members to remove from the Group.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.openreview.net/groups/members' \
  --header 'Content-Type: application/json'

200

default

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

Group response

Create a Note or reference, edit a Note or reference

post

/notes

Authorizations

Body

idstring · min: 1 | nullable

invitationstring · min: 1required

numberinteger · min: 1 | nullable

forumstring · min: 1 | nullable

replytostring · min: 1 | nullable

referentstring · min: 1 | nullable

originalstring · min: 1 | nullable

contentobjectrequired

cdateinteger | nullable

ddateinteger | nullable

mdateinteger | nullable

tcdateinteger | nullable

tmdateinteger | nullable

tauthorstring · min: 1

readersstring · min: 1[] | nullable

nonreadersstring · min: 1[] | nullable

writersstring · min: 1[] | nullable

signaturesstring · min: 1[]required

detailsobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.openreview.net/notes' \
  --header 'Content-Type: application/json' \
  --data '{"invitation":"ICLR.cc/2018/Conference/-/Submission","readers":["everyone"],"writers":["ICLR.cc/2018/Conference"],"signatures":["~Super_User1"],"content":{"title":"Paper title","abstract":"Paper abstract","pdf":"/pdf/12345.pdf","authors":["Author name 1","Author name 2"],"authorids":["author1@mail.com","author2@mail.com"]}}'

200

default

{
  "id": "text",
  "invitation": "text",
  "number": 1,
  "forum": "text",
  "replyto": "text",
  "referent": "text",
  "original": "text",
  "content": {},
  "cdate": 1,
  "ddate": 1,
  "mdate": 1,
  "tcdate": 1,
  "tmdate": 1,
  "tauthor": "text",
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatures": [
    "text"
  ],
  "details": {
    "replyCount": 1,
    "writable": true,
    "revisions": true,
    "original": {},
    "forumContent": {},
    "invitation": {
      "id": "text",
      "super": "text",
      "final": [],
      "cdate": 1,
      "ddate": 1,
      "duedate": 1,
      "expdate": 1,
      "tcdate": 1,
      "tmdate": 1,
      "tauthor": "text",
      "details": {},
      "hideOriginalRevisions": true,
      "multiReply": true,
      "transform": "text",
      "taskCompletionCount": 1,
      "preprocess": "text",
      "web": "text",
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "writers": [
        "text"
      ],
      "signatures": [
        "text"
      ],
      "invitees": [
        "text"
      ],
      "noninvitees": [
        "text"
      ],
      "reply": {
        "referent": "text",
        "forum": "text",
        "replyto": "text",
        "readers": {},
        "writers": {},
        "signatures": {},
        "content": {}
      },
      "replyForumViews": [
        {
          "id": "text",
          "label": "text",
          "filter": "text",
          "layout": 1,
          "sort": "text"
        }
      ],
      "process": "text"
    },
    "directReplyCount": 1,
    "overwritting": [
      "text"
    ],
    "tags": [],
    "directReplies": [
      {}
    ],
    "replies": [
      {}
    ]
  }
}

Note response

Search Notes

get

/notes/search

Authorizations

Query parameters

querystring · min: 1

Search query that that looks inside some of the fields in the content of the Note.

termstring · min: 1

Search term that that looks inside some of the fields in the content of the Note.

typestring · enum

Search type

Options: prefix, terms

contentstring · min: 1 · default: all

Fields inside content to look for the term.

Groupstring · min: 1

Group that the Invitation belongs to

sourcestring · enum · default: all

Source of the Note

Options: forum, reply, all

invitationstring · min: 1

Invitation id used to create the Note(s).

Example: ICLR.cc/2018/Conference/-/Submission

venuestring · min: 1

venue of the Note

venueidstring · min: 1

venue id of the Note

sortstring · min: 1

Sort returned Notes by field.

Example: tmdate:desc

limitinteger · int32

Maximum number of results to return.

offsetinteger · int32

Offset of the result shown.

cacheboolean

Get result from cache. Without the right privileges this parameter will be ignored.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.openreview.net/notes/search'

200

default

{
  "id": "text",
  "invitation": "text",
  "number": 1,
  "forum": "text",
  "replyto": "text",
  "referent": "text",
  "original": "text",
  "content": {},
  "cdate": 1,
  "ddate": 1,
  "mdate": 1,
  "tcdate": 1,
  "tmdate": 1,
  "tauthor": "text",
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatures": [
    "text"
  ],
  "details": {
    "replyCount": 1,
    "writable": true,
    "revisions": true,
    "original": {},
    "forumContent": {},
    "invitation": {
      "id": "text",
      "super": "text",
      "final": [],
      "cdate": 1,
      "ddate": 1,
      "duedate": 1,
      "expdate": 1,
      "tcdate": 1,
      "tmdate": 1,
      "tauthor": "text",
      "details": {},
      "hideOriginalRevisions": true,
      "multiReply": true,
      "transform": "text",
      "taskCompletionCount": 1,
      "preprocess": "text",
      "web": "text",
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "writers": [
        "text"
      ],
      "signatures": [
        "text"
      ],
      "invitees": [
        "text"
      ],
      "noninvitees": [
        "text"
      ],
      "reply": {
        "referent": "text",
        "forum": "text",
        "replyto": "text",
        "readers": {},
        "writers": {},
        "signatures": {},
        "content": {}
      },
      "replyForumViews": [
        {
          "id": "text",
          "label": "text",
          "filter": "text",
          "layout": 1,
          "sort": "text"
        }
      ],
      "process": "text"
    },
    "directReplyCount": 1,
    "overwritting": [
      "text"
    ],
    "tags": [],
    "directReplies": [
      {}
    ],
    "replies": [
      {}
    ]
  }
}

Note response

Returns all the references by filter

get

/references

Authorizations

Query parameters

idstring · min: 1

reference id

idsany of

reference ids

invitationstring · min: 1

Invitation id used to create the Reference(s).

invitationsany of

Invitation ids

referentstring · min: 1

Reference referent.

forumany of

Note id of the forum field.

replytoany of

Note id of the replyto field.

numberstring

Note number.

content.titlestring · min: 1

Note title.

content.venuestring · min: 1

Note venue.

content.venueidstring · min: 1

Note venueid.

content.authoridsany of

List of tilde ids of registered users or of emails either registered or not.

trashboolean | nullable

Get Notes deleted too.

paperhashstringDeprecated

paperhash of the Note if exists.

pdfstringDeprecated

Get Note using pdf hash.

tauthorboolean

Get Notes authored by user.

writerstring · min: 1

Get Notes written by user.

signaturestring · min: 1

Get Notes signed by user.

signaturesstring · min: 1[]

Get Notes signed by users.

originalany of

Get Notes that are originals.

selectstring · min: 1

Comma separated string with specific fields of the Reference object to return.

detailsstring · min: 1

Comma separated values of fields to add to details. Valid values are replyCount, original, overwriting, revisions, writable, forumContent, tags, revisions, invitation, directReplyCount, directReplies, replies, and all

inviteeboolean

Invitee

mintcdateinteger

Minimum creation date

duedateboolean

Due date

sortstring · min: 1

Sort returned Notes by field.

limitinteger · int32

Maximum number of results to return.

offsetinteger · int32

Offset of the result shown.

cacheboolean

Get result from cache. Without the right privileges this parameter will be ignored.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.openreview.net/references'

200

default

[]

Note response

Get a PDF

get

/references/pdf

Authorizations

Query parameters

idstring · min: 1required

reference id

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.openreview.net/references/pdf?id=text'

200

No body

pdf

Get a reference attachment

get

/references/attachment

Authorizations

Query parameters

idstringrequired

Note id

namestringrequired

attachment field name

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.openreview.net/references/attachment?id=text&name=text'

200

No body

attachment

Returns Invitations

get

/invitations

Authorizations

Query parameters

idstring · min: 1

Invitation id

idsstring · min: 1

Comma separated Invitation ids

superstring · min: 1

Super Invitation id

regexstring · min: 1

Invitation id regular expression

typestring · enum

Invitation type

Options: all, notes, tags, edges

replyForumstring · min: 1

Note id

replyInvitationstring · min: 1

Invitation id

minduedateinteger

minimum due date of the Invitation

inviteeany of

invitee id

signaturestring · min: 1

Invitation signature

replytoboolean

Invitations should have replyto field

duedateboolean

Invitations should have due date

pastdueboolean

Invitations should be past due

expiredboolean

Invitations should be expired

selectstring · min: 1

Comma separated string with specific fields of the Invitation object to return.

Example: id,content,readers,invitees

detailsstring · min: 1

Comma separated values of fields to add to details. Valid values are replytoNote, repliedNotes, repliedTags, repliedEdges, all.

tagsbooleanDeprecated

Get only Tag Invitations

edgesbooleanDeprecated

Get only edge Invitations

notesbooleanDeprecated

Get only Note Invitations

limitinteger · int32 · min: 1

Maximum number of results to return.

offsetinteger · int32

Offset of the result shown.

cacheboolean

Get result from cache. Without the right privileges this parameter will be ignored.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.openreview.net/invitations'

200

default

[]

Invitation response

Create or edit an Invitation

post

/invitations

Authorizations

Body

idstring · min: 1required

superstring · min: 1

finalarray | nullable

cdateinteger | nullable

ddateinteger | nullable

duedateinteger | nullable

expdateinteger | nullable

tcdateinteger | nullable

tmdateinteger | nullable

tauthorstring

detailsobject

hideOriginalRevisionsboolean

multiReplyboolean | nullable

transformstring · min: 1 | nullable

taskCompletionCountinteger | nullable

preprocessstring | nullable

webstring · min: 1 | nullable

readersstring · min: 1[] | nullable

nonreadersstring · min: 1[] | nullable

writersstring · min: 1[] | nullable

signaturesstring · min: 1[]required

inviteesstring · min: 1[] | nullable

noninviteesstring · min: 1[] | nullable

replyobject

replyForumViewsobject[] | nullable

processany of

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

default

{
  "id": "text",
  "super": "text",
  "final": [],
  "cdate": 1,
  "ddate": 1,
  "duedate": 1,
  "expdate": 1,
  "tcdate": 1,
  "tmdate": 1,
  "tauthor": "text",
  "details": {},
  "hideOriginalRevisions": true,
  "multiReply": true,
  "transform": "text",
  "taskCompletionCount": 1,
  "preprocess": "text",
  "web": "text",
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatures": [
    "text"
  ],
  "invitees": [
    "text"
  ],
  "noninvitees": [
    "text"
  ],
  "reply": {
    "referent": "text",
    "forum": "text",
    "replyto": "text",
    "readers": {},
    "writers": {},
    "signatures": {},
    "content": {}
  },
  "replyForumViews": [
    {
      "id": "text",
      "label": "text",
      "filter": "text",
      "layout": 1,
      "sort": "text"
    }
  ],
  "process": "text"
}

Invitation response

Find tags by different filters

get

/tags

Authorizations

Query parameters

idstring

Tag id

idsstring · min: 1[]

comma separated Tag ids

invitationstring

Invitation id used to create the Tag(s).

Example: ICLR.cc/2018/Conference/-/Add_Bid

tagstring · min: 1

Tag value

signaturestring · min: 1

Tag signature

forumstring

Note id of the forum field.

replytostring

Invitations should have replyto field

trashboolean

Get tags deleted too.

tauthorboolean

Get tags authored by user.

detailsstring · min: 1

Comma separated values of fields to add to details. Valid values are forumContent, all.

limitinteger · int32 · default: 1000

Maximum number of results to return.

offsetinteger · int32

Offset of the result shown.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.openreview.net/tags'

200

default

[]

Tag response

Create or edit a Tag

post

/tags

Authorizations

Body

idstring | nullable

invitationstringrequired

forumstring

replytostring | nullable

tagstringrequired

cdateinteger | nullable

ddateinteger | nullable

tcdateinteger | nullable

tmdateinteger

tauthorstring

readersstring[]

nonreadersstring[] | nullable

signaturesstring · min: 1[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.openreview.net/tags' \
  --header 'Content-Type: application/json' \
  --data '{"invitation":"ICLR.cc/2018/Conference/-/Add_Bid","forum":"SJeI6e62XQ","tag":"I want to review","readers":["everyone"],"signatures":["~Super_User1"]}'

200

default

{
  "id": "text",
  "invitation": "text",
  "forum": "text",
  "replyto": "text",
  "tag": "text",
  "cdate": 1,
  "ddate": 1,
  "tcdate": 1,
  "tmdate": 1,
  "tauthor": "text",
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "signatures": [
    "text"
  ]
}

Tag response

Find messages by different filters

get

/messages

Authorizations

Query parameters

idstring · min: 1

Message id.

tostring · min: 1

Email address of the recipient.

subjectstring · min: 1

Subject of the Message.

parentGroupstring · min: 1

Parent Group the recipient belongs to.

statusany of

Status of the message.

tauthorstring · min: 1

Email of the author of the message.

limitinteger · int32

Maximum number of results to return.

offsetinteger · int32

Offset of the result shown.

cacheboolean

Get result from cache. Without the right privileges this parameter will be ignored.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.openreview.net/messages'

200

default

[]

message response

Create a direct message

post

/messages

Authorizations

Body

subjectstringrequired

Subject of the message.

messagestringrequired

Message body.

parentGroupstring | nullable

Parent group that the groups belong to.

sendAtinteger | nullable

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

replyTostring | nullable

Email address the recipient should replyto.

useJobboolean | nullable

Whether to wait for messages to be sent.

groupsstring · min: 1[]required

Groups the message is sent to.

ignoreGroupsstring · min: 1[] · default: | nullable

Groups the message should not be sent to.

fromobject | nullable

Email address the message is sent from.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.openreview.net/messages' \
  --header 'Content-Type: application/json'

200

default

{
  "groups": {
    "id": "text",
    "message": {
      "id": "text",
      "delivered": true,
      "cdate": 1,
      "tauthor": "text",
      "referrer": "text",
      "status": "text",
      "executedOn": "text",
      "timestamp": 1,
      "logs": [
        {}
      ],
      "content": {
        "from": "text",
        "fromname": "text",
        "to": "text",
        "replyto": "text",
        "subject": "text",
        "text": "text",
        "sendAt": 1
      }
    }
  }
}

message response

Get logs by different filters

get

/logs/process

Authorizations

Query parameters

idstring · min: 1

log id

parentGroupstring · min: 1

Parent Group id

invitationstring · min: 1

Invitation id that contains the process function.

statusstring · min: 1

Status of the process. It can be ok or error.

limitinteger · int32 · default: 1000

Maximum number of results to return.

offsetinteger · int32

Offset of the result shown.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.openreview.net/logs/process'

200

default

[]

log response