OpenAPI definition

You can find the definition online here: https://api2.openreview.net/docs/api.yml

post

Login to openreview

Authorizations

Body

idstring · min: 1required

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

passwordstring · min: 1required

expiresIninteger | nullableoptional

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://api2.openreview.net/login' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "password": "text",
    "expiresIn": 1
  }'

200

200

{
  "token": "text",
  "user": {
    "id": "text",
    "profile": {
      "id": "text",
      "first": "text",
      "middle": "text",
      "last": "text",
      "fullname": "text",
      "emails": [
        "text"
      ],
      "preferredEmail": "text",
      "usernames": [
        "text"
      ],
      "preferredId": "text",
      "state": "Active",
      "termsTimestamp": 1
    }
  }
}

An object containing the assigned token and the OpenReview Profile.

post

Register a new user

Authorizations

Body

emailstring · min: 1 · max: 254optional

Email that will be used to log in to OpenReview.

passwordstringoptional

fullnamestring · min: 1optional

nameobjectoptional

idstringoptional

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

tokenstring | nullableoptional

Token from Turnstile that proves that the user is human. This is required for registration.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api2.openreview.net/register' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "text",
    "password": "text",
    "fullname": "text",
    "name": {
      "first": "text",
      "middle": "text",
      "last": "text",
      "preferred": true
    },
    "id": "text",
    "token": "text"
  }'

200

200

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

The Profile that is saved to the database.

put

Activate a user

Authorizations

Path parameters

tokenstringrequired

activation token

Body

contentobjectoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api2.openreview.net/activate/{token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "content": {
      "yearOfBirth": 1,
      "preferredEmail": "text",
      "gender": "text",
      "homepage": "text",
      "dblp": "text",
      "gscholar": "text",
      "wikipedia": "text",
      "linkedin": "text",
      "aclanthology": "text",
      "orcid": "text",
      "names": [
        {
          "preferred": true,
          "first": "text",
          "middle": "text",
          "last": "text",
          "fullname": "text",
          "username": "text"
        }
      ],
      "emails": [
        "text"
      ],
      "emailsConfirmed": [
        "text"
      ],
      "history": [
        {
          "position": "text",
          "institution": {
            "name": "text",
            "domain": "text",
            "country": "text",
            "stateProvince": "text",
            "city": "text",
            "department": "text"
          },
          "start": 1,
          "end": 1
        }
      ],
      "relations": [
        {
          "relation": "text",
          "name": "text",
          "email": "text",
          "username": "text",
          "start": 1,
          "end": 1,
          "readers": [
            "text"
          ]
        }
      ],
      "expertise": [
        {
          "keywords": [
            "text"
          ],
          "start": 1,
          "end": 1
        }
      ]
    }
  }'

200

200

{
  "token": "text",
  "user": {
    "id": "text",
    "active": true,
    "password": true,
    "invitation": "text",
    "email": "text",
    "content": {
      "yearOfBirth": 1,
      "preferredEmail": "text",
      "gender": "text",
      "homepage": "text",
      "dblp": "text",
      "gscholar": "text",
      "wikipedia": "text",
      "linkedin": "text",
      "aclanthology": "text",
      "orcid": "text",
      "names": [
        {
          "preferred": true,
          "first": "text",
          "middle": "text",
          "last": "text",
          "fullname": "text",
          "username": "text"
        }
      ],
      "emails": [
        "text"
      ],
      "emailsConfirmed": [
        "text"
      ],
      "history": [
        {
          "position": "text",
          "institution": {
            "name": "text",
            "domain": "text",
            "country": "text",
            "stateProvince": "text",
            "city": "text",
            "department": "text"
          },
          "start": 1,
          "end": 1
        }
      ],
      "relations": [
        {
          "relation": "text",
          "name": "text",
          "email": "text",
          "username": "text",
          "start": 1,
          "end": 1,
          "readers": [
            "text"
          ]
        }
      ],
      "expertise": [
        {
          "keywords": [
            "text"
          ],
          "start": 1,
          "end": 1
        }
      ]
    },
    "metaContent": {},
    "ddate": 1,
    "tcdate": 1,
    "tmdate": 1,
    "tauthor": "text",
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatures": [
      "text"
    ],
    "state": "Active",
    "termsTimestamp": 1
  }
}

user token

post

Moderate a user Profile

Authorizations

Body

idstringrequired

decisionstring · enumrequired

Options: accept, reject, block, unblock, delete, restore, limit

sendMailboolean | nullableoptional

reasonstring | nullableoptional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api2.openreview.net/profile/moderate' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "decision": "accept",
    "sendMail": true,
    "reason": "text"
  }'

200

400

403

200

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

user token

put

Activate a user

Authorizations

Path parameters

tokenstringrequired

Token used to activate new email

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "confirmedEmail": "text"
}

Confirmed email

get

Check if a user is activatable

Authorizations

Path parameters

tokenstringrequired

activation token

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "profile": {
    "id": "text",
    "active": true,
    "password": true,
    "invitation": "text",
    "email": "text",
    "content": {
      "yearOfBirth": 1,
      "preferredEmail": "text",
      "gender": "text",
      "homepage": "text",
      "dblp": "text",
      "gscholar": "text",
      "wikipedia": "text",
      "linkedin": "text",
      "aclanthology": "text",
      "orcid": "text",
      "names": [
        {
          "preferred": true,
          "first": "text",
          "middle": "text",
          "last": "text",
          "fullname": "text",
          "username": "text"
        }
      ],
      "emails": [
        "text"
      ],
      "emailsConfirmed": [
        "text"
      ],
      "history": [
        {
          "position": "text",
          "institution": {
            "name": "text",
            "domain": "text",
            "country": "text",
            "stateProvince": "text",
            "city": "text",
            "department": "text"
          },
          "start": 1,
          "end": 1
        }
      ],
      "relations": [
        {
          "relation": "text",
          "name": "text",
          "email": "text",
          "username": "text",
          "start": 1,
          "end": 1,
          "readers": [
            "text"
          ]
        }
      ],
      "expertise": [
        {
          "keywords": [
            "text"
          ],
          "start": 1,
          "end": 1
        }
      ]
    },
    "metaContent": {},
    "ddate": 1,
    "tcdate": 1,
    "tmdate": 1,
    "tauthor": "text",
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatures": [
      "text"
    ],
    "state": "Active",
    "termsTimestamp": 1
  },
  "activatable": {},
  "prefixed_positions": [],
  "prefixed_relations": [],
  "institutions": []
}

user token

post

Check if a user is activatable

Authorizations

Body

idstring · min: 1 · max: 254required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api2.openreview.net/activatable' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text"
  }'

200

200

{
  "id": "text"
}

user token

put

Reset a user password

Authorizations

Path parameters

tokenstringrequired

reset token

Body

passwordstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api2.openreview.net/reset/{token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "password": "text"
  }'

200

200

{
  "token": "text",
  "user": {
    "id": "text",
    "profile": {
      "id": "text",
      "first": "text",
      "middle": "text",
      "last": "text",
      "fullname": "text",
      "emails": [
        "text"
      ],
      "preferredEmail": "text",
      "usernames": [
        "text"
      ],
      "preferredId": "text",
      "state": "Active",
      "termsTimestamp": 1
    }
  }
}

User is logged in after the password is reset.

post

Logout a user

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{}

Empty object

get

Check if a user is resettable

Authorizations

Path parameters

tokenstringrequired

reset token

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "id": "text",
  "invitations": [
    "text"
  ],
  "parent": "text",
  "content": {
    "ANY_ADDITIONAL_PROPERTY": {
      "description": "text",
      "order": 1,
      "delete": true,
      "value": "text",
      "readers": {}
    }
  },
  "cdate": 1,
  "mdate": 1,
  "ddate": 1,
  "tcdate": 1,
  "tmdate": 1,
  "tauthor": "text",
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatories": [
    "text"
  ],
  "signatures": [
    "text"
  ],
  "members": [
    "text"
  ],
  "deanonymizers": [
    "text"
  ],
  "impersonators": [
    "text"
  ],
  "host": "text",
  "web": "text",
  "domain": "text",
  "anonids": true,
  "secret": "text",
  "details": {
    "writable": true
  }
}

user token

post

Refresh a user token

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api2.openreview.net/refreshToken'

200

200

{
  "token": "text",
  "user": {
    "id": "text",
    "profile": {
      "id": "text",
      "first": "text",
      "middle": "text",
      "last": "text",
      "fullname": "text",
      "emails": [
        "text"
      ],
      "preferredEmail": "text",
      "usernames": [
        "text"
      ],
      "preferredId": "text",
      "state": "Active",
      "termsTimestamp": 1
    }
  }
}

user token

post

Check if a user is resettable

Authorizations

Body

idstring · min: 1 · max: 254required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api2.openreview.net/resettable' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text"
  }'

200

200

{
  "id": "text",
  "invitations": [
    "text"
  ],
  "parent": "text",
  "content": {
    "ANY_ADDITIONAL_PROPERTY": {
      "description": "text",
      "order": 1,
      "delete": true,
      "value": "text",
      "readers": {}
    }
  },
  "cdate": 1,
  "mdate": 1,
  "ddate": 1,
  "tcdate": 1,
  "tmdate": 1,
  "tauthor": "text",
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatories": [
    "text"
  ],
  "signatures": [
    "text"
  ],
  "members": [
    "text"
  ],
  "deanonymizers": [
    "text"
  ],
  "impersonators": [
    "text"
  ],
  "host": "text",
  "web": "text",
  "domain": "text",
  "anonids": true,
  "secret": "text",
  "details": {
    "writable": true
  }
}

Group

post

Impersonate a user

Authorizations

Body

groupIdstring · min: 1required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api2.openreview.net/impersonate' \
  --header 'Content-Type: application/json' \
  --data '{
    "groupId": "text"
  }'

200

200

{
  "token": "text",
  "user": {
    "id": "text",
    "profile": {
      "id": "text",
      "first": "text",
      "middle": "text",
      "last": "text",
      "fullname": "text",
      "emails": [
        "text"
      ],
      "preferredEmail": "text",
      "usernames": [
        "text"
      ],
      "preferredId": "text",
      "state": "Active",
      "termsTimestamp": 1
    },
    "disallowDataModification": true,
    "impersonatables": [
      "text"
    ],
    "impersonator": {
      "id": "text",
      "isSuperUser": true,
      "isVenueid": true,
      "profile": {
        "id": "text",
        "first": "text",
        "middle": "text",
        "last": "text",
        "fullname": "text",
        "emails": [
          "text"
        ],
        "preferredEmail": "text",
        "usernames": [
          "text"
        ],
        "preferredId": "text",
        "state": "Active",
        "termsTimestamp": 1
      },
      "impersonator": {
        "id": "text",
        "isSuperUser": true,
        "isVenueid": true,
        "profile": {
          "id": "text",
          "first": "text",
          "middle": "text",
          "last": "text",
          "fullname": "text",
          "emails": [
            "text"
          ],
          "preferredEmail": "text",
          "usernames": [
            "text"
          ],
          "preferredId": "text",
          "state": "Active",
          "termsTimestamp": 1
        }
      }
    }
  }
}

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

get

Gets the next available OpenReview username for the passed names.

Authorizations

Query parameters

firststringoptional

first name

middlestringoptional

middle name

laststringoptional

last name

fullnamestring · min: 1optional

full name

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "username": "text"
}

Next available tilde username

post

Confirm a new email

Authorizations

Body

usernamestring · min: 1required

alternatestring · min: 1 · max: 254required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api2.openreview.net/user/confirm' \
  --header 'Content-Type: application/json' \
  --data '{
    "username": "text",
    "alternate": "text"
  }'

200

200

{
  "alternate": "text"
}

user email

get

Download an attachment

Authorizations

Query parameters

idstring · min: 1optional

Note id that contains the attachment.

idsany ofoptional

Note ids that contain the attachments.

namestring · min: 1required

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://api2.openreview.net/attachment?name=text'

200

200

No body

Attachment

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api2.openreview.net/attachment' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=binary' \
  --form 'name=text' \
  --form 'invitationId=text'

200

200

{
  "url": "text"
}

Path to the attachment.

put

Upload an 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://api2.openreview.net/attachment/chunk' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=binary' \
  --form 'name=text' \
  --form 'invitationId=text' \
  --form 'clientUploadId=text' \
  --form 'chunkIndex=1' \
  --form 'totalChunks=1'

200

200

{
  "url": "text"
}

Path to the attachment.

get

Download a PDF

Authorizations

Query parameters

idstring · min: 1optional

Note id that contains the PDF.

idsany ofoptional

Note ids that contain the attachments.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api2.openreview.net/pdf'

200

200

No body

PDF

get

Get a PDF

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://api2.openreview.net/pdf/{id}'

200

200

No body

pdf

get

Compare PDFs

Authorizations

Query parameters

noteIdstringrequired

Note id

leftIdstringrequired

Edit id

rightIdstringrequired

Edit id

fieldstring · default: "pdf"optional

field to compare

Responses

cURL

JavaScript

Python

HTTP

cURL

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

200

200

No body

pdf comparison

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.

afterstring · min: 1optional

Return documents that come after the after parameter. After should be an id.

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

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.

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.

domainstring · min: 1optional

Domain the Edges belong to to filter transitive members.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "edges": [],
  "count": 1,
  "cache": true,
  "groupedEdges": [
    {
      "id": {},
      "count": 1,
      "values": [
        {}
      ]
    }
  ]
}

edges

post

Create an edge

Authorizations

Body

idany ofoptional

invitationstring · min: 1optional

headany ofrequired

tailany ofrequired

labelany ofoptional

weightany ofoptional

ddateany ofoptional

cdateany ofoptional

tcdateinteger · max: 9999999999999optional

tmdateinteger · max: 9999999999999optional

readersany ofoptional

nonreadersany ofoptional

writersany ofoptional

signaturesany ofoptional

tauthorstring · min: 1optional

domainstring · min: 1optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api2.openreview.net/edges' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "invitation": "text",
    "head": "text",
    "tail": "text",
    "label": "text",
    "weight": 1,
    "ddate": 1,
    "cdate": 1,
    "tcdate": 1,
    "tmdate": 1,
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatures": [
      "text"
    ],
    "tauthor": "text",
    "domain": "text"
  }'

200

200

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

Edge

post

Rename an edge

Authorizations

Body

currentIdstring · min: 1required

newIdstring · min: 1required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api2.openreview.net/edges/rename' \
  --header 'Content-Type: application/json' \
  --data '{
    "currentId": "text",
    "newId": "text"
  }'

200

200

[]

edge

get

Get edges count

Authorizations

Query parameters

idstring · min: 1optional

Edge id

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

label of the Edge(s).

trashbooleanoptional

Whether to return deleted Edges as well.

domainstring · min: 1optional

Domain the Edges belong to to filter transitive members.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "count": 1
}

edges

get

Get archived edges

Authorizations

Query parameters

invitationstring · min: 1required

Invitation id used to create the Edge(s).

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api2.openreview.net/edges/archive?invitation=text'

200

200

No body

Archived edges

put

Send feedback to the OpenReview team

Authorizations

Body

fromstring · min: 1required

Email address of the user sending the feedback.

subjectstringoptional

Subject of the feedback.

messagestring · min: 1required

The feedback.

tokenstringrequired

Turnstile token.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "status": "text"
}

feedback

get

Get user profiles

Authorizations

Query parameters

idstring · min: 1optional

Profile id

Pattern: ^~.*\d+$

idsany ofoptional

Profile ids

emailstring · min: 1optional

Email associated with the Profile.

emailsany ofoptional

Email(s) associated with the Profile.

confirmedEmailstring · min: 1optional

Confirmed email associated with the Profile.

confirmedEmailsany ofoptional

Confirmed email(s) associated with the Profile.

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.

relationstring · min: 1optional

Relation associated to the Profile.

dblpstring · min: 1optional

dblp link associated to 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

statestring · enumoptional

State of the Profile.

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

sortstring · min: 1optional

Sort returned Profiles by field.

limitinteger · min: 1optional

Maximum number of results to return.

offsetintegeroptional

Offset of the result shown.

afterstring · min: 1optional

Return documents that come after the after parameter. After should be an id.

cachebooleanoptional

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://api2.openreview.net/profiles'

200

200

{
  "profiles": [],
  "count": 1,
  "fromCache": true
}

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

statestring · enumoptional

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

contentobjectoptional

metaContentobjectoptional

readersstring[]optional

nonreadersstring[] | nullableoptional

writersstring[]optional

signaturesstring[] · min: 1required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api2.openreview.net/profiles' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "invitation": "text",
    "referent": "text",
    "tcdate": 1,
    "tmdate": 1,
    "ddate": 1,
    "packaging": {},
    "active": true,
    "password": true,
    "tauthor": "text",
    "state": "Active",
    "content": {
      "preferredEmail": "text",
      "gender": "text",
      "yearOfBirth": 1,
      "homepage": "text",
      "dblp": "text",
      "gscholar": "text",
      "wikipedia": "text",
      "linkedin": "text",
      "aclanthology": "text",
      "orcid": "text",
      "semanticScholar": "text",
      "names": [
        {
          "preferred": true,
          "first": "text",
          "middle": "text",
          "last": "text",
          "fullname": "text",
          "username": "text"
        }
      ],
      "emails": [
        "text"
      ],
      "emailsConfirmed": [
        "text"
      ],
      "history": [
        {
          "position": "text",
          "institution": {
            "name": "text",
            "domain": "text",
            "country": "text",
            "stateProvince": "text",
            "city": "text",
            "department": "text"
          },
          "start": 1,
          "end": 1
        }
      ],
      "relations": [
        {
          "relation": "text",
          "name": "text",
          "email": "text",
          "username": "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"
        ]
      },
      "yearOfBirth": {
        "values": [
          1
        ],
        "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"
        ]
      },
      "aclanthology": {
        "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",
            "fullname": "text",
            "username": "text",
            "preferred": true
          }
        ],
        "weights": [
          1
        ]
      },
      "emails": {
        "values": [
          "text"
        ],
        "weights": [
          1
        ]
      },
      "history": {
        "values": [
          {
            "position": "text",
            "institution": {
              "name": "text",
              "domain": "text",
              "country": "text",
              "stateProvince": "text",
              "city": "text",
              "department": "text"
            },
            "start": 1,
            "end": 1
          }
        ],
        "weights": [
          1
        ]
      },
      "relations": {
        "values": [
          {
            "name": "text",
            "email": "text",
            "username": "text",
            "relation": "text",
            "start": 1,
            "end": 1,
            "readers": [
              "text"
            ]
          }
        ],
        "weights": [
          1
        ]
      },
      "expertise": [
        {
          "signatures": [
            "text"
          ]
        }
      ]
    },
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatures": [
      "text"
    ]
  }'

200

200

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

Profile response

get

Get user profiles

Authorizations

Query parameters

idstring · min: 1optional

Profile id

Pattern: ^~.*\d+$

idsany ofoptional

Profile ids

emailstring · min: 1optional

Email associated with the Profile.

emailsany ofoptional

Email(s) associated with the Profile.

confirmedEmailstring · min: 1optional

Confirmed email associated with the Profile.

confirmedEmailsany ofoptional

Confirmed email(s) associated with the Profile.

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.

fullnamestring · min: 1optional

Fullname associated with the Profile.

esbooleanoptional

Whether to use ElasticSearch to search for profiles.

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

statestring · enumoptional

State of the Profile.

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

sortstring · min: 1optional

Sort returned Profiles by field.

limitinteger · min: 1optional

Maximum number of results to return.

offsetintegeroptional

Offset of the result shown.

cachebooleanoptional

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://api2.openreview.net/profiles/search'

200

200

{
  "profiles": [],
  "count": 1,
  "fromCache": true
}

Profile response

post

Get user profiles

Authorizations

Query parameters

idstring · min: 1optional

Profile id

Pattern: ^~.*\d+$

idsany ofoptional

Profile ids

emailstring · min: 1optional

Email associated with the Profile.

emailsany ofoptional

Email(s) associated with the Profile.

confirmedEmailstring · min: 1optional

Confirmed email associated with the Profile.

confirmedEmailsany ofoptional

Confirmed email(s) associated with the Profile.

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

statestring · enumoptional

State of the Profile.

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

sortstring · min: 1optional

Sort returned Profiles by field.

limitinteger · min: 1optional

Maximum number of results to return.

offsetintegeroptional

Offset of the result shown.

afterstring · min: 1optional

Return documents that come after the after parameter. After should be an id.

cachebooleanoptional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api2.openreview.net/profiles/search'

200

200

{
  "profiles": [],
  "count": 1,
  "fromCache": true
}

Profile response

get

Gets profile references

Authorizations

Query parameters

idstring · min: 1optional

Group id.

idsany ofoptional

Group ids.

referentstring · min: 1optional

Profile id that the reference is modifying.

limitinteger · min: 1optional

Maximum number of results to return.

offsetintegeroptional

Offset of the result shown.

afterstring · min: 1optional

Return documents that come after the after parameter. After should be an id.

sortstring · min: 1optional

Select field to sort by.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

{
  "count": 1,
  "references": [],
  "fromCache": true
}

The Profile that is saved to the database.

get

Returns groups

Authorizations

Query parameters

idstring · min: 1optional

Group id.

idsany ofoptional

Group ids.

prefixstring · min: 1optional

Group id prefix.

parentstring · min: 1optional

Group parent.

memberstring · min: 1optional

Group id to get its transitive members.

membersstring · min: 1optional

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

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.

hoststring | nullableoptional

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

Maximum number of results to return.

offsetintegeroptional

Offset of the result shown.

afterstring · min: 1optional

Return documents that come after the after parameter. After should be an id.

sortstring · min: 1optional

Select field to sort by.

webbooleanoptional

Whether to return web ui code

streambooleanoptional

Whether to use a stream to process results or not.

cachebooleanoptional

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

domainstring · min: 1optional

Domain the Groups belong to to filter transitive members.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

{
  "count": 1,
  "groups": [],
  "fromCache": true
}

Group response

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

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api2.openreview.net/groups/members' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "members": [
      "text"
    ]
  }'

200

default

200

{
  "id": "text",
  "invitations": [
    "text"
  ],
  "parent": "text",
  "content": {
    "ANY_ADDITIONAL_PROPERTY": {
      "description": "text",
      "order": 1,
      "delete": true,
      "value": "text",
      "readers": {}
    }
  },
  "cdate": 1,
  "mdate": 1,
  "ddate": 1,
  "tcdate": 1,
  "tmdate": 1,
  "tauthor": "text",
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatories": [
    "text"
  ],
  "signatures": [
    "text"
  ],
  "members": [
    "text"
  ],
  "deanonymizers": [
    "text"
  ],
  "impersonators": [
    "text"
  ],
  "host": "text",
  "web": "text",
  "domain": "text",
  "anonids": true,
  "secret": "text",
  "details": {
    "writable": true
  }
}

Group response

get

Returns all the Group Edits by filter.

Authorizations

Query parameters

idstring · min: 1optional

Edit id.

idsany ofoptional

Edit ids.

group.idstring · min: 1optional

Group id that the Edits have edited.

invitationstring · min: 1optional

Invitation id used to create the Edit(s).

trashbooleanoptional

Whether to get deleted Group Edits.

tauthorbooleanoptional

Get Edits authored by user.

writerstring · min: 1optional

Get Edits written by user.

signaturesany ofoptional

Get Edits signed by users.

selectstring · min: 1optional

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

Example: id,content.title,content.abstract

detailsstring · min: 1optional

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

Example: all

sortstring · min: 1optional

Sort returned Edits by field.

limitintegeroptional

Maximum number of results to return.

offsetintegeroptional

Offset of the result shown.

cachebooleanoptional

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

domainstring · min: 1optional

Domain the Group Edits belong to to filter transitive members.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

{
  "count": 1,
  "edits": [],
  "fromCache": true
}

Edit Group response

post

Create or edit a Group Edit

Authorizations

Body

idstring · min: 1optional

invitationstring · min: 1optional

tauthorstring · min: 1optional

contentobjectoptional

cdateinteger · max: 9999999999999optional

ddateinteger · max: 9999999999999optional

mdateinteger · max: 9999999999999optional

readersstring[]optional

nonreadersstring[]optional

writersstring[]optional

signaturesstring[]optional

replacementbooleanoptional

groupobjectoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api2.openreview.net/groups/edits' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "invitation": "text",
    "tauthor": "text",
    "content": {},
    "cdate": 1,
    "ddate": 1,
    "mdate": 1,
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatures": [
      "text"
    ],
    "replacement": true,
    "group": {
      "id": "text",
      "cdate": 1,
      "ddate": 1,
      "mdate": 1,
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "writers": [
        "text"
      ],
      "signatories": [
        "text"
      ],
      "signatures": [
        "text"
      ],
      "deanonymizers": [
        "text"
      ],
      "impersonators": [
        "text"
      ],
      "content": {
        "ANY_ADDITIONAL_PROPERTY": {
          "description": "text",
          "order": 1,
          "delete": true,
          "value": "text",
          "readers": {}
        }
      },
      "members": [
        "text"
      ],
      "host": "text",
      "web": "text",
      "anonids": true
    }
  }'

200

default

200

{
  "id": "text",
  "invitation": "text",
  "content": {},
  "cdate": 1,
  "tcdate": 1,
  "tmdate": 1,
  "ddate": 1,
  "mdate": 1,
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatures": [
    "text"
  ],
  "group": {
    "id": "text",
    "cdate": 1,
    "ddate": 1,
    "mdate": 1,
    "tcdate": 1,
    "tmdate": 1,
    "tauthor": "text",
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatories": [
      "text"
    ],
    "signatures": [
      "text"
    ],
    "members": [
      "text"
    ],
    "host": "text",
    "web": "text",
    "domain": "text",
    "content": {
      "ANY_ADDITIONAL_PROPERTY": {
        "description": "text",
        "order": 1,
        "delete": true,
        "value": "text",
        "readers": {}
      }
    },
    "deanonymizers": [
      "text"
    ],
    "impersonators": [
      "text"
    ],
    "anonids": true
  },
  "details": {
    "writable": true,
    "invitation": {
      "id": "text",
      "invitations": [
        "text"
      ],
      "type": "edge",
      "content": {
        "ANY_ADDITIONAL_PROPERTY": {
          "description": "text",
          "order": 1,
          "delete": true,
          "value": "text",
          "readers": {}
        }
      },
      "domain": "text",
      "edge": {
        "id": "text",
        "invitation": "text",
        "head": "text",
        "tail": "text",
        "label": "text",
        "weight": 1,
        "ddate": 1,
        "cdate": 1,
        "tcdate": 1,
        "tmdate": 1,
        "readers": [
          "text"
        ],
        "nonreaders": [
          "text"
        ],
        "writers": [
          "text"
        ],
        "signatures": [
          "text"
        ],
        "tauthor": "text",
        "domain": "text"
      },
      "tag": "[Circular Reference]",
      "message": {
        "signature": "text",
        "replyTo": "text",
        "useJob": true,
        "parentGroup": "text",
        "sendAt": 1,
        "subject": "text",
        "message": "text",
        "groups": [
          "text"
        ],
        "ignoreGroups": [
          "text"
        ],
        "fromEmail": "text",
        "fromName": "text"
      },
      "edit": "[Circular Reference]",
      "tcdate": 1,
      "tmdate": 1,
      "cdate": 1,
      "mdate": 1,
      "ddate": 1,
      "duedate": 1,
      "expdate": 1,
      "responseArchiveDate": 1,
      "details": "[Circular Reference]",
      "maxReplies": 1,
      "minReplies": 1,
      "taskCompletionCount": 1,
      "replyForumViews": [
        {
          "id": "text",
          "label": "text",
          "filter": "text",
          "sort": "text",
          "nesting": 1,
          "allowedInvitations": [
            "text"
          ],
          "expandedInvitations": [
            "text"
          ],
          "live": true,
          "layout": "text",
          "message": "text"
        }
      ],
      "preprocess": "text",
      "process": "text",
      "dateprocesses": [
        {
          "script": "text",
          "delay": 1,
          "dates": [
            1
          ],
          "startDate": 1,
          "endDate": 1,
          "cron": "text"
        }
      ],
      "web": "text",
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "writers": [
        "text"
      ],
      "signatures": [
        "text"
      ],
      "invitees": [
        "text"
      ],
      "noninvitees": [
        "text"
      ]
    }
  },
  "domain": "text",
  "tauthor": "text"
}

Group Edit response

get

Returns all the Note Edits by filter.

Authorizations

Query parameters

idstring · min: 1optional

Edit id.

idsany ofoptional

Edit ids.

note.idstring · min: 1optional

Note id that the Edits have edited.

invitationstring · min: 1optional

Invitation id used to create the Edit(s).

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

domainstring · min: 1optional

Domain of the Edits.

trashbooleanoptional

Whether to get deleted Note Edits.

tauthorbooleanoptional

Get Edits authored by user.

writerstring · min: 1optional

Get Edits written by user.

signaturesany ofoptional

Get Edits signed by users.

originalany ofoptional

get Edits that are originals

selectstring · min: 1optional

Comma separated string with specific fields of the Note Edit 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. 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. invitations: Invitations of the 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. forumContent: Content of the forum Note. Only available if the Note is a reply. presentation: Shows how to render the content of the Note. signatures: Returns members and readers of the signatures of the Note.

Example: all

sortstring · min: 1optional

Sort returned Edits by field.

limitintegeroptional

Maximum number of results to return.

offsetintegeroptional

Offset of the result shown.

afterstring · min: 1optional

Return documents that come after the after parameter. After should be an id.

cachebooleanoptional

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

domainstring · min: 1optional

Domain the Note Edits belong to to filter transitive members.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

{
  "count": 1,
  "edits": [
    {
      "id": "text",
      "invitation": "text",
      "domain": "text",
      "content": {},
      "tcdate": 1,
      "tmdate": 1,
      "cdate": 1,
      "ddate": 1,
      "mdate": 1,
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "writers": [
        "text"
      ],
      "signatures": [
        "text"
      ],
      "note": {
        "id": "text",
        "invitations": [
          "text"
        ],
        "number": 1,
        "domain": "text",
        "forum": "text",
        "replyto": "text",
        "content": {},
        "tcdate": 1,
        "tmdate": 1,
        "cdate": 1,
        "pdate": 1,
        "odate": 1,
        "ddate": 1,
        "mdate": 1,
        "readers": [
          "text"
        ],
        "nonreaders": [
          "text"
        ],
        "writers": [
          "text"
        ],
        "signatures": [
          "text"
        ],
        "license": "text",
        "version": 1
      },
      "tauthor": "text",
      "replacement": true,
      "details": "[Circular Reference]"
    }
  ],
  "fromCache": true
}

Edit Note response

post

Create or edit a Note Edit

Authorizations

Body

idstring · min: 1optional

invitationstring · min: 1optional

tauthorstring · min: 1optional

contentobjectoptional

cdateinteger · max: 9999999999999optional

ddateinteger · max: 9999999999999optional

mdateinteger · max: 9999999999999optional

readersstring[]optional

nonreadersstring[]optional

writersstring[]optional

signaturesstring[]optional

replacementbooleanoptional

noteobjectoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api2.openreview.net/notes/edits' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "invitation": "text",
    "tauthor": "text",
    "content": {},
    "cdate": 1,
    "ddate": 1,
    "mdate": 1,
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatures": [
      "text"
    ],
    "replacement": true,
    "note": {
      "id": "text",
      "forum": "text",
      "replyto": "text",
      "license": "text",
      "content": {},
      "cdate": 1,
      "pdate": 1,
      "odate": 1,
      "ddate": 1,
      "mdate": 1,
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "writers": [
        "text"
      ],
      "signatures": [
        "text"
      ]
    }
  }'

200

default

200

{
  "id": "text",
  "invitation": "text",
  "domain": "text",
  "content": {},
  "tcdate": 1,
  "tmdate": 1,
  "cdate": 1,
  "ddate": 1,
  "mdate": 1,
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatures": [
    "text"
  ],
  "note": {
    "id": "text",
    "invitations": [
      "text"
    ],
    "number": 1,
    "domain": "text",
    "forum": "text",
    "replyto": "text",
    "content": {},
    "tcdate": 1,
    "tmdate": 1,
    "cdate": 1,
    "pdate": 1,
    "odate": 1,
    "ddate": 1,
    "mdate": 1,
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatures": [
      "text"
    ],
    "license": "text",
    "version": 1
  },
  "tauthor": "text",
  "replacement": true,
  "details": {
    "writable": true,
    "invitation": {
      "id": "text",
      "invitations": [
        "text"
      ],
      "type": "edge",
      "content": {
        "ANY_ADDITIONAL_PROPERTY": {
          "description": "text",
          "order": 1,
          "delete": true,
          "value": "text",
          "readers": {}
        }
      },
      "domain": "text",
      "edge": {
        "id": "text",
        "invitation": "text",
        "head": "text",
        "tail": "text",
        "label": "text",
        "weight": 1,
        "ddate": 1,
        "cdate": 1,
        "tcdate": 1,
        "tmdate": 1,
        "readers": [
          "text"
        ],
        "nonreaders": [
          "text"
        ],
        "writers": [
          "text"
        ],
        "signatures": [
          "text"
        ],
        "tauthor": "text",
        "domain": "text"
      },
      "tag": "[Circular Reference]",
      "message": {
        "signature": "text",
        "replyTo": "text",
        "useJob": true,
        "parentGroup": "text",
        "sendAt": 1,
        "subject": "text",
        "message": "text",
        "groups": [
          "text"
        ],
        "ignoreGroups": [
          "text"
        ],
        "fromEmail": "text",
        "fromName": "text"
      },
      "edit": "[Circular Reference]",
      "tcdate": 1,
      "tmdate": 1,
      "cdate": 1,
      "mdate": 1,
      "ddate": 1,
      "duedate": 1,
      "expdate": 1,
      "responseArchiveDate": 1,
      "details": "[Circular Reference]",
      "maxReplies": 1,
      "minReplies": 1,
      "taskCompletionCount": 1,
      "replyForumViews": [
        {
          "id": "text",
          "label": "text",
          "filter": "text",
          "sort": "text",
          "nesting": 1,
          "allowedInvitations": [
            "text"
          ],
          "expandedInvitations": [
            "text"
          ],
          "live": true,
          "layout": "text",
          "message": "text"
        }
      ],
      "preprocess": "text",
      "process": "text",
      "dateprocesses": [
        {
          "script": "text",
          "delay": 1,
          "dates": [
            1
          ],
          "startDate": 1,
          "endDate": 1,
          "cron": "text"
        }
      ],
      "web": "text",
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "writers": [
        "text"
      ],
      "signatures": [
        "text"
      ],
      "invitees": [
        "text"
      ],
      "noninvitees": [
        "text"
      ]
    },
    "presentation": [
      {
        "name": "text",
        "order": 1,
        "input": "text",
        "description": "text",
        "fieldName": "text",
        "hidden": true,
        "markdown": true,
        "scroll": true,
        "default": "text",
        "value": "text"
      }
    ]
  }
}

Note Edit response

get

Returns all the Notes by filter.

Authorizations

Query parameters

idstring · min: 1optional

Note id.

idsany ofoptional

Note ids.

invitationstring · min: 1optional

Invitation id used to create the Note(s).

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

invitationsany ofoptional

Invitation ids.

forumany ofoptional

Note id of the forum field.

replytoany ofoptional

Note id of the replyto field.

numberany ofoptional

Note number.

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.

trashbooleanoptional

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.

transitiveMembersbooleanoptional

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

signaturesany ofoptional

Get Notes signed by users.

originalany ofoptional

get Notes that are originals

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

Example: all

inviteebooleanoptional

invitee

mintcdateintegeroptional

minimum creation date

mintmdateintegeroptional

minimum modification date

duedatebooleanoptional

due date

sortstring · min: 1optional

Sort returned Notes by field.

limitintegeroptional

Maximum number of results to return.

offsetintegeroptional

Offset of the result shown.

afterstring · min: 1optional

Return documents that come after the after parameter. After should be an id.

cachebooleanoptional

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

domainstring · min: 1optional

Domain the Notes belong to to filter transitive members.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

{
  "count": 1,
  "notes": [],
  "fromCache": true
}

Note response

get

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.

termsstring[] · min: 1optional

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

typestring · enumoptional

Search type

Options: prefix, terms, exact

contentstring · enum · default: "all"optional

Fields inside content to look for the term.

Options: title, abstract, authors, authorids, comment, review, paperhash, confidence, summary, main_review, metareview, strengths, weaknesses, TL;DR, decision, recommendation, venueid, venue, keywords, subject_areas, all

groupstring · min: 1optional

Group that the Invitation belongs to

sourcestring · enum · default: "all"optional

Source of the Note

Options: forum, reply, all

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

limitintegeroptional

Maximum number of results to return.

offsetintegeroptional

Offset of the result shown.

cachebooleanoptional

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

domainstring · min: 1optional

Domain the Notes belong to to filter transitive members.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

{
  "count": 1,
  "notes": [],
  "fromCache": true
}

Note response

post

Search Notes Post

Authorizations

Body

idsstring[]optional

Note ids.

querystring · min: 1optional

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

termstring · min: 1optional

termsstring[] · min: 1optional

typestring · enumoptional

Search type

Options: prefix, terms

groupstring · min: 1optional

Group that the Invitation belongs to

sourcestring · enum · default: "all"optional

Source of the Note

Options: forum, reply, all

invitationstring · min: 1optional

Invitation id used to create the Note(s).

contentobjectoptional

Fields inside content to look for the term.

venuestring · min: 1optional

Venue of the Note

venueidstring · min: 1optional

Venue id of the Note

domainstring · min: 1optional

Domain the Notes belong.

sortstring · min: 1optional

Sort returned Notes by field.

Example: tmdate:desc

limitinteger · min: 1optional

Maximum number of results to return.

offsetintegeroptional

Offset of the result shown.

cachebooleanoptional

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 \
  --request POST \
  --url 'https://api2.openreview.net/notes/search' \
  --header 'Content-Type: application/json' \
  --data '{
    "ids": [
      "text"
    ],
    "query": "text",
    "term": "text",
    "terms": [
      "text"
    ],
    "type": "prefix",
    "group": "text",
    "source": "forum",
    "invitation": "text",
    "content": {
      "title": {
        "terms": [
          "text"
        ],
        "matchMethod": "match"
      },
      "venue": {
        "terms": [
          "text"
        ],
        "matchMethod": "match"
      }
    },
    "venue": "text",
    "venueid": "text",
    "domain": "text",
    "sort": "tmdate:desc",
    "limit": 1,
    "offset": 1,
    "cache": true
  }'

200

default

200

{
  "count": 1,
  "notes": [],
  "fromCache": true
}

Note response

get

Returns Invitation Edits

Authorizations

Query parameters

idstring · min: 1optional

Edit id.

idsany ofoptional

Edit ids.

invitation.idstring · min: 1optional

Invitation id that the Edits have edited.

invitationstring · min: 1optional

Invitation id used to create the Edit(s).

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

trashbooleanoptional

Whether to get deleted Invitation Edits.

tauthorbooleanoptional

Get Edits authored by user.

writerstring · min: 1optional

Get Edits written by user.

signaturesany ofoptional

Get Edits signed by users.

originalany ofoptional

get Edits that are originals

selectstring · min: 1optional

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

Example: id,content.title,content.abstract

detailsstring · min: 1optional

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

Example: all

sortstring · min: 1optional

Sort returned Edits by field.

limitinteger · min: 1optional

Maximum number of results to return.

offsetintegeroptional

Offset of the result shown.

afterstring · min: 1optional

Return documents that come after the after parameter. After should be an id.

cachebooleanoptional

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

domainstring · min: 1optional

Domain the Invitation Edits belong to to filter transitive members.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

{
  "count": 1,
  "edits": [
    {
      "id": "text",
      "invitations": "text",
      "invitation": "[Circular Reference]",
      "content": {},
      "cdate": 1,
      "ddate": 1,
      "tcdate": 1,
      "mdate": 1,
      "tmdate": 1,
      "details": "[Circular Reference]",
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "writers": [
        "text"
      ],
      "signatures": [
        "text"
      ],
      "tauthor": "text",
      "domain": "text",
      "replacement": true
    }
  ],
  "fromCache": true
}

Invitation response

post

Create or edit a Invitation Edit

Authorizations

Body

idstring · min: 1optional

invitationsstring · min: 1optional

replacementbooleanoptional

contentobjectoptional

invitationobjectoptional

cdateinteger · max: 9999999999999optional

mdateinteger · max: 9999999999999optional

ddateinteger · max: 9999999999999optional

readersstring[]optional

nonreadersstring[]optional

writersstring[]optional

signaturesstring[]optional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api2.openreview.net/invitations/edits' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "invitations": "text",
    "replacement": true,
    "content": {},
    "invitation": {
      "id": "text",
      "edge": {
        "id": "text",
        "invitation": "text",
        "head": "text",
        "tail": "text",
        "label": "text",
        "weight": 1,
        "ddate": 1,
        "cdate": 1,
        "tcdate": 1,
        "tmdate": 1,
        "readers": [
          "text"
        ],
        "nonreaders": [
          "text"
        ],
        "writers": [
          "text"
        ],
        "signatures": [
          "text"
        ],
        "tauthor": "text",
        "domain": "text"
      },
      "tag": {
        "id": "text",
        "invitation": "text",
        "forum": "text",
        "replyto": "text",
        "tag": "text",
        "cdate": 1,
        "ddate": 1,
        "mdate": 1,
        "tcdate": 1,
        "tmdate": 1,
        "readers": [
          "text"
        ],
        "nonreaders": [
          "text"
        ],
        "writers": [
          "text"
        ],
        "signatures": [
          "text"
        ],
        "tauthor": "text",
        "domain": "text",
        "details": "[Circular Reference]"
      },
      "message": {
        "signature": "text",
        "replyTo": "text",
        "useJob": true,
        "parentGroup": "text",
        "sendAt": 1,
        "subject": "text",
        "message": "text",
        "groups": [
          "text"
        ],
        "ignoreGroups": [
          "text"
        ],
        "fromEmail": "text",
        "fromName": "text"
      },
      "edit": "[Circular Reference]",
      "bulk": true,
      "content": {},
      "cdate": 1,
      "ddate": 1,
      "duedate": 1,
      "expdate": 1,
      "responseArchiveDate": 1,
      "maxReplies": 1,
      "minReplies": 1,
      "taskCompletionCount": 1,
      "replyForumViews": [
        {
          "id": "text",
          "label": "text",
          "filter": "text",
          "sort": "text",
          "nesting": 1,
          "allowedInvitations": [
            "text"
          ],
          "expandedInvitations": [
            "text"
          ],
          "live": true,
          "layout": "text",
          "message": "text"
        }
      ],
      "preprocess": "text",
      "process": "text",
      "dateprocesses": [
        {
          "script": "text",
          "delay": 1,
          "dates": [
            1
          ],
          "startDate": 1,
          "endDate": 1,
          "cron": "text"
        }
      ],
      "web": "text",
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "writers": [
        "text"
      ],
      "signatures": [
        "text"
      ],
      "invitees": [
        "text"
      ],
      "noninvitees": [
        "text"
      ]
    },
    "cdate": 1,
    "mdate": 1,
    "ddate": 1,
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatures": [
      "text"
    ]
  }'

200

default

200

{
  "id": "text",
  "invitations": "text",
  "invitation": {
    "id": "text",
    "invitations": [
      "text"
    ],
    "type": "edge",
    "content": {
      "ANY_ADDITIONAL_PROPERTY": {
        "description": "text",
        "order": 1,
        "delete": true,
        "value": "text",
        "readers": {}
      }
    },
    "domain": "text",
    "edge": {
      "id": "text",
      "invitation": "text",
      "head": "text",
      "tail": "text",
      "label": "text",
      "weight": 1,
      "ddate": 1,
      "cdate": 1,
      "tcdate": 1,
      "tmdate": 1,
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "writers": [
        "text"
      ],
      "signatures": [
        "text"
      ],
      "tauthor": "text",
      "domain": "text"
    },
    "tag": {
      "id": "text",
      "invitation": "text",
      "forum": "text",
      "replyto": "text",
      "tag": "text",
      "cdate": 1,
      "ddate": 1,
      "mdate": 1,
      "tcdate": 1,
      "tmdate": 1,
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "writers": [
        "text"
      ],
      "signatures": [
        "text"
      ],
      "tauthor": "text",
      "domain": "text",
      "details": "[Circular Reference]"
    },
    "message": {
      "signature": "text",
      "replyTo": "text",
      "useJob": true,
      "parentGroup": "text",
      "sendAt": 1,
      "subject": "text",
      "message": "text",
      "groups": [
        "text"
      ],
      "ignoreGroups": [
        "text"
      ],
      "fromEmail": "text",
      "fromName": "text"
    },
    "edit": "[Circular Reference]",
    "tcdate": 1,
    "tmdate": 1,
    "cdate": 1,
    "mdate": 1,
    "ddate": 1,
    "duedate": 1,
    "expdate": 1,
    "responseArchiveDate": 1,
    "details": {
      "writable": true,
      "replytoNote": "[Circular Reference]",
      "repliedNotes": "[Circular Reference]",
      "repliedEdits": "[Circular Reference]",
      "repliedTags": "[Circular Reference]",
      "repliedEdges": [],
      "writableWith": "[Circular Reference]"
    },
    "maxReplies": 1,
    "minReplies": 1,
    "taskCompletionCount": 1,
    "replyForumViews": [
      {
        "id": "text",
        "label": "text",
        "filter": "text",
        "sort": "text",
        "nesting": 1,
        "allowedInvitations": [
          "text"
        ],
        "expandedInvitations": [
          "text"
        ],
        "live": true,
        "layout": "text",
        "message": "text"
      }
    ],
    "preprocess": "text",
    "process": "text",
    "dateprocesses": [
      {
        "script": "text",
        "delay": 1,
        "dates": [
          1
        ],
        "startDate": 1,
        "endDate": 1,
        "cron": "text"
      }
    ],
    "web": "text",
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatures": [
      "text"
    ],
    "invitees": [
      "text"
    ],
    "noninvitees": [
      "text"
    ]
  },
  "content": {},
  "cdate": 1,
  "ddate": 1,
  "tcdate": 1,
  "mdate": 1,
  "tmdate": 1,
  "details": {
    "invitation": {
      "id": "text",
      "invitations": [
        "text"
      ],
      "type": "edge",
      "content": {
        "ANY_ADDITIONAL_PROPERTY": {
          "description": "text",
          "order": 1,
          "delete": true,
          "value": "text",
          "readers": {}
        }
      },
      "domain": "text",
      "edge": {
        "id": "text",
        "invitation": "text",
        "head": "text",
        "tail": "text",
        "label": "text",
        "weight": 1,
        "ddate": 1,
        "cdate": 1,
        "tcdate": 1,
        "tmdate": 1,
        "readers": [
          "text"
        ],
        "nonreaders": [
          "text"
        ],
        "writers": [
          "text"
        ],
        "signatures": [
          "text"
        ],
        "tauthor": "text",
        "domain": "text"
      },
      "tag": {
        "id": "text",
        "invitation": "text",
        "forum": "text",
        "replyto": "text",
        "tag": "text",
        "cdate": 1,
        "ddate": 1,
        "mdate": 1,
        "tcdate": 1,
        "tmdate": 1,
        "readers": [
          "text"
        ],
        "nonreaders": [
          "text"
        ],
        "writers": [
          "text"
        ],
        "signatures": [
          "text"
        ],
        "tauthor": "text",
        "domain": "text",
        "details": "[Circular Reference]"
      },
      "message": {
        "signature": "text",
        "replyTo": "text",
        "useJob": true,
        "parentGroup": "text",
        "sendAt": 1,
        "subject": "text",
        "message": "text",
        "groups": [
          "text"
        ],
        "ignoreGroups": [
          "text"
        ],
        "fromEmail": "text",
        "fromName": "text"
      },
      "edit": "[Circular Reference]",
      "tcdate": 1,
      "tmdate": 1,
      "cdate": 1,
      "mdate": 1,
      "ddate": 1,
      "duedate": 1,
      "expdate": 1,
      "responseArchiveDate": 1,
      "details": {
        "writable": true,
        "replytoNote": "[Circular Reference]",
        "repliedNotes": "[Circular Reference]",
        "repliedEdits": "[Circular Reference]",
        "repliedTags": "[Circular Reference]",
        "repliedEdges": [],
        "writableWith": "[Circular Reference]"
      },
      "maxReplies": 1,
      "minReplies": 1,
      "taskCompletionCount": 1,
      "replyForumViews": [
        {
          "id": "text",
          "label": "text",
          "filter": "text",
          "sort": "text",
          "nesting": 1,
          "allowedInvitations": [
            "text"
          ],
          "expandedInvitations": [
            "text"
          ],
          "live": true,
          "layout": "text",
          "message": "text"
        }
      ],
      "preprocess": "text",
      "process": "text",
      "dateprocesses": [
        {
          "script": "text",
          "delay": 1,
          "dates": [
            1
          ],
          "startDate": 1,
          "endDate": 1,
          "cron": "text"
        }
      ],
      "web": "text",
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "writers": [
        "text"
      ],
      "signatures": [
        "text"
      ],
      "invitees": [
        "text"
      ],
      "noninvitees": [
        "text"
      ]
    },
    "writable": true
  },
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatures": [
    "text"
  ],
  "tauthor": "text",
  "domain": "text",
  "replacement": true
}

Invitation Edit response

get

Returns Invitations

Authorizations

Query parameters

idstring · min: 1optional

Invitation id

idsany ofoptional

Invitation ids

invitationstring · min: 1optional

Invitation used to validate this invitation.

prefixstring · min: 1optional

Invitation id prefix

domainstring · min: 1optional

Invitation domain

typestring · enumoptional

Invitation type

Options: note, notes, tag, tags, edge, edges, group, groups, invitation, invitations, meta, all

replyForumstring · min: 1optional

Note id

replyInvitationstring · min: 1optional

Invitation id

minduedateintegeroptional

minimum due date of the Invitation

inviteeany ofoptional

invitee id

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

sortstring · min: 1optional

Sort returned Invitations by field.

limitinteger · min: 1optional

Maximum number of results to return.

offsetintegeroptional

Offset of the result shown.

afterstring · min: 1optional

Return documents that come after the after parameter. After should be an id.

cachebooleanoptional

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

domainstring · min: 1optional

Domain the Invitations belong to to filter transitive members.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

{
  "count": 1,
  "invitations": [],
  "fromCache": true
}

Invitation response

get

Find tags by different filters

Authorizations

Query parameters

idstringoptional

Tag id

idsany ofoptional

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

Maximum number of results to return.

offsetintegeroptional

Offset of the result shown.

afterstring · min: 1optional

Return documents that come after the after parameter. After should be an id.

domainstring · min: 1optional

Domain the Tags belong to to filter transitive members.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

{
  "count": 1,
  "tags": [],
  "fromCache": true
}

Tag response

post

Create or edit a Tag

Authorizations

Body

idany ofoptional

invitationstring · min: 1optional

forumany ofrequired

replytoany ofoptional

tagany ofrequired

cdateany ofoptional

ddateany ofoptional

mdateany ofoptional

tcdateinteger · max: 9999999999999optional

tmdateinteger · max: 9999999999999optional

readersany ofoptional

nonreadersany ofoptional

writersany ofoptional

signaturesany ofrequired

tauthorstring · min: 1optional

domainstring · min: 1optional

detailsobjectoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api2.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",
  "replyto": "text",
  "tag": "text",
  "cdate": 1,
  "ddate": 1,
  "mdate": 1,
  "tcdate": 1,
  "tmdate": 1,
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatures": [
    "text"
  ],
  "tauthor": "text",
  "domain": "text",
  "details": {
    "forumContent": {
      "id": "text",
      "invitations": [
        "text"
      ],
      "number": 1,
      "domain": "text",
      "forum": "text",
      "replyto": "text",
      "content": {
        "ANY_ADDITIONAL_PROPERTY": {
          "description": "text",
          "order": 1,
          "delete": true,
          "value": "text",
          "readers": {}
        }
      },
      "tcdate": 1,
      "tmdate": 1,
      "cdate": 1,
      "pdate": 1,
      "odate": 1,
      "ddate": 1,
      "mdate": 1,
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "writers": [
        "text"
      ],
      "signatures": [
        "text"
      ],
      "forumContent": {
        "ANY_ADDITIONAL_PROPERTY": {
          "description": "text",
          "order": 1,
          "delete": true,
          "value": "text",
          "readers": {}
        }
      },
      "license": "text",
      "version": 1,
      "details": "[Circular Reference]"
    }
  }
}

Tag response

get

Find messages by different filters

Authorizations

Query parameters

idstring · min: 1optional

Message id.

jobIdstring · min: 1optional

Job id used to send Messages.

tostring · min: 1optional

Email address of the recipient.

transitiveMembersbooleanoptional

Whether to include transitive members of the group in the to field.

subjectstring · min: 1optional

Subject of the Message.

parentGroupstring · min: 1optional

Parent Group the recipients belongs to.

statusany ofoptional

Status of the message.

tauthorstring · min: 1optional

Email of the author of the message.

viewedbooleanoptional

Whether the message has been viewed.

limitintegeroptional

Maximum number of results to return.

offsetintegeroptional

Offset of the result shown.

afterstring · min: 1optional

Return documents that come after the after parameter. After should be an id.

cachebooleanoptional

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://api2.openreview.net/messages'

200

default

200

{
  "count": 1,
  "messages": []
}

message response

post

Create a direct message

Authorizations

Body

fromNamestringoptional

Name of the sender.

fromEmailstringoptional

Email of the sender.

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.

parentGroupstring | nullableoptional

Parent group that the groups belong to.

invitationstringoptional

Invitation used to validate message

signaturestringoptional

Signature of the message.

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.

fromobject | nullableoptional

Email address the message is sent from.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api2.openreview.net/messages' \
  --header 'Content-Type: application/json' \
  --data '{
    "fromName": "text",
    "fromEmail": "text",
    "subject": "text",
    "message": "text",
    "groups": [
      "text"
    ],
    "ignoreGroups": [
      "text"
    ],
    "parentGroup": "text",
    "invitation": "text",
    "signature": "text",
    "sendAt": 1,
    "replyTo": "text",
    "useJob": true,
    "from": {
      "name": "text",
      "email": "text"
    }
  }'

200

default

200

{
  "groups": [
    {
      "id": "text",
      "message": {
        "id": "text",
        "signature": "text",
        "invitation": "text",
        "domain": "text",
        "delivered": true,
        "requestId": "text",
        "cdate": 1,
        "vdate": 1,
        "tvdate": 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": [
          {}
        ],
        "jobId": "text"
      },
      "messages": [],
      "jobId": "text",
      "status": "text"
    }
  ],
  "status": "text",
  "jobId": "text"
}

message response

get

Find messages by different filters

Authorizations

Query parameters

idstring · min: 1optional

Message id.

jobIdstring · min: 1optional

Job id used to send Messages.

invitationstring · min: 1optional

Message invitation.

domainstring · min: 1optional

Message domain.

subjectstring · min: 1optional

Subject of the Message.

parentGroupstring · min: 1optional

Parent Group the recipients belongs to.

tauthorstring · min: 1optional

Email of the author of the message.

limitintegeroptional

Maximum number of results to return.

offsetintegeroptional

Offset of the result shown.

afterstring · min: 1optional

Return documents that come after the after parameter. After should be an id.

cachebooleanoptional

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://api2.openreview.net/messages/requests'

200

default

200

{
  "count": 1,
  "requests": []
}

message response

post

Create a direct message

Authorizations

Body

signaturestring · min: 1optional

Signature of the message.

fromNamestringoptional

Name of the sender.

fromEmailstringoptional

Email of the sender.

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.

parentGroupstring | nullableoptional

Parent group that the groups belong to.

invitationstringrequired

Invitation used to validate message

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.

fromobject | nullableoptional

Email address the message is sent from.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api2.openreview.net/messages/requests' \
  --header 'Content-Type: application/json' \
  --data '{
    "signature": "text",
    "fromName": "text",
    "fromEmail": "text",
    "subject": "text",
    "message": "text",
    "groups": [
      "text"
    ],
    "ignoreGroups": [
      "text"
    ],
    "parentGroup": "text",
    "invitation": "text",
    "sendAt": 1,
    "replyTo": "text",
    "useJob": true,
    "from": {
      "name": "text",
      "email": "text"
    }
  }'

200

default

200

{
  "id": "text",
  "signature": "text",
  "invitation": "text",
  "domain": "text",
  "replyTo": "text",
  "useJob": true,
  "jobId": "text",
  "parentGroup": "text",
  "sendAt": 1,
  "subject": "text",
  "message": "text",
  "groups": [
    "text"
  ],
  "ignoreGroups": [
    "text"
  ],
  "fromEmail": "text",
  "fromName": "text",
  "tauthor": "text"
}

message response

post

Mark a message as viewed

Authorizations

Body

idsstring[]required

Message ids to mark as viewed.

vdateinteger | nullablerequired

Viewed date in milliseconds.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api2.openreview.net/messages/viewed' \
  --header 'Content-Type: application/json' \
  --data '{
    "ids": [
      "text"
    ],
    "vdate": 1
  }'

200

default

200

{
  "status": "text"
}

Mark as viewed response

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.

minsdateintegeroptional

Minimum start date in milliseconds.

limitinteger · default: 1000optional

Maximum number of results to return.

offsetintegeroptional

Offset of the result shown.

afterstring · min: 1optional

Return documents that come after the after parameter. After should be an id.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

{
  "count": 1,
  "logs": []
}

log response