OpenAPI definition

post

Register a new user

Authorizations
Body
emailstring · min: 1 · max: 254Optional

Email that will be used to log in to OpenReview.

passwordstringOptional
idstringOptional

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

Responses
200
The Profile that is saved to the database.
application/json
post
POST /register HTTP/1.1
Host: api.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "email": "text",
  "password": "text",
  "name": {
    "first": "text",
    "middle": "text",
    "last": "text",
    "preferred": true
  },
  "id": "text"
}
200

The Profile that is saved to the database.

{
  "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",
    "names": [
      {
        "preferred": true,
        "first": "text",
        "middle": "text",
        "last": "text",
        "username": "text"
      }
    ],
    "emails": [
      "text"
    ],
    "history": [
      {
        "position": "text",
        "institution": {
          "name": "text",
          "domain": "text"
        },
        "start": 1,
        "end": 1
      }
    ],
    "relations": [
      {
        "relation": "text",
        "name": "text",
        "email": "text",
        "start": 1,
        "end": 1
      }
    ],
    "expertise": [
      {
        "keywords": [
          "text"
        ],
        "start": 1,
        "end": 1
      }
    ]
  },
  "metaContent": {},
  "tcdate": 1,
  "tmdate": 1,
  "tauthor": "text",
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatures": [
    "text"
  ]
}
put

Reset a user password

Authorizations
Path parameters
tokenstringRequired

reset token

Body
passwordstringRequired
Responses
200
User is logged in after the password is reset.
application/json
put
PUT /reset/{token} HTTP/1.1
Host: api.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "password": "text"
}
200

User is logged in after the password is reset.

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

Impersonate a user

Authorizations
Body
groupIdstring · min: 1Required
Responses
200
User token of the impersonated user and details of the impersonation.
application/json
post
POST /impersonate HTTP/1.1
Host: api.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "groupId": "text"
}
200

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

{
  "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": true,
    "impersonatables": [
      "text"
    ]
  }
}
get

Gets the next available OpenReview username for the passed names.

Authorizations
Query parameters
firststringOptional

first name

middlestringOptional

middle name

laststringOptional

last name

Responses
200
Next available tilde username
application/json
get
GET /tildeusername HTTP/1.1
Host: api.openreview.net
Accept: */*
200

Next available tilde username

{
  "username": "text"
}
get

Download an 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
200
Attachment
get
GET /attachment HTTP/1.1
Host: api.openreview.net
Accept: */*
200

Attachment

No content

put

Upload an 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
200
Path to the attachment.
application/json
put
PUT /attachment HTTP/1.1
Host: api.openreview.net
Content-Type: multipart/form-data
Accept: */*
Content-Length: 53

{
  "file": "binary",
  "name": "text",
  "invitationId": "text"
}
200

Path to the attachment.

{
  "url": "text"
}
get

Download a PDF

Authorizations
Query parameters
idstring · min: 1Required

Note id that contains the PDF.

Responses
200
PDF
get
GET /pdf HTTP/1.1
Host: api.openreview.net
Accept: */*
200

PDF

No content

get

Get edges

Authorizations
Query parameters
idstring · min: 1Optional

Edge id

limitinteger · min: 1Optional

Maximum number of results to return.

offsetintegerOptional

Offset of the result shown.

sortstring · min: 1Optional

Sort returned Edges by field.

invitationstring · min: 1Optional

Invitation id used to create the Edge(s).

headstring · min: 1Optional

head value of the Edge(s).

tailstring · min: 1Optional

tail value of the Edge(s).

labelstring | nullableOptional

label of the Edge(s).

trashbooleanOptional

Whether to return deleted Edges as well.

groupBystring · min: 1Optional

Group result by different Edge fields.

selectany ofOptional

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

string · min: 1OptionalPattern: [a-zA-Z0-9_]+
or
string[]Optional
detailsstring · min: 1Optional

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

Example: head,tail
cachebooleanOptional

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

Responses
200
edges
application/json
get
GET /edges HTTP/1.1
Host: api.openreview.net
Accept: */*
200

edges

[]
post

Create an edge

Authorizations
Body
idstringOptional
invitationstringRequired
headstringRequired
tailstringRequired
labelstringOptional
weightany ofOptional
numberOptional
or
stringOptional
tcdateintegerOptional
tmdateintegerOptional
ddateinteger | nullableOptional
tauthorstringOptional
readersstring[]Optional
nonreadersstring[]Optional
writersstring[]Optional
signaturesstring[]Required
Responses
200
Edge
application/json
post
POST /edges HTTP/1.1
Host: api.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 218

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

Edge

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

Delete an Edge

Authorizations
Body
idstring · min: 1Optional

Edge id of the Edge to delete.

invitationstring · min: 1Required

Invitation id used to create the Edge.

labelstring · min: 1Optional

Label of the Edge to delete.

tailstring · min: 1Optional

Tail value of the Edge to delete.

headstring · min: 1Optional

Head value of the Edge to delete.

softDeletebooleanOptional

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

waitToFinishbooleanOptional

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

Responses
200
edge
application/json
delete
DELETE /edges HTTP/1.1
Host: api.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 114

{
  "id": "text",
  "invitation": "text",
  "label": "text",
  "tail": "text",
  "head": "text",
  "softDelete": true,
  "waitToFinish": true
}
200

edge

{
  "status": "text"
}
put

Send feedback to the OpenReview team

Authorizations
Body
fromstring · min: 1Required

Email address of the user sending the feedback.

subjectstring | nullableOptional

Subject of the feedback.

messagestring · min: 1Required

The feedback.

Responses
200
feedback
application/json
put
PUT /feedback HTTP/1.1
Host: api.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "from": "text",
  "subject": "text",
  "message": "text"
}
200

feedback

{
  "status": "text"
}
get

Get user profiles

Authorizations
Query parameters
idstring · min: 1Optional

Profile id

idsstring[]Optional

Profile ids

emailstring · min: 1Optional

Email associated with the Profile.

emailsany ofOptional

Email(s) associated with the Profile.

string · min: 1Optional
or
string[]Optional
confirmedEmailstring · min: 1Optional

Confirmed email associated with the Profile.

confirmedEmailsany ofOptional

Confirmed email(s) associated with the Profile.

string · min: 1Optional
or
string[]Optional
firststring · min: 1Optional

First name associated with the Profile.

middlestring | nullableOptional

Middle name associated with the Profile.

laststring · min: 1Optional

Last name associated with the Profile.

termstring · min: 1Optional

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

groupstring · min: 1Optional

Group id where to get all the member profiles.

trashbooleanOptional

Whether to include deleted profiles.

withBlockedbooleanOptional

Whether to include blocked profiles.

needsModerationbooleanOptional

Whether to return Profiles that need moderation.

selectstring · min: 1Optional

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

Example: id,content.names,content.emails
sortstring · min: 1Optional

Sort returned Profiles by field.

limitinteger · int32 · min: 1Optional

Maximum number of results to return.

offsetinteger · int32Optional

Offset of the result shown.

cachebooleanOptional

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

Responses
200
Profile response
application/json
get
GET /profiles HTTP/1.1
Host: api.openreview.net
Accept: */*
200

Profile response

[]
post

Save user Profile

Authorizations
Body
idstring · min: 1Optional
invitationstring · min: 1Optional
referentstring · min: 1Optional
tcdateintegerOptional
tmdateintegerOptional
ddateinteger | nullableOptional
packagingobjectOptional
activebooleanOptional
passwordbooleanOptional
tauthorstringOptional
readersstring[]Optional
nonreadersstring[] | nullableOptional
writersstring[]Optional
signaturesstring[] · min: 1Required
Responses
200
Profile response
application/json
post
POST /profiles HTTP/1.1
Host: api.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 1788

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

Profile response

{
  "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",
    "names": [
      {
        "preferred": true,
        "first": "text",
        "middle": "text",
        "last": "text",
        "username": "text"
      }
    ],
    "emails": [
      "text"
    ],
    "history": [
      {
        "position": "text",
        "institution": {
          "name": "text",
          "domain": "text"
        },
        "start": 1,
        "end": 1
      }
    ],
    "relations": [
      {
        "relation": "text",
        "name": "text",
        "email": "text",
        "start": 1,
        "end": 1
      }
    ],
    "expertise": [
      {
        "keywords": [
          "text"
        ],
        "start": 1,
        "end": 1
      }
    ]
  },
  "metaContent": {},
  "tcdate": 1,
  "tmdate": 1,
  "tauthor": "text",
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatures": [
    "text"
  ]
}

Get user profiles

Authorizations
Query parameters
idstring · min: 1Optional

Profile id.

idsstring[]Optional

Profile ids.

emailstring · min: 1Optional

Email associated with the Profile.

emailsany ofOptional

Email(s) associated with the Profile.

string · min: 1Optional
or
string[]Optional
confirmedEmailstring · min: 1Optional

Confirmed email associated with the Profile.

confirmedEmailsany ofOptional

Confirmed email(s) associated with the Profile.

string · min: 1Optional
or
string[]Optional
firststring · min: 1Optional

First name associated with the Profile.

middlestring | nullableOptional

Middle name associated with the Profile.

laststring · min: 1Optional

Last name associated with the Profile.

termstring · min: 1Optional

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

groupstring · min: 1Optional

Group id where to get all the member profiles.

trashbooleanOptional

Whether to include deleted profiles.

withBlockedbooleanOptional

Whether to include blocked profiles.

needsModerationbooleanOptional

Whether to return Profiles that need moderation.

selectstring · min: 1Optional

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

Example: id,content.names,content.emails
sortstring · min: 1Optional

Sort returned Profiles by field.

limitinteger · int32 · min: 1Optional

Maximum number of results to return.

offsetinteger · int32Optional

Offset of the result shown.

cachebooleanOptional

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

Responses
200
Profile response
application/json
get
GET /profiles/search HTTP/1.1
Host: api.openreview.net
Accept: */*
200

Profile response

[]
get

Returns groups

Authorizations
Query parameters
idstring · min: 1Optional

Group id.

idsstring[] · min: 1Optional

Group ids.

regexstring · min: 1Optional

Group id regular expression.

memberstring · min: 1Optional

Group id to get its transitive members.

signaturestring · min: 1Optional

Group id used to sign the returned Groups.

signatorystring · min: 1Optional

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

writerstring · min: 1Optional

Group id that is writer of the returned Groups.

selectstring · min: 1Optional

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

Example: id,members
detailsstring · min: 1Optional

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

Example: writable
limitinteger · int32 · min: 1Optional

Maximum number of results to return.

offsetinteger · int32Optional

Offset of the result shown.

webbooleanOptional

Whether to return web ui code

cachebooleanOptional

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

Responses
200
Group response
application/json
get
GET /groups HTTP/1.1
Host: api.openreview.net
Accept: */*
[]
post

Creates or edit a Group

Authorizations
Body
idstringRequired
tcdateintegerOptional
tmdateintegerOptional
tauthorstringOptional
readersstring[]Optional
nonreadersstring[]Optional
writersstring[]Optional
signatoriesstring[]Optional
signaturesstring[]Required
membersstring[]Optional
webstring | nullableOptional
Responses
200
Group response
application/json
post
POST /groups HTTP/1.1
Host: api.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "id": "ICLR.cc",
  "readers": [
    "everyone"
  ],
  "writers": [
    "ICLR.cc"
  ],
  "signatories": [
    "ICLR.cc"
  ],
  "signatures": [
    "~Super_User1"
  ]
}
{
  "id": "text",
  "tcdate": 1,
  "tmdate": 1,
  "tauthor": "text",
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatories": [
    "text"
  ],
  "signatures": [
    "text"
  ],
  "members": [
    "text"
  ],
  "web": "text"
}
put

Adds members to a Group

Authorizations
Body
idstring · min: 1Required

Group id to which memebers will be added.

membersstring[] · min: 1Required

Members to add to the Group.

Responses
200
Group response
application/json
put
PUT /groups/members HTTP/1.1
Host: api.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 32

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

Removes members from a Group

Authorizations
Body
idstring · min: 1Required

Group id from which memebers will be removed.

membersstring[] · min: 1Required

Members to remove from the Group.

Responses
200
Group response
application/json
delete
DELETE /groups/members HTTP/1.1
Host: api.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 32

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

Returns all the Notes by filter.

Authorizations
Query parameters
idstring · min: 1Optional

Note id.

idsany ofOptional

Note ids.

string · min: 1Optional
or
string[] · min: 1Optional
invitationstring · min: 1Optional

Invitation id used to create the Note(s).

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

Invitation ids.

string · min: 1Optional
or
string[]Optional
referentstring · min: 1Optional

Reference referent.

forumany ofOptional

Note id of the forum field.

string · min: 1Optional
or
string[]Optional
replytoany ofOptional

Note id of the replyto field.

string · min: 1Optional
or
string[]Optional
numberany ofOptional

Note number.

integer · min: 1Optional
or
string · min: 1OptionalPattern: ^([1-9][0-9]*,?)*[1-9][0-9]*$
or
integer[] · min: 1Optional
content.titlestring · min: 1Optional

Note title.

content.confidencestring · min: 1Optional

Note content confidence field value.

content.strengthsstring · min: 1Optional

Note content strengths field value.

content.weaknessesstring · min: 1Optional

Note content weaknesses field value.

content.decisionstring · min: 1Optional

Note content decision field value.

content.certificationsstring · min: 1Optional

Note content certification field values.

content.previous_URLstring · min: 1Optional

Note content previous_URL field value.

content.userstring · min: 1Optional

User email in recruitment.

content.responsestring · min: 1Optional

User response in recruitment.

content.submission_idstring · min: 1Optional
content.venuestring · min: 1Optional

Note venue.

content.venueidstring · min: 1Optional

Note venueid.

content.venue_idstring · min: 1Optional

Note venue_id.

content.presentation_typestring · min: 1Optional

Presentation Type.

content.sessionsstring · min: 1Optional

Sessions.

content.trackstring · min: 1Optional

Track.

content.authoridsany ofOptional

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

string · min: 1OptionalExample: ~Andrew_McCallum1
or
string[]Optional
trashboolean | nullableOptional

Whether to get deleted Notes.

paperhashstringOptionalDeprecated

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.
tauthorbooleanOptional

Get Notes authored by user.

writerstring · min: 1Optional

Get Notes written by user.

signaturestring · min: 1Optional

Get Notes signed by user.

signaturesstring[]Optional

Get Notes signed by users.

originalany ofOptional

get Notes that are originals

booleanOptional
or
string · min: 1Optional
selectstring · min: 1Optional

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

Example: id,content.title,content.abstract
detailsstring · min: 1Optional

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
inviteebooleanOptional

invitee

mintcdateintegerOptional

minimum creation date

duedatebooleanOptional

due date

sortstring · min: 1Optional

Sort returned Notes by field.

limitinteger · int32Optional

Maximum number of results to return.

offsetinteger · int32Optional

Offset of the result shown.

cachebooleanOptional

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

Responses
200
Note response
application/json
get
GET /notes HTTP/1.1
Host: api.openreview.net
Accept: */*
[]
post

Create a Note or reference, edit a Note or reference

Authorizations
Body
idstring | nullableOptional
invitationstring · min: 1Required
numberinteger | nullableOptional
forumstring | nullableOptional
replytostring | nullableOptional
referentstring | nullableOptional
originalstring | nullableOptional
contentobjectRequired
cdateinteger | nullableOptional
ddateinteger | nullableOptional
mdateinteger | nullableOptional
tcdateinteger | nullableOptional
tmdateinteger | nullableOptional
tauthorstring · min: 1Optional
readersstring[] | nullableOptional
nonreadersstring[] | nullableOptional
writersstring[] | nullableOptional
signaturesstring[]Required
Responses
200
Note response
application/json
post
POST /notes HTTP/1.1
Host: api.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 325

{
  "invitation": "ICLR.cc/2018/Conference/-/Submission",
  "content": {
    "title": "Paper title",
    "abstract": "Paper abstract",
    "authors": [
      "Author name 1",
      "Author name 2"
    ],
    "authorids": [
      "[email protected]",
      "[email protected]"
    ],
    "pdf": "/pdf/12345.pdf"
  },
  "readers": [
    "everyone"
  ],
  "writers": [
    "ICLR.cc/2018/Conference"
  ],
  "signatures": [
    "~Super_User1"
  ]
}
{
  "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": {},
    "overwritting": [
      "text"
    ],
    "forumContent": {},
    "tags": [],
    "invitation": {
      "id": "text",
      "super": "text",
      "reply": {
        "referent": "text",
        "forum": "text",
        "replyto": "text",
        "readers": {},
        "writers": {},
        "signatures": {},
        "content": {}
      },
      "final": [],
      "cdate": 1,
      "ddate": 1,
      "duedate": 1,
      "expdate": 1,
      "tcdate": 1,
      "tmdate": 1,
      "tauthor": "text",
      "details": {},
      "hideOriginalRevisions": true,
      "multiReply": true,
      "transform": "text",
      "taskCompletionCount": 1,
      "replyForumViews": [
        {
          "id": "text",
          "label": "text",
          "filter": "text",
          "layout": 1,
          "sort": "text"
        }
      ],
      "preprocess": "text",
      "process": "text",
      "web": "text",
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "writers": [
        "text"
      ],
      "signatures": [
        "text"
      ],
      "invitees": [
        "text"
      ],
      "noninvitees": [
        "text"
      ]
    },
    "directReplyCount": 1,
    "directReplies": [
      {}
    ],
    "replies": [
      {}
    ]
  }
}

Search Notes

Authorizations
Query parameters
querystring · min: 1Optional

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

termstring · min: 1Optional

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

typestring · enumOptional

Search type

Possible values:
contentstring · min: 1Optional

Fields inside content to look for the term.

Default: all
Groupstring · min: 1Optional

Group that the Invitation belongs to

sourcestring · enumOptional

Source of the Note

Default: allPossible values:
invitationstring · min: 1Optional

Invitation id used to create the Note(s).

Example: ICLR.cc/2018/Conference/-/Submission
venuestring · min: 1Optional

venue of the Note

venueidstring · min: 1Optional

venue id of the Note

sortstring · min: 1Optional

Sort returned Notes by field.

Example: tmdate:desc
limitinteger · int32Optional

Maximum number of results to return.

offsetinteger · int32Optional

Offset of the result shown.

cachebooleanOptional

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

Responses
200
Note response
application/json
get
GET /notes/search HTTP/1.1
Host: api.openreview.net
Accept: */*
{
  "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": {},
    "overwritting": [
      "text"
    ],
    "forumContent": {},
    "tags": [],
    "invitation": {
      "id": "text",
      "super": "text",
      "reply": {
        "referent": "text",
        "forum": "text",
        "replyto": "text",
        "readers": {},
        "writers": {},
        "signatures": {},
        "content": {}
      },
      "final": [],
      "cdate": 1,
      "ddate": 1,
      "duedate": 1,
      "expdate": 1,
      "tcdate": 1,
      "tmdate": 1,
      "tauthor": "text",
      "details": {},
      "hideOriginalRevisions": true,
      "multiReply": true,
      "transform": "text",
      "taskCompletionCount": 1,
      "replyForumViews": [
        {
          "id": "text",
          "label": "text",
          "filter": "text",
          "layout": 1,
          "sort": "text"
        }
      ],
      "preprocess": "text",
      "process": "text",
      "web": "text",
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "writers": [
        "text"
      ],
      "signatures": [
        "text"
      ],
      "invitees": [
        "text"
      ],
      "noninvitees": [
        "text"
      ]
    },
    "directReplyCount": 1,
    "directReplies": [
      {}
    ],
    "replies": [
      {}
    ]
  }
}
get

Returns all the references by filter

Authorizations
Query parameters
idstring · min: 1Optional

reference id

idsany ofOptional

reference ids

string · min: 1Optional
or
string[]Optional
invitationstring · min: 1Optional

Invitation id used to create the Reference(s).

invitationsany ofOptional

Invitation ids

string · min: 1Optional
or
string[]Optional
referentstring · min: 1Optional

Reference referent.

forumany ofOptional

Note id of the forum field.

string · min: 1Optional
or
string[]Optional
replytoany ofOptional

Note id of the replyto field.

string · min: 1Optional
or
string[]Optional
numberstringOptional

Note number.

content.titlestring · min: 1Optional

Note title.

content.venuestring · min: 1Optional

Note venue.

content.venueidstring · min: 1Optional

Note venueid.

content.authoridsany ofOptional

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

string · min: 1Optional
or
string[]Optional
trashboolean | nullableOptional

Get Notes deleted too.

paperhashstringOptionalDeprecated

paperhash of the Note if exists.

pdfstringOptionalDeprecated

Get Note using pdf hash.

tauthorbooleanOptional

Get Notes authored by user.

writerstring · min: 1Optional

Get Notes written by user.

signaturestring · min: 1Optional

Get Notes signed by user.

signaturesstring[]Optional

Get Notes signed by users.

originalany ofOptional

Get Notes that are originals.

booleanOptional
or
string · min: 1Optional
selectstring · min: 1Optional

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

detailsstring · min: 1Optional

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

inviteebooleanOptional

Invitee

mintcdateintegerOptional

Minimum creation date

duedatebooleanOptional

Due date

sortstring · min: 1Optional

Sort returned Notes by field.

limitinteger · int32Optional

Maximum number of results to return.

offsetinteger · int32Optional

Offset of the result shown.

cachebooleanOptional

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

Responses
200
Note response
application/json
get
GET /references HTTP/1.1
Host: api.openreview.net
Accept: */*
[]
get

Get a PDF

Authorizations
Query parameters
idstring · min: 1Required

reference id

Responses
200
pdf
get
GET /references/pdf HTTP/1.1
Host: api.openreview.net
Accept: */*
200

pdf

No content

get

Get a reference attachment

Authorizations
Query parameters
idstringRequired

Note id

namestringRequired

attachment field name

Responses
200
attachment
get
GET /references/attachment HTTP/1.1
Host: api.openreview.net
Accept: */*
200

attachment

No content

get

Returns Invitations

Authorizations
Query parameters
idstring · min: 1Optional

Invitation id

idsstring · min: 1Optional

Comma separated Invitation ids

superstring · min: 1Optional

Super Invitation id

regexstring · min: 1Optional

Invitation id regular expression

typestring · enumOptional

Invitation type

Possible values:
replyForumstring · min: 1Optional

Note id

replyInvitationstring · min: 1Optional

Invitation id

minduedateintegerOptional

minimum due date of the Invitation

inviteeany ofOptional

invitee id

booleanOptional
or
string · min: 1Optional
signaturestring · min: 1Optional

Invitation signature

replytobooleanOptional

Invitations should have replyto field

duedatebooleanOptional

Invitations should have due date

pastduebooleanOptional

Invitations should be past due

expiredbooleanOptional

Invitations should be expired

selectstring · min: 1Optional

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

Example: id,content,readers,invitees
detailsstring · min: 1Optional

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

tagsbooleanOptionalDeprecated

Get only Tag Invitations

edgesbooleanOptionalDeprecated

Get only edge Invitations

notesbooleanOptionalDeprecated

Get only Note Invitations

limitinteger · int32 · min: 1Optional

Maximum number of results to return.

offsetinteger · int32Optional

Offset of the result shown.

cachebooleanOptional

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

Responses
200
Invitation response
application/json
get
GET /invitations HTTP/1.1
Host: api.openreview.net
Accept: */*
[]
post

Create or edit an Invitation

Authorizations
Body
idstring · min: 1Required
superstring · min: 1Optional
finalarray | nullableOptional
cdateinteger | nullableOptional
ddateinteger | nullableOptional
duedateinteger | nullableOptional
expdateinteger | nullableOptional
tcdateinteger | nullableOptional
tmdateinteger | nullableOptional
tauthorstringOptional
detailsobjectOptional
hideOriginalRevisionsbooleanOptional
multiReplyboolean | nullableOptional
transformstring | nullableOptional
taskCompletionCountinteger | nullableOptional
preprocessstring | nullableOptional
processany ofOptional
string | nullableOptional
or
webstring | nullableOptional
readersstring[] | nullableOptional
nonreadersstring[] | nullableOptional
writersstring[] | nullableOptional
signaturesstring[]Required
inviteesstring[] | nullableOptional
noninviteesstring[] | nullableOptional
Responses
200
Invitation response
application/json
post
POST /invitations HTTP/1.1
Host: api.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 952

{
  "id": "ICLR.cc/2018/Conference/-/Submission",
  "reply": {
    "readers": {
      "description": "The users who will be allowed to read the above content.",
      "values": [
        "everyone"
      ]
    },
    "writers": {
      "values": [
        "ICLR.cc/2018/Conference"
      ]
    },
    "signatures": {
      "description": "Your authorized identity to be associated with the above content.",
      "values-regex": "~.*|ICLR.cc/2018/Conference"
    }
  },
  "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]+)*"
    }
  },
  "invitees": [
    "everyone"
  ],
  "readers": [
    "everyone"
  ],
  "writers": [
    "~Super_User1"
  ],
  "signatures": [
    "~Super_User1"
  ]
}
{
  "id": "text",
  "super": "text",
  "reply": {
    "referent": "text",
    "forum": "text",
    "replyto": "text",
    "readers": {},
    "writers": {},
    "signatures": {},
    "content": {}
  },
  "final": [],
  "cdate": 1,
  "ddate": 1,
  "duedate": 1,
  "expdate": 1,
  "tcdate": 1,
  "tmdate": 1,
  "tauthor": "text",
  "details": {},
  "hideOriginalRevisions": true,
  "multiReply": true,
  "transform": "text",
  "taskCompletionCount": 1,
  "replyForumViews": [
    {
      "id": "text",
      "label": "text",
      "filter": "text",
      "layout": 1,
      "sort": "text"
    }
  ],
  "preprocess": "text",
  "process": "text",
  "web": "text",
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatures": [
    "text"
  ],
  "invitees": [
    "text"
  ],
  "noninvitees": [
    "text"
  ]
}
get

Find tags by different filters

Authorizations
Query parameters
idstringOptional

Tag id

idsstring[]Optional

comma separated Tag ids

invitationstringOptional

Invitation id used to create the Tag(s).

Example: ICLR.cc/2018/Conference/-/Add_Bid
tagstring · min: 1Optional

Tag value

signaturestring · min: 1Optional

Tag signature

forumstringOptional

Note id of the forum field.

replytostringOptional

Invitations should have replyto field

trashbooleanOptional

Get tags deleted too.

tauthorbooleanOptional

Get tags authored by user.

detailsstring · min: 1Optional

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

limitinteger · int32Optional

Maximum number of results to return.

Default: 1000
offsetinteger · int32Optional

Offset of the result shown.

Default: 0
Responses
200
Tag response
application/json
get
GET /tags HTTP/1.1
Host: api.openreview.net
Accept: */*
[]
post

Create or edit a Tag

Authorizations
Body
idstring | nullableOptional
invitationstringRequired
forumstringOptional
replytostring | nullableOptional
tagstringRequired
cdateinteger | nullableOptional
ddateinteger | nullableOptional
tcdateinteger | nullableOptional
tmdateintegerOptional
tauthorstringOptional
readersstring[]Optional
nonreadersstring[] | nullableOptional
signaturesstring[] · min: 1Required
Responses
200
Tag response
application/json
post
POST /tags HTTP/1.1
Host: api.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 149

{
  "invitation": "ICLR.cc/2018/Conference/-/Add_Bid",
  "forum": "SJeI6e62XQ",
  "tag": "I want to review",
  "readers": [
    "everyone"
  ],
  "signatures": [
    "~Super_User1"
  ]
}
{
  "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"
  ]
}
get

Find messages by different filters

Authorizations
Query parameters
idstring · min: 1Optional

Message id.

tostring · min: 1Optional

Email address of the recipient.

subjectstring · min: 1Optional

Subject of the Message.

parentGroupstring · min: 1Optional

Parent Group the recipient belongs to.

statusany ofOptional

Status of the message.

string · min: 1Optional
or
string[]Optional
tauthorstring · min: 1Optional

Email of the author of the message.

limitinteger · int32Optional

Maximum number of results to return.

offsetinteger · int32Optional

Offset of the result shown.

cachebooleanOptional

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

Responses
200
message response
application/json
get
GET /messages HTTP/1.1
Host: api.openreview.net
Accept: */*
[]
post

Create a direct message

Authorizations
Body
subjectstringRequired

Subject of the message.

messagestringRequired

Message body.

groupsstring[] · min: 1Required

Groups the message is sent to.

ignoreGroupsstring[] | nullableOptional

Groups the message should not be sent to.

Default: []
parentGroupstring | nullableOptional

Parent group that the groups belong to.

sendAtinteger | nullableOptional

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

replyTostring | nullableOptional

Email address the recipient should replyto.

useJobboolean | nullableOptional

Whether to wait for messages to be sent.

Responses
200
message response
application/json
Responseany of
or
or
post
POST /messages HTTP/1.1
Host: api.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 178

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

Get logs by different filters

Authorizations
Query parameters
idstring · min: 1Optional

log id

parentGroupstring · min: 1Optional

Parent Group id

invitationstring · min: 1Optional

Invitation id that contains the process function.

statusstring · min: 1Optional

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

limitinteger · int32Optional

Maximum number of results to return.

Default: 1000
offsetinteger · int32Optional

Offset of the result shown.

Default: 0
Responses
200
log response
application/json
get
GET /logs/process HTTP/1.1
Host: api.openreview.net
Accept: */*
[]

Last updated

Was this helpful?

#141: add registration stage info

Change request updated