OpenAPI definition

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
200
An object containing the assigned token and the OpenReview Profile.
application/json
post
POST /login HTTP/1.1
Host: api.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "id": "text",
  "password": "text",
  "expiresIn": 1
}
200

An object containing the assigned token and the OpenReview Profile.

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

Register a new user

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

Email that will be used to log in to OpenReview.

passwordstringOptional
idstringOptional

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

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

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

The Profile that is saved to the database.

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

Activate a user

Authorizations
Path parameters
tokenstringRequired

activation token

Body
preferredEmailstringOptional
genderstringOptional
homepagestringOptional
dblpstringOptional
gscholarstringOptional
wikipediastringOptional
linkedinstringOptional
orcidstringOptional
emailsstring[]Optional
Responses
200
user token
application/json
put
PUT /activate/{token} HTTP/1.1
Host: api.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 484

{
  "preferredEmail": "text",
  "gender": "text",
  "homepage": "text",
  "dblp": "text",
  "gscholar": "text",
  "wikipedia": "text",
  "linkedin": "text",
  "orcid": "text",
  "names": [
    {
      "preferred": true,
      "first": "text",
      "middle": "text",
      "last": "text",
      "username": "text"
    }
  ],
  "emails": [
    "text"
  ],
  "history": [
    {
      "position": "text",
      "institution": {
        "name": "text",
        "domain": "text"
      },
      "start": 1,
      "end": 1
    }
  ],
  "relations": [
    {
      "relation": "text",
      "name": "text",
      "email": "text",
      "start": 1,
      "end": 1
    }
  ],
  "expertise": [
    {
      "keywords": [
        "text"
      ],
      "start": 1,
      "end": 1
    }
  ]
}
200

user token

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

Activate a user

Authorizations
Path parameters
tokenstringRequired

activation token

Responses
200
user token
application/json
put
PUT /activatelink/{token} HTTP/1.1
Host: api.openreview.net
Accept: */*
200

user token

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

Check if a user is activatable

Authorizations
Path parameters
tokenstringRequired

activation token

Responses
200
user token
application/json
get
GET /activatable/{token} HTTP/1.1
Host: api.openreview.net
Accept: */*
200

user token

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

Check if a user is activatable

Authorizations
Body
idstring · min: 1 · max: 254Required
Responses
200
user token
application/json
post
POST /activatable HTTP/1.1
Host: api.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "id": "text"
}
200

user token

{
  "id": "text"
}
put

Reset a user password

Authorizations
Path parameters
tokenstringRequired

reset token

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

{
  "password": "text"
}
200

User is logged in after the password is reset.

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

Logout a user

Authorizations
Responses
200
Empty object
application/json
Responseobject
post
POST /logout HTTP/1.1
Host: api.openreview.net
Accept: */*
200

Empty object

{}
get

Check if a user is resettable

Authorizations
Path parameters
tokenstringRequired

reset token

Responses
200
user token
application/json
get
GET /resettable/{token} HTTP/1.1
Host: api.openreview.net
Accept: */*
200

user token

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

Check if a user is resettable

Authorizations
Body
idstring · min: 1 · max: 254Required
Responses
200
Group
application/json
post
POST /resettable HTTP/1.1
Host: api.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "id": "text"
}
200

Group

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

Impersonate a user

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

{
  "groupId": "text"
}
200

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

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

Gets the next available OpenReview username for the passed names.

Authorizations
Query parameters
firststringOptional

first name

middlestringOptional

middle name

laststringOptional

last name

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

Next available tilde username

{
  "username": "text"
}
post

Confirm a new email

Authorizations
Body
usernamestring · min: 1Required
alternatestring · min: 1 · max: 254Required
Responses
200
user email
application/json
post
POST /user/confirm HTTP/1.1
Host: api.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "username": "text",
  "alternate": "text"
}
200

user email

{
  "alternate": "text"
}
get

Download an attachment

Authorizations
Query parameters
idstringRequired

Note id that contains the attachment.

namestringRequired

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

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

Attachment

No content
put

Upload an attachment

Authorizations
Body
filestring · binaryRequired
namestring · min: 1Required

Attachment field name. This is usually pdf or supplementary_material.

invitationIdstring · min: 1Required

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

Responses
200
Path to the attachment.
application/json
put
PUT /attachment HTTP/1.1
Host: api.openreview.net
Content-Type: multipart/form-data
Accept: */*
Content-Length: 53

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

Path to the attachment.

{
  "url": "text"
}
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
200
Path to the attachment.
application/json
Responseany of
or
put
PUT /attachment/chunk HTTP/1.1
Host: api.openreview.net
Content-Type: multipart/form-data
Accept: */*
Content-Length: 108

{
  "file": "binary",
  "name": "text",
  "invitationId": "text",
  "clientUploadId": "text",
  "chunkIndex": 1,
  "totalChunks": 1
}
200

Path to the attachment.

{
  "url": "text"
}
get

Download a PDF

Authorizations
Query parameters
idstring · min: 1Required

Note id that contains the PDF.

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

PDF

No content
get

Get a PDF

Authorizations
Path parameters
idstringRequired

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

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

pdf

No content
get

Compare PDFs

Authorizations
Query parameters
noteIdstringRequired

Note id

leftIdstringRequired

Edit id

rightIdstringRequired

Edit id

fieldstringOptional

field to compare

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

pdf comparison

No content
get

Get edges

Authorizations
Query parameters
idstring · min: 1Optional

Edge id

limitinteger · min: 1Optional

Maximum number of results to return.

offsetintegerOptional

Offset of the result shown.

sortstring · min: 1Optional

Sort returned Edges by field.

invitationstring · min: 1Optional

Invitation id used to create the Edge(s).

headstring · min: 1Optional

head value of the Edge(s).

tailstring · min: 1Optional

tail value of the Edge(s).

labelstring · 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.

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

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

Example: head,tail
cachebooleanOptional

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

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

edges

[]
post

Create an edge

Authorizations
Body
idstring · min: 1Optional
invitationstring · min: 1Required
headstring · min: 1Required
tailstring · min: 1Required
labelstringOptional
weightany ofOptional
numberOptional
or
ddateany ofOptional
integerOptional
or
readersany ofOptional
string[]Optional
or
nonreadersany ofOptional
string[]Optional
or
writersany ofOptional
string[]Optional
or
signaturesstring[] · min: 1Optional
Responses
200
Edge
application/json
post
POST /edges HTTP/1.1
Host: api.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 179

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

Edge

{
  "id": "text",
  "invitation": "text",
  "head": "text",
  "tail": "text",
  "label": "text",
  "weight": 1,
  "ddate": 1,
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatures": [
    "text"
  ]
}
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.

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

edges

{
  "count": 1
}
get

Get user profiles

Authorizations
Query parameters
idstring · min: 1Optional

Profile id

Pattern: ^~.*\d+$
idsany ofOptional

Profile ids

stringOptional
or
string[]Optional
emailstring · min: 1Optional

Email associated with the Profile.

emailsany ofOptional

Email(s) associated with the Profile.

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

Confirmed email associated with the Profile.

confirmedEmailsany ofOptional

Confirmed email(s) associated with the Profile.

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

First name associated with the Profile.

middlestring | nullableOptional

Middle name associated with the Profile.

laststring · min: 1Optional

Last name associated with the Profile.

termstring · min: 1Optional

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

groupstring · min: 1Optional

Group id where to get all the member profiles.

trashbooleanOptional

Whether to include deleted profiles.

withBlockedbooleanOptional

Whether to include blocked profiles.

needsModerationbooleanOptional

Whether to return Profiles that need moderation.

selectstring · min: 1Optional

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

Example: id,content.names,content.emails
statestring · enumOptional

State of the Profile.

Possible values:
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
200
Profile response
application/json
get
GET /profiles HTTP/1.1
Host: api.openreview.net
Accept: */*
200

Profile response

[]
post

Save user Profile

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

{
  "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",
    "orcid": "text",
    "semanticScholar": "text",
    "names": [
      {
        "preferred": true,
        "first": "text",
        "middle": "text",
        "last": "text",
        "username": "text"
      }
    ],
    "emails": [
      "text"
    ],
    "emailsConfirmed": [
      "text"
    ],
    "history": [
      {
        "position": "text",
        "institution": {
          "name": "text",
          "domain": "text"
        },
        "start": 1,
        "end": 1
      }
    ],
    "relations": [
      {
        "relation": "text",
        "name": "text",
        "email": "text",
        "start": 1,
        "end": 1,
        "readers": [
          "text"
        ]
      }
    ],
    "expertise": [
      {
        "keywords": [
          "text"
        ],
        "start": 1,
        "end": 1
      }
    ]
  },
  "metaContent": {
    "preferredEmail": {
      "values": [
        "text"
      ],
      "weights": [
        1
      ],
      "signatures": [
        "text"
      ]
    },
    "gender": {
      "values": [
        "text"
      ],
      "weights": [
        1
      ],
      "signatures": [
        "text"
      ]
    },
    "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"
      ]
    },
    "orcid": {
      "values": [
        "text"
      ],
      "weights": [
        1
      ],
      "signatures": [
        "text"
      ]
    },
    "semanticScholar": {
      "values": [
        "text"
      ],
      "weights": [
        1
      ],
      "signatures": [
        "text"
      ]
    },
    "names": {
      "values": [
        {
          "first": "text",
          "middle": "text",
          "last": "text",
          "username": "text",
          "preferred": true
        }
      ],
      "weights": [
        1
      ]
    },
    "emails": {
      "values": [
        "text"
      ],
      "weights": [
        1
      ]
    },
    "history": [
      {
        "values": [
          {}
        ],
        "weights": [
          1
        ]
      }
    ],
    "relations": {
      "values": [
        {
          "name": "text",
          "email": "text",
          "relation": "text",
          "start": 1,
          "end": 1,
          "readers": [
            "text"
          ]
        }
      ],
      "weights": [
        1
      ]
    },
    "expertise": [
      {
        "values": [
          {}
        ],
        "weights": [
          1
        ]
      }
    ]
  },
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatures": [
    "text"
  ]
}
200

Profile response

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

Get user profiles

Authorizations
Query parameters
idstring · min: 1Optional

Profile id

Pattern: ^~.*\d+$
idsany ofOptional

Profile ids

stringOptional
or
string[]Optional
emailstring · min: 1Optional

Email associated with the Profile.

emailsany ofOptional

Email(s) associated with the Profile.

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

Confirmed email associated with the Profile.

confirmedEmailsany ofOptional

Confirmed email(s) associated with the Profile.

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

First name associated with the Profile.

middlestring | nullableOptional

Middle name associated with the Profile.

laststring · min: 1Optional

Last name associated with the Profile.

termstring · min: 1Optional

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

groupstring · min: 1Optional

Group id where to get all the member profiles.

trashbooleanOptional

Whether to include deleted profiles.

withBlockedbooleanOptional

Whether to include blocked profiles.

needsModerationbooleanOptional

Whether to return Profiles that need moderation.

selectstring · min: 1Optional

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

Example: id,content.names,content.emails
statestring · enumOptional

State of the Profile.

Possible values:
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
200
Profile response
application/json
get
GET /profiles/search HTTP/1.1
Host: api.openreview.net
Accept: */*
200

Profile response

[]
get

Returns groups

Authorizations
Query parameters
idstring · min: 1Optional

Group id.

idsany ofOptional

Group ids.

stringOptional
or
string[]Optional
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.

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.

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

[]
get

Returns all the Group Edits by filter.

Authorizations
Query parameters
idstring · min: 1Optional

Edit id.

idsany ofOptional

Edit ids.

stringOptional
or
string[]Optional
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.

stringOptional
or
string[]Optional
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.

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

[]
post

Create or edit a Group Edit

Authorizations
Body
idstring · min: 1Optional
invitationstring · min: 1Optional
tauthorstring · min: 1Optional
contentobjectOptional
cdateany ofOptional
integer · min: 1Optional
or
ddateany ofOptional
integerOptional
or
mdateany ofOptional
integerOptional
or
readersany ofOptional
string[]Optional
or
nonreadersany ofOptional
string[]Optional
or
writersany ofOptional
string[]Optional
or
signaturesstring[]Optional
replacementbooleanOptional
Responses
200
Group Edit response
application/json
post
POST /groups/edits HTTP/1.1
Host: api.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 406

{
  "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",
    "tcdate": 1,
    "tmdate": 1,
    "tauthor": "text",
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatories": [
      "text"
    ],
    "signatures": [
      "text"
    ],
    "members": [
      "text"
    ],
    "host": "text",
    "web": "text"
  }
}
{
  "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",
    "tcdate": 1,
    "tmdate": 1,
    "tauthor": "text",
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatories": [
      "text"
    ],
    "signatures": [
      "text"
    ],
    "members": [
      "text"
    ],
    "host": "text",
    "web": "text"
  }
}
get

Returns all the Note Edits by filter.

Authorizations
Query parameters
idstring · min: 1Optional

Edit id.

idsany ofOptional

Edit ids.

stringOptional
or
string[]Optional
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
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.

stringOptional
or
string[]Optional
originalany ofOptional

get Edits that are originals

booleanOptional
or
string · min: 1Optional
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, presentation, 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.

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

[]
post

Create or edit a Note Edit

Authorizations
Body
idstring · min: 1Optional
invitationstring · min: 1Optional
tauthorstring · min: 1Optional
contentobjectOptional
cdateany ofOptional
integer · min: 1Optional
or
ddateany ofOptional
integerOptional
or
mdateany ofOptional
integerOptional
or
readersany ofOptional
string[]Optional
or
nonreadersany ofOptional
string[]Optional
or
writersany ofOptional
string[]Optional
or
signaturesstring[]Optional
replacementbooleanOptional
Responses
200
Note Edit response
application/json
post
POST /notes/edits HTTP/1.1
Host: api.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 382

{
  "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",
    "content": {},
    "cdate": 1,
    "pdate": 1,
    "ddate": 1,
    "mdate": 1,
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatures": [
      "text"
    ]
  }
}
{
  "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",
    "content": {},
    "cdate": 1,
    "pdate": 1,
    "ddate": 1,
    "mdate": 1,
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatures": [
      "text"
    ]
  }
}
get

Returns all the Notes by filter.

Authorizations
Query parameters
idstring · min: 1Optional

Note id.

idsany ofOptional

Note ids.

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

Invitation id used to create the Note(s).

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

Invitation ids.

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

Reference referent.

forumany ofOptional

Note id of the forum field.

stringOptional
or
string[]Optional
replytoany ofOptional

Note id of the replyto field.

stringOptional
or
string[]Optional
numberany ofOptional

Note number.

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

Note title.

content.confidencestring · min: 1Optional

Note content confidence field value.

content.strengthsstring · min: 1Optional

Note content strengths field value.

content.weaknessesstring · min: 1Optional

Note content weaknesses field value.

content.decisionstring · min: 1Optional

Note content decision field value.

content.certificationsstring · min: 1Optional

Note content certification field values.

content.previous_URLstring · min: 1Optional

Note content previous_URL field value.

content.userstring · min: 1Optional

User email in recruitment.

content.responsestring · min: 1Optional

User response in recruitment.

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

Note venue.

content.venueidstring · min: 1Optional

Note venueid.

content.venue_idstring · min: 1Optional

Note venue_id.

content.presentation_typestring · min: 1Optional

Presentation Type.

content.sessionsstring · min: 1Optional

Sessions.

content.trackstring · min: 1Optional

Track.

content.authoridsany ofOptional

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

stringOptionalExample: ~Andrew_McCallum1
or
string[]Optional
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.

stringOptional
or
string[]Optional
originalany ofOptional

get Notes that are originals

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

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

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

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

Example: all
inviteebooleanOptional

invitee

mintcdateintegerOptional

minimum creation 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.

cachebooleanOptional

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

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

[]

Search Notes

Authorizations
Query parameters
querystring · min: 1Optional

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

termstring · min: 1Optional

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

typestring · enumOptional

Search type

Possible values:
contentstring · min: 1Optional

Fields inside content to look for the term.

Default: all
groupstring · min: 1Optional

Group that the Invitation belongs to

sourcestring · enumOptional

Source of the Note

Default: allPossible values:
invitationstring · min: 1Optional

Invitation id used to create the Note(s).

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

Venue of the Note

venueidstring · min: 1Optional

Venue id of the Note

sortstring · min: 1Optional

Sort returned Notes by field.

Example: tmdate:desc
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.

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

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

Get a reference attachment

Authorizations
Query parameters
idstringRequired

Note id

namestringRequired

attachment field name

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

attachment

No content
get

Returns Invitation Edits

Authorizations
Query parameters
idstring · min: 1Optional

Edit id.

idsany ofOptional

Edit ids.

stringOptional
or
string[]Optional
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.

stringOptional
or
string[]Optional
originalany ofOptional

get Edits that are originals

booleanOptional
or
string · min: 1Optional
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.

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.

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

[]
post

Create or edit a Invitation Edit

Authorizations
Body
idstring · min: 1Optional
invitationsstring · min: 1Optional
replacementboolean · enumOptionalPossible values:
contentobjectOptional
cdateany ofOptional
integerOptional
or
readersany ofOptional
string[]Optional
or
nonreadersany ofOptional
string[]Optional
or
writersany ofOptional
string[]Optional
or
signaturesstring[]Optional
Responses
200
Invitation Edit response
application/json
post
POST /invitations/edits HTTP/1.1
Host: api.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 1986

{
  "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,
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "writers": [
        "text"
      ],
      "signatures": [
        "text"
      ]
    },
    "tag": {
      "id": "text",
      "invitation": "text",
      "forum": "text",
      "replyto": "text",
      "tag": "text",
      "cdate": 1,
      "ddate": 1,
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "signatures": [
        "text"
      ]
    },
    "edit": {
      "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,
          "readers": [
            "text"
          ],
          "nonreaders": [
            "text"
          ],
          "writers": [
            "text"
          ],
          "signatures": [
            "text"
          ]
        },
        "tag": {
          "id": "text",
          "invitation": "text",
          "forum": "text",
          "replyto": "text",
          "tag": "text",
          "cdate": 1,
          "ddate": 1,
          "readers": [
            "text"
          ],
          "nonreaders": [
            "text"
          ],
          "signatures": [
            "text"
          ]
        },
        "edit": "[Circular Reference]",
        "bulk": true,
        "content": {},
        "cdate": 1,
        "ddate": 1,
        "duedate": 1,
        "expdate": 1,
        "maxReplies": 1,
        "minReplies": 1,
        "taskCompletionCount": 1,
        "replyForumViews": [
          {
            "id": "text",
            "label": "text",
            "filter": "text",
            "layout": 1,
            "sort": "text"
          }
        ],
        "preprocess": "text",
        "process": "text",
        "dateprocesses": [
          {
            "script": "text",
            "delay": 1
          }
        ],
        "web": "text",
        "readers": [
          "text"
        ],
        "nonreaders": [
          "text"
        ],
        "writers": [
          "text"
        ],
        "signatures": [
          "text"
        ],
        "invitees": [
          "text"
        ],
        "noninvitees": [
          "text"
        ]
      },
      "cdate": 1,
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "writers": [
        "text"
      ],
      "signatures": [
        "text"
      ]
    },
    "bulk": true,
    "content": {},
    "cdate": 1,
    "ddate": 1,
    "duedate": 1,
    "expdate": 1,
    "maxReplies": 1,
    "minReplies": 1,
    "taskCompletionCount": 1,
    "replyForumViews": [
      {
        "id": "text",
        "label": "text",
        "filter": "text",
        "layout": 1,
        "sort": "text"
      }
    ],
    "preprocess": "text",
    "process": "text",
    "dateprocesses": [
      {
        "script": "text",
        "delay": 1
      }
    ],
    "web": "text",
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatures": [
      "text"
    ],
    "invitees": [
      "text"
    ],
    "noninvitees": [
      "text"
    ]
  },
  "cdate": 1,
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatures": [
    "text"
  ]
}
{
  "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,
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "writers": [
        "text"
      ],
      "signatures": [
        "text"
      ]
    },
    "tag": {
      "id": "text",
      "invitation": "text",
      "forum": "text",
      "replyto": "text",
      "tag": "text",
      "cdate": 1,
      "ddate": 1,
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "signatures": [
        "text"
      ]
    },
    "edit": {
      "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,
          "readers": [
            "text"
          ],
          "nonreaders": [
            "text"
          ],
          "writers": [
            "text"
          ],
          "signatures": [
            "text"
          ]
        },
        "tag": {
          "id": "text",
          "invitation": "text",
          "forum": "text",
          "replyto": "text",
          "tag": "text",
          "cdate": 1,
          "ddate": 1,
          "readers": [
            "text"
          ],
          "nonreaders": [
            "text"
          ],
          "signatures": [
            "text"
          ]
        },
        "edit": "[Circular Reference]",
        "bulk": true,
        "content": {},
        "cdate": 1,
        "ddate": 1,
        "duedate": 1,
        "expdate": 1,
        "maxReplies": 1,
        "minReplies": 1,
        "taskCompletionCount": 1,
        "replyForumViews": [
          {
            "id": "text",
            "label": "text",
            "filter": "text",
            "layout": 1,
            "sort": "text"
          }
        ],
        "preprocess": "text",
        "process": "text",
        "dateprocesses": [
          {
            "script": "text",
            "delay": 1
          }
        ],
        "web": "text",
        "readers": [
          "text"
        ],
        "nonreaders": [
          "text"
        ],
        "writers": [
          "text"
        ],
        "signatures": [
          "text"
        ],
        "invitees": [
          "text"
        ],
        "noninvitees": [
          "text"
        ]
      },
      "cdate": 1,
      "readers": [
        "text"
      ],
      "nonreaders": [
        "text"
      ],
      "writers": [
        "text"
      ],
      "signatures": [
        "text"
      ]
    },
    "bulk": true,
    "content": {},
    "cdate": 1,
    "ddate": 1,
    "duedate": 1,
    "expdate": 1,
    "maxReplies": 1,
    "minReplies": 1,
    "taskCompletionCount": 1,
    "replyForumViews": [
      {
        "id": "text",
        "label": "text",
        "filter": "text",
        "layout": 1,
        "sort": "text"
      }
    ],
    "preprocess": "text",
    "process": "text",
    "dateprocesses": [
      {
        "script": "text",
        "delay": 1
      }
    ],
    "web": "text",
    "readers": [
      "text"
    ],
    "nonreaders": [
      "text"
    ],
    "writers": [
      "text"
    ],
    "signatures": [
      "text"
    ],
    "invitees": [
      "text"
    ],
    "noninvitees": [
      "text"
    ]
  },
  "cdate": 1,
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "writers": [
    "text"
  ],
  "signatures": [
    "text"
  ]
}
get

Returns Invitations

Authorizations
Query parameters
idstring · min: 1Optional

Invitation id

idsany ofOptional

Invitation ids

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

Invitation used to validate this invitation.

prefixstring · min: 1Optional

Invitation id prefix

domainstring · min: 1Optional

Invitation domain

typestring · enumOptional

Invitation type

Possible values:
replyForumstring · min: 1Optional

Note id

replyInvitationstring · min: 1Optional

Invitation id

minduedateintegerOptional

minimum due date of the Invitation

inviteeany ofOptional

invitee id

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

Invitation signature

replytobooleanOptional

Invitations should have replyto field

duedatebooleanOptional

Invitations should have due date

pastduebooleanOptional

Invitations should be past due

expiredbooleanOptional

Invitations should be expired

selectstring · min: 1Optional

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

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

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

tagsbooleanOptionalDeprecated

Get only Tag Invitations

edgesbooleanOptionalDeprecated

Get only edge Invitations

notesbooleanOptionalDeprecated

Get only Note Invitations

sortstring · min: 1Optional

Sort returned Invitations 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
200
Invitation response
application/json
get
GET /invitations HTTP/1.1
Host: api.openreview.net
Accept: */*

[]
get

Find tags by different filters

Authorizations
Query parameters
idstringOptional

Tag id

idsany ofOptional

Tag ids

string · min: 1Optional
or
string[] · min: 1Optional
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.

limitintegerOptional

Maximum number of results to return.

Default: 1000
offsetintegerOptional

Offset of the result shown.

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

[]
post

Create or edit a Tag

Authorizations
Body
idstring · min: 1Optional
invitationstring · min: 1Required
forumstring · min: 1Required
replytoany ofOptional
string · min: 1Optional
or
tagstringRequired
cdateany ofOptional
integerOptional
or
ddateany ofOptional
integerOptional
or
readersany ofOptional
string[]Optional
or
nonreadersany ofOptional
string[]Optional
or
signaturesstring[] · min: 1Required
Responses
200
Tag response
application/json
post
POST /tags HTTP/1.1
Host: api.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 149

{
  "invitation": "ICLR.cc/2018/Conference/-/Add_Bid",
  "forum": "SJeI6e62XQ",
  "tag": "I want to review",
  "readers": [
    "everyone"
  ],
  "signatures": [
    "~Super_User1"
  ]
}
{
  "id": "text",
  "invitation": "text",
  "forum": "text",
  "replyto": "text",
  "tag": "text",
  "cdate": 1,
  "ddate": 1,
  "readers": [
    "text"
  ],
  "nonreaders": [
    "text"
  ],
  "signatures": [
    "text"
  ]
}
get

Find messages by different filters

Authorizations
Query parameters
idstring · min: 1Optional

Message id.

tostring · min: 1Optional

Email address of the recipient.

subjectstring · min: 1Optional

Subject of the Message.

parentGroupstring · min: 1Optional

Parent Group the recipient belongs to.

statusany ofOptional

Status of the message.

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

Email of the author of the message.

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.

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

[]
post

Create a direct message

Authorizations
Body
subjectstringRequired

Subject of the message.

messagestringRequired

Message body.

groupsstring[] · min: 1Required

Groups the message is sent to.

ignoreGroupsstring[] | nullableOptional

Groups the message should not be sent to.

Default: []
parentGroupstring | nullableOptional

Parent group that the groups belong to.

sendAtinteger | nullableOptional

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

replyTostring | nullableOptional

Email address the recipient should replyto.

useJobboolean | nullableOptional

Whether to wait for messages to be sent.

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

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

Last updated

Was this helpful?

#141: add registration stage info

Change request updated