OpenAPI definition

Login to openreview

post

/login

Authorizations

Body

idstring · min: 1required

Any confirmed email address that is associated to the OpenReview Profile.

passwordstring · min: 1required

expiresIninteger · min: 1 | nullable

An optional parameter to determine the number of seconds before the assigned token expires.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

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

An object containing the assigned token and the OpenReview Profile.

Register a new user

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

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

200

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.

Activate a user

put

/activate/{token}

Authorizations

Path parameters

tokenstringrequired

activation token

Body

preferredEmailstring

genderstring

homepagestring

dblpstring

gscholarstring

wikipediastring

linkedinstring

orcidstring

emailsstring[]

namesobject[]

relationsobject[] | nullable

expertiseobject[] | nullable

historyobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "token": "text",
  "user": {
    "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"
    ]
  }
}

user token

Activate a user

put

/activatelink/{token}

Authorizations

Path parameters

tokenstringrequired

activation token

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.openreview.net/activatelink/{token}'

200

200

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

user token

Check if a user is activatable

get

/activatable/{token}

Authorizations

Path parameters

tokenstringrequired

activation token

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.openreview.net/activatable/{token}'

200

200

{
  "profile": {
    "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"
    ]
  },
  "activatable": {},
  "prefixed_positions": [],
  "prefixed_relations": [],
  "institutions": []
}

user token

Check if a user is activatable

post

/activatable

Authorizations

Body

idstring · min: 1 · max: 254required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "id": "text"
}

user token

Reset a user password

put

/reset/{token}

Authorizations

Path parameters

tokenstringrequired

reset token

Body

passwordstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

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.

Logout a user

post

/logout

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.openreview.net/logout'

200

200

{}

Empty object

Check if a user is resettable

get

/resettable/{token}

Authorizations

Path parameters

tokenstringrequired

reset token

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.openreview.net/resettable/{token}'

200

200

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

user token

Check if a user is resettable

post

/resettable

Authorizations

Body

idstring · min: 1 · max: 254required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

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

Group

Impersonate a user

post

/impersonate

Authorizations

Body

groupIdstring · min: 1required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

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

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

200

200

{
  "username": "text"
}

Next available tilde username

Confirm a new email

post

/user/confirm

Authorizations

Body

usernamestring · min: 1required

alternatestring · min: 1 · max: 254required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "alternate": "text"
}

user email

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

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

200

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

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

200

200

{
  "url": "text"
}

Path to the attachment.

Upload an attachment chunk

put

/attachment/chunk

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.

clientUploadIdstring · min: 1 · max: 25required

Unique id that identifies all the chunks to the same file.

chunkIndexintegerrequired

The index of the chunk.

totalChunksinteger · min: 1required

The total number of chunks.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

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

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

200

200

No body

PDF

Get a PDF

get

/pdf/{id}

Authorizations

Path parameters

idstringrequired

PDF id. This is the value saved in the pdf field of the Note.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.openreview.net/pdf/{id}'

200

200

No body

pdf

Compare PDFs

get

/pdf/compare

Authorizations

Query parameters

noteIdstringrequired

Note id

leftIdstringrequired

Edit id

rightIdstringrequired

Edit id

fieldstring · default: pdf

field to compare

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.openreview.net/pdf/compare?noteId=text&leftId=text&rightId=text'

200

200

No body

pdf comparison

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 · min: 1

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

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

200

200

[]

edges

Create an edge

post

/edges

Authorizations

Body

idstring · min: 1

invitationstring · min: 1required

headstring · min: 1required

tailstring · min: 1required

labelstring

signaturesstring · min: 1[]

weightany of

ddateany of

readersany of

nonreadersany of

writersany of

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

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

Edge

Get edges count

get

/edges/count

Authorizations

Query parameters

idstring · min: 1

Edge id

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 · min: 1

label of the Edge(s).

trashboolean

Whether to return deleted Edges as well.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "count": 1
}

edges

Get user profiles

get

/profiles

Authorizations

Query parameters

idstring · min: 1

Profile id

Pattern: ^~.*\d+$

idsany of

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

statestring · enum

State of the Profile.

Options: Inactive, Needs Moderation, Active Institutional, Active Automatic, Active, Blocked, Limited, Merged, Rejected

sortstring · min: 1

Sort returned Profiles by field.

limitinteger · min: 1

Maximum number of results to return.

offsetinteger

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

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

200

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

statestring · enum

Options: Active, Active Institutional, Active Automatic, Inactive, Blocked, Rejected

readersstring · min: 1[]

nonreadersstring · min: 1[] | nullable

writersstring · min: 1[]

signaturesstring · min: 1[]required

contentobject

metaContentobject

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

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

Pattern: ^~.*\d+$

idsany of

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

statestring · enum

State of the Profile.

Options: Inactive, Needs Moderation, Active Institutional, Active Automatic, Active, Blocked, Limited, Merged, Rejected

sortstring · min: 1

Sort returned Profiles by field.

limitinteger · min: 1

Maximum number of results to return.

offsetinteger

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

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

200

200

[]

Profile response

Returns groups

get

/groups

Authorizations

Query parameters

idstring · min: 1

Group id.

idsany of

Group ids.

prefixstring · min: 1

Group id prefix.

parentstring · min: 1

Group parent.

memberstring · min: 1

Group id to get its transitive members.

membersstring · min: 1

Group id to get groups that the Group is member of.

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.

hoststring · min: 1 | nullable

Host 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 · min: 1

Maximum number of results to return.

offsetinteger

Offset of the result shown.

webboolean

Whether to return web ui code

streamboolean

Whether to use a stream to process results or not.

cacheboolean

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

[]

Group response

Returns all the Group Edits by filter.

get

/groups/edits

Authorizations

Query parameters

idstring · min: 1

Edit id.

idsany of

Edit ids.

group.idstring · min: 1

Group id that the Edits have edited.

invitationstring · min: 1

Invitation id used to create the Edit(s).

trashboolean

Whether to get deleted Group Edits.

tauthorboolean

Get Edits authored by user.

writerstring · min: 1

Get Edits written by user.

signaturesany of

Get Edits signed by users.

selectstring · min: 1

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

Example: id,content.title,content.abstract

detailsstring · min: 1

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

Example: all

sortstring · min: 1

Sort returned Edits by field.

limitinteger

Maximum number of results to return.

offsetinteger

Offset of the result shown.

cacheboolean

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

[]

Edit Group response

Create or edit a Group Edit

post

/groups/edits

Authorizations

Body

idstring · min: 1

invitationstring · min: 1

tauthorstring · min: 1

contentobject

replacementboolean

groupobject

signaturesstring · min: 1[]

cdateany of

ddateany of

mdateany of

readersany of

nonreadersany of

writersany of

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

{
  "id": "text",
  "invitation": "text",
  "tauthor": "text",
  "content": {},
  "replacement": true,
  "group": {
    "id": "text",
    "tcdate": 1,
    "tmdate": 1,
    "tauthor": "text",
    "host": "text",
    "web": "text",
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatories": [
      "text"
    ],
    "signatures": [
      "text"
    ],
    "members": [
      "text"
    ]
  },
  "signatures": [
    "text"
  ],
  "cdate": 1,
  "ddate": 1,
  "mdate": 1,
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ]
}

Group Edit response

Returns all the Note Edits by filter.

get

/notes/edits

Authorizations

Query parameters

idstring · min: 1

Edit id.

idsany of

Edit ids.

note.idstring · min: 1

Note id that the Edits have edited.

invitationstring · min: 1

Invitation id used to create the Edit(s).

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

trashboolean

Whether to get deleted Note Edits.

tauthorboolean

Get Edits authored by user.

writerstring · min: 1

Get Edits written by user.

signaturesany of

Get Edits signed by users.

originalany of

get Edits that are originals

selectstring · min: 1

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

Example: id,content.title,content.abstract

detailsstring · min: 1

Comma separated values of fields to add to details. Valid values are writable, invitation, presentation, and all

Example: all

sortstring · min: 1

Sort returned Edits by field.

limitinteger

Maximum number of results to return.

offsetinteger

Offset of the result shown.

cacheboolean

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

[]

Edit Note response

Create or edit a Note Edit

post

/notes/edits

Authorizations

Body

idstring · min: 1

invitationstring · min: 1

tauthorstring · min: 1

contentobject

replacementboolean

noteobject

signaturesstring · min: 1[]

cdateany of

ddateany of

mdateany of

readersany of

nonreadersany of

writersany of

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

{
  "id": "text",
  "invitation": "text",
  "tauthor": "text",
  "content": {},
  "replacement": true,
  "note": {
    "id": "text",
    "forum": "text",
    "content": {},
    "replyto": "text",
    "cdate": 1,
    "pdate": 1,
    "ddate": 1,
    "mdate": 1,
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatures": [
      "text"
    ]
  },
  "signatures": [
    "text"
  ],
  "cdate": 1,
  "ddate": 1,
  "mdate": 1,
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ]
}

Note Edit response

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

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.

transitiveMembersboolean

Include transitive members of signature if it's passed as a parameter.

signaturesany of

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, original, overwriting, revisions, writable, forumContent, tags, revisions, invitation, directReplyCount, directReplies, replies, and all

Example: all

inviteeboolean

invitee

mintcdateinteger

minimum creation date

duedateboolean

due date

sortstring · min: 1

Sort returned Notes by field.

limitinteger

Maximum number of results to return.

offsetinteger

Offset of the result shown.

cacheboolean

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

[]

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

Maximum number of results to return.

offsetinteger

Offset of the result shown.

cacheboolean

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

{
  "id": "text",
  "invitation": "text",
  "number": 1,
  "forum": "text",
  "content": {},
  "signatures": [
    "text"
  ],
  "details": {
    "replyCount": 1,
    "writable": true,
    "revisions": true,
    "original": {},
    "forumContent": {},
    "invitation": {
      "id": "text",
      "edge": {
        "id": "text",
        "invitation": "text",
        "head": "text",
        "tail": "text",
        "label": "text",
        "signatures": [
          "text"
        ],
        "weight": 1,
        "ddate": 1,
        "readers": [
          "text"
        ],
        "nonreaders": [
          "text"
        ],
        "writers": [
          "text"
        ]
      },
      "tag": {
        "id": "text",
        "invitation": "text",
        "forum": "text",
        "tag": "text",
        "signatures": [
          "text"
        ],
        "replyto": "text",
        "cdate": 1,
        "ddate": 1,
        "readers": [
          "text"
        ],
        "nonreaders": [
          "text"
        ]
      },
      "taskCompletionCount": 1,
      "edit": null,
      "signatures": [
        "text"
      ],
      "details": {
        "writable": true,
        "replytoNote": {
          "id": "text",
          "invitation": "text",
          "number": 1,
          "forum": "text",
          "content": {},
          "signatures": [
            "text"
          ],
          "details": {
            "replyCount": 1,
            "writable": true,
            "revisions": true,
            "original": {},
            "forumContent": {},
            "invitation": "[Circular Reference]",
            "directReplyCount": 1,
            "overwritting": [
              "text"
            ],
            "tags": [],
            "directReplies": [
              {}
            ],
            "replies": [
              {}
            ]
          },
          "replyto": "text",
          "cdate": 1,
          "pdate": 1,
          "ddate": 1,
          "mdate": 1,
          "readers": [
            "text"
          ],
          "nonreaders": [
            "text"
          ],
          "writers": [
            "text"
          ]
        },
        "repliedNotes": [],
        "repliedEdits": [],
        "repliedTags": [],
        "withRepliedEdges": [],
        "withWritableWith": []
      },
      "cdate": 1,
      "ddate": 1,
      "duedate": 1,
      "expdate": 1,
      "maxReplies": 1,
      "minReplies": 1,
      "preprocess": "text",
      "process": "text",
      "web": "text",
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "writers": [
        "text"
      ],
      "invitees": [
        "text"
      ],
      "noninvitees": [
        "text"
      ],
      "replyForumViews": [
        {
          "id": "text",
          "label": "text",
          "filter": "text",
          "layout": 1,
          "sort": "text"
        }
      ],
      "dateprocesses": [
        {
          "script": "text",
          "delay": 1
        }
      ]
    },
    "directReplyCount": 1,
    "overwritting": [
      "text"
    ],
    "tags": [],
    "directReplies": [
      {}
    ],
    "replies": [
      {}
    ]
  },
  "replyto": "text",
  "cdate": 1,
  "pdate": 1,
  "ddate": 1,
  "mdate": 1,
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ]
}

Note response

Get a reference attachment

get

/references/attachment

Authorizations

Query parameters

idstringrequired

Note id

namestringrequired

attachment field name

Responses

cURL

JavaScript

Python

HTTP

cURL

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

200

200

No body

attachment

Returns Invitation Edits

get

/invitations/edits

Authorizations

Query parameters

idstring · min: 1

Edit id.

idsany of

Edit ids.

invitation.idstring · min: 1

Invitation id that the Edits have edited.

invitationstring · min: 1

Invitation id used to create the Edit(s).

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

trashboolean

Whether to get deleted Invitation Edits.

tauthorboolean

Get Edits authored by user.

writerstring · min: 1

Get Edits written by user.

signaturesany of

Get Edits signed by users.

originalany of

get Edits that are originals

selectstring · min: 1

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

Example: id,content.title,content.abstract

detailsstring · min: 1

Comma separated values of fields to add to details. Valid values are writable, invitation, presentation, and all

Example: all

sortstring · min: 1

Sort returned Edits by field.

limitinteger

Maximum number of results to return.

offsetinteger

Offset of the result shown.

cacheboolean

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

[]

Invitation response

Create or edit a Invitation Edit

post

/invitations/edits

Authorizations

Body

idstring · min: 1

invitationsstring · min: 1

contentobject

invitationobject

replacementboolean · enum

Options: true

signaturesstring · min: 1[]

cdateany of

readersany of

nonreadersany of

writersany of

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

{
  "id": "text",
  "invitations": "text",
  "content": {},
  "invitation": {
    "id": "text",
    "edge": {
      "id": "text",
      "invitation": "text",
      "head": "text",
      "tail": "text",
      "label": "text",
      "signatures": [
        "text"
      ],
      "weight": 1,
      "ddate": 1,
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "writers": [
        "text"
      ]
    },
    "tag": {
      "id": "text",
      "invitation": "text",
      "forum": "text",
      "tag": "text",
      "signatures": [
        "text"
      ],
      "replyto": "text",
      "cdate": 1,
      "ddate": 1,
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ]
    },
    "content": {},
    "taskCompletionCount": 1,
    "bulk": true,
    "edit": {
      "id": "text",
      "invitations": "text",
      "content": {},
      "invitation": {
        "id": "text",
        "edge": {
          "id": "text",
          "invitation": "text",
          "head": "text",
          "tail": "text",
          "label": "text",
          "signatures": [
            "text"
          ],
          "weight": 1,
          "ddate": 1,
          "readers": [
            "text"
          ],
          "nonreaders": [
            "text"
          ],
          "writers": [
            "text"
          ]
        },
        "tag": {
          "id": "text",
          "invitation": "text",
          "forum": "text",
          "tag": "text",
          "signatures": [
            "text"
          ],
          "replyto": "text",
          "cdate": 1,
          "ddate": 1,
          "readers": [
            "text"
          ],
          "nonreaders": [
            "text"
          ]
        },
        "content": {},
        "taskCompletionCount": 1,
        "bulk": true,
        "edit": "[Circular Reference]",
        "cdate": 1,
        "ddate": 1,
        "duedate": 1,
        "expdate": 1,
        "maxReplies": 1,
        "minReplies": 1,
        "preprocess": "text",
        "process": "text",
        "web": "text",
        "replyForumViews": [
          {
            "id": "text",
            "label": "text",
            "filter": "text",
            "layout": 1,
            "sort": "text"
          }
        ],
        "readers": [
          "text"
        ],
        "nonreaders": [
          "text"
        ],
        "writers": [
          "text"
        ],
        "signatures": [
          "text"
        ],
        "invitees": [
          "text"
        ],
        "noninvitees": [
          "text"
        ],
        "dateprocesses": [
          {
            "script": "text",
            "delay": 1
          }
        ]
      },
      "replacement": true,
      "signatures": [
        "text"
      ],
      "cdate": 1,
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "writers": [
        "text"
      ]
    },
    "cdate": 1,
    "ddate": 1,
    "duedate": 1,
    "expdate": 1,
    "maxReplies": 1,
    "minReplies": 1,
    "preprocess": "text",
    "process": "text",
    "web": "text",
    "replyForumViews": [
      {
        "id": "text",
        "label": "text",
        "filter": "text",
        "layout": 1,
        "sort": "text"
      }
    ],
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatures": [
      "text"
    ],
    "invitees": [
      "text"
    ],
    "noninvitees": [
      "text"
    ],
    "dateprocesses": [
      {
        "script": "text",
        "delay": 1
      }
    ]
  },
  "replacement": true,
  "signatures": [
    "text"
  ],
  "cdate": 1,
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ]
}

Invitation Edit response

Returns Invitations

get

/invitations

Authorizations

Query parameters

idstring · min: 1

Invitation id

idsany of

Invitation ids

invitationstring · min: 1

Invitation used to validate this invitation.

prefixstring · min: 1

Invitation id prefix

domainstring · min: 1

Invitation domain

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

sortstring · min: 1

Sort returned Invitations by field.

limitinteger · min: 1

Maximum number of results to return.

offsetinteger

Offset of the result shown.

cacheboolean

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

[]

Invitation response

Find tags by different filters

get

/tags

Authorizations

Query parameters

idstring

Tag id

idsany of

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 · default: 1000

Maximum number of results to return.

offsetinteger

Offset of the result shown.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

[]

Tag response

Create or edit a Tag

post

/tags

Authorizations

Body

idstring · min: 1

invitationstring · min: 1required

forumstring · min: 1required

tagstringrequired

signaturesstring · min: 1[]required

replytoany of

cdateany of

ddateany of

readersany of

nonreadersany of

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

{
  "id": "text",
  "invitation": "text",
  "forum": "text",
  "tag": "text",
  "signatures": [
    "text"
  ],
  "replyto": "text",
  "cdate": 1,
  "ddate": 1,
  "readers": [
    "text"
  ],
  "nonreaders": [
    "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

Maximum number of results to return.

offsetinteger

Offset of the result shown.

cacheboolean

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

[]

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

{
  "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