OpenAPI definition
You can find the definition online here: https://api2.openreview.net/docs/api.yml
put
Activate a user
Authorizations
Path parameters
tokenstringRequired
activation token
Body
Responses
200
user token
application/json
put
PUT /activate/{token} HTTP/1.1
Host: api2.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 733
{
"content": {
"yearOfBirth": 1,
"preferredEmail": "text",
"gender": "text",
"homepage": "text",
"dblp": "text",
"gscholar": "text",
"wikipedia": "text",
"linkedin": "text",
"semanticScholar": "text",
"aclanthology": "text",
"orcid": "text",
"names": [
{
"preferred": true,
"first": "text",
"middle": "text",
"last": "text",
"fullname": "text",
"username": "text"
}
],
"pronouns": "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
user token
{
"token": "text",
"user": {
"id": "text",
"active": true,
"password": true,
"invitation": "text",
"email": "text",
"confirmedEmails": [
"text"
],
"content": {
"yearOfBirth": 1,
"preferredEmail": "text",
"gender": "text",
"homepage": "text",
"dblp": "text",
"gscholar": "text",
"wikipedia": "text",
"linkedin": "text",
"semanticScholar": "text",
"aclanthology": "text",
"orcid": "text",
"names": [
{
"preferred": true,
"first": "text",
"middle": "text",
"last": "text",
"fullname": "text",
"username": "text"
}
],
"pronouns": "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
}
}post
Moderate a user Profile
Authorizations
Body
idstringRequired
decisionstring · enumRequiredPossible values:
sendMailboolean | nullableOptional
reasonstring | nullableOptional
Responses
200
user token
application/json
400
error
application/json
403
error
application/json
post
POST /profile/moderate HTTP/1.1
Host: api2.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"id": "text",
"decision": "accept",
"sendMail": true,
"reason": "text"
}{
"id": "text",
"active": true,
"password": true,
"invitation": "text",
"email": "text",
"confirmedEmails": [
"text"
],
"content": {
"yearOfBirth": 1,
"preferredEmail": "text",
"gender": "text",
"homepage": "text",
"dblp": "text",
"gscholar": "text",
"wikipedia": "text",
"linkedin": "text",
"semanticScholar": "text",
"aclanthology": "text",
"orcid": "text",
"names": [
{
"preferred": true,
"first": "text",
"middle": "text",
"last": "text",
"fullname": "text",
"username": "text"
}
],
"pronouns": "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
}put
Activate an email
Authorizations
Path parameters
tokenstringRequired
Token used to activate new email
Body
emailstring · min: 1Required
tokenstring · min: 1Required
Responses
200
Confirmed email
application/json
put
PUT /activatelink/{token} HTTP/1.1
Host: api2.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 31
{
"email": "text",
"token": "text"
}200
Confirmed email
{
"confirmedEmail": "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: api2.openreview.net
Accept: */*
200
user token
{
"profile": {
"id": "text",
"active": true,
"password": true,
"invitation": "text",
"email": "text",
"confirmedEmails": [
"text"
],
"content": {
"yearOfBirth": 1,
"preferredEmail": "text",
"gender": "text",
"homepage": "text",
"dblp": "text",
"gscholar": "text",
"wikipedia": "text",
"linkedin": "text",
"semanticScholar": "text",
"aclanthology": "text",
"orcid": "text",
"names": [
{
"preferred": true,
"first": "text",
"middle": "text",
"last": "text",
"fullname": "text",
"username": "text"
}
],
"pronouns": "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": {
"token": "text",
"numericToken": "text",
"groupId": "text",
"action": "text",
"username": "text",
"duplicateProfile": "text"
},
"prefixed_positions": [
"text"
],
"institutions": [
"text"
]
}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: api2.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: api2.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",
"fullname": "text",
"emails": [
"text"
],
"preferredEmail": "text",
"usernames": [
"text"
],
"preferredId": "text",
"state": "Active",
"termsTimestamp": 1
}
}
}post
Logout a user
Authorizations
Responses
200
Empty object
application/json
Responseobject
post
POST /logout HTTP/1.1
Host: api2.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: api2.openreview.net
Accept: */*
200
user token
{
"id": "text",
"instructions": "text",
"description": "text",
"invitations": [
"text"
],
"parentInvitations": "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
}
}post
Refresh a user token
Authorizations
Responses
200
user token
application/json
post
POST /refreshToken HTTP/1.1
Host: api2.openreview.net
Accept: */*
200
user token
{
"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
}
}
}post
Check if a user is resettable
Authorizations
Body
idstring · min: 1 · max: 254Required
tokenstring | nullableOptional
Token from Turnstile that proves that the user is human. This is required for resetting the password.
Responses
200
Group
application/json
post
POST /resettable HTTP/1.1
Host: api2.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 28
{
"id": "text",
"token": "text"
}200
Group
{
"id": "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: api2.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",
"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
}
}
}
}
}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
200
Next available tilde username
application/json
get
GET /tildeusername HTTP/1.1
Host: api2.openreview.net
Accept: */*
200
Next available tilde username
{
"username": "text"
}post
Confirm a new email
Authorizations
Body
usernamestring · min: 1Optional
alternatestring · min: 1 · max: 254Required
Responses
200
user email
application/json
post
POST /user/confirm HTTP/1.1
Host: api2.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
idstring · min: 1Optional
Note id that contains the attachment.
idsany ofOptional
Note ids that contain the attachments.
string · min: 1Optional
string[]Optional
namestring · min: 1Required
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: api2.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: api2.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: api2.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: 1Optional
Note id that contains the PDF.
idsany ofOptional
Note ids that contain the attachments.
string · min: 1Optional
string[]Optional
Responses
200PDF
get
GET /pdf HTTP/1.1
Host: api2.openreview.net
Accept: */*
200PDF
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
200pdf
get
GET /pdf/{id} HTTP/1.1
Host: api2.openreview.net
Accept: */*
200pdf
No content
get
Compare PDFs
Authorizations
Query parameters
noteIdstringRequired
Note id
leftIdstringRequired
Edit id
rightIdstringRequired
Edit id
fieldstringOptionalDefault:
field to compare
pdfResponses
200
pdf comparison
get
GET /pdf/compare HTTP/1.1
Host: api2.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.
countbooleanOptional
Whether to return the count of the edges.
afterstring · min: 1Optional
Return documents that come after the after parameter. After should be an id.
sortstring · min: 1Optional
Sort returned Edges by field.
streambooleanOptional
Whether to use a stream to process results or not.
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_]+string[]Optional
detailsstring · min: 1OptionalExample:
Comma separated values of fields to add to details. Valid values are head, tail, writable and all.
head,tailcachebooleanOptional
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
200
edges
application/json
get
GET /edges HTTP/1.1
Host: api2.openreview.net
Accept: */*
200
edges
{
"edges": [],
"count": 1,
"fromCache": true,
"groupedEdges": [
{
"id": {},
"count": 1,
"values": [
{}
]
}
]
}post
Create an edge
Authorizations
Body
idstring · min: 1Optional
invitationstring · min: 1Optional
headstring · min: 1Required
tailstring · min: 1Required
labelstringOptional
weightnumberOptional
ddateany ofOptional
integer · max: 9999999999999Optional
cdateinteger · max: 9999999999999Optional
tcdateinteger · max: 9999999999999Optional
tmdateinteger · max: 9999999999999Optional
readersstring[]Optional
nonreadersstring[]Optional
writersstring[]Optional
signaturesstring[] · min: 1Optional
tauthorstring · min: 1Optional
domainstring · min: 1Optional
Responses
200
Edge
application/json
post
POST /edges HTTP/1.1
Host: api2.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 244
{
"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
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"
}post
Rename an edge
Authorizations
Body
currentIdstring · min: 1Required
newIdstring · min: 1Required
Responses
200
edge
application/json
post
POST /edges/rename HTTP/1.1
Host: api2.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 35
{
"currentId": "text",
"newId": "text"
}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
200
edges
application/json
get
GET /edges/count HTTP/1.1
Host: api2.openreview.net
Accept: */*
200
edges
{
"count": 1
}get
Get archived edges
Authorizations
Query parameters
invitationstring · min: 1Required
Invitation id used to create the Edge(s).
Responses
200
Archived edges
get
GET /edges/archive HTTP/1.1
Host: api2.openreview.net
Accept: */*
200
Archived edges
No content
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
200
feedback
application/json
put
PUT /feedback HTTP/1.1
Host: api2.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 64
{
"from": "text",
"subject": "text",
"message": "text",
"token": "text"
}200
feedback
{
"status": "text"
}get
Get user profiles
Authorizations
Query parameters
idstring · min: 1OptionalPattern:
Profile id
^~.*\d+$idsany ofOptional
Profile ids
stringOptional
string[]Optional
emailstring · min: 1Optional
Email associated with the Profile.
emailsany ofOptional
Email(s) associated with the Profile.
stringOptional
string[]Optional
confirmedEmailstring · min: 1Optional
Confirmed email associated with the Profile.
confirmedEmailsany ofOptional
Confirmed email(s) associated with the Profile.
stringOptional
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.
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: 1OptionalExample:
Comma separated string with specific fields of the Profile object to return.
id,content.names,content.emailsstatestring · enumOptionalPossible values:
State of the Profile.
sortstring · min: 1Optional
Sort returned Profiles by field.
limitinteger · min: 1Optional
Maximum number of results to return.
offsetintegerOptional
Offset of the result shown.
countbooleanOptional
Whether to return the count of the profiles.
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
200
Profile response
application/json
get
GET /profiles HTTP/1.1
Host: api2.openreview.net
Accept: */*
200
Profile response
{
"profiles": [],
"count": 1,
"fromCache": true
}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: api2.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 2398
{
"id": "text",
"invitation": "text",
"referent": "text",
"tcdate": 1,
"tmdate": 1,
"ddate": 1,
"packaging": {},
"active": true,
"password": true,
"tauthor": "text",
"state": "Active",
"content": {
"yearOfBirth": 1,
"preferredEmail": "text",
"gender": "text",
"homepage": "text",
"dblp": "text",
"gscholar": "text",
"wikipedia": "text",
"linkedin": "text",
"semanticScholar": "text",
"aclanthology": "text",
"orcid": "text",
"names": [
{
"preferred": true,
"first": "text",
"middle": "text",
"last": "text",
"fullname": "text",
"username": "text"
}
],
"pronouns": "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
]
},
"pronouns": {
"values": [
"text"
],
"weights": [
1
],
"signatures": [
"text"
]
},
"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": {
"values": [
{
"keywords": [
"text"
],
"start": 1,
"end": 1
}
],
"weights": [
1
]
}
},
"readers": [
"text"
],
"nonreaders": [
"text"
],
"writers": [
"text"
],
"signatures": [
"text"
]
}200
Profile response
{
"id": "text",
"active": true,
"password": true,
"invitation": "text",
"email": "text",
"confirmedEmails": [
"text"
],
"content": {
"yearOfBirth": 1,
"preferredEmail": "text",
"gender": "text",
"homepage": "text",
"dblp": "text",
"gscholar": "text",
"wikipedia": "text",
"linkedin": "text",
"semanticScholar": "text",
"aclanthology": "text",
"orcid": "text",
"names": [
{
"preferred": true,
"first": "text",
"middle": "text",
"last": "text",
"fullname": "text",
"username": "text"
}
],
"pronouns": "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
}get
Get user profiles
Authorizations
Query parameters
idstring · min: 1OptionalPattern:
Profile id
^~.*\d+$idsany ofOptional
Profile ids
stringOptional
string[]Optional
emailstring · min: 1Optional
Email associated with the Profile.
emailsany ofOptional
Email(s) associated with the Profile.
stringOptional
string[]Optional
confirmedEmailstring · min: 1Optional
Confirmed email associated with the Profile.
confirmedEmailsany ofOptional
Confirmed email(s) associated with the Profile.
stringOptional
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.
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: 1OptionalExample:
Comma separated string with specific fields of the Profile object to return.
id,content.names,content.emailsstatestring · enumOptionalPossible values:
State of the Profile.
sortstring · min: 1Optional
Sort returned Profiles by field.
limitinteger · min: 1Optional
Maximum number of results to return.
offsetintegerOptional
Offset of the result shown.
countbooleanOptional
Whether to return the count of the profiles.
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: api2.openreview.net
Accept: */*
200
Profile response
{
"profiles": [],
"count": 1,
"fromCache": true
}post
Get user profiles
Authorizations
Query parameters
idstring · min: 1OptionalPattern:
Profile id
^~.*\d+$idsany ofOptional
Profile ids
stringOptional
string[]Optional
emailstring · min: 1Optional
Email associated with the Profile.
emailsany ofOptional
Email(s) associated with the Profile.
stringOptional
string[]Optional
confirmedEmailstring · min: 1Optional
Confirmed email associated with the Profile.
confirmedEmailsany ofOptional
Confirmed email(s) associated with the Profile.
stringOptional
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: 1OptionalExample:
Comma separated string with specific fields of the Profile object to return.
id,content.names,content.emailsstatestring · enumOptionalPossible values:
State of the Profile.
sortstring · min: 1Optional
Sort returned Profiles by field.
limitinteger · min: 1Optional
Maximum number of results to return.
offsetintegerOptional
Offset of the result shown.
countbooleanOptional
Whether to return the count of the profiles.
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
200
Profile response
application/json
post
POST /profiles/search HTTP/1.1
Host: api2.openreview.net
Accept: */*
200
Profile response
{
"profiles": [],
"count": 1,
"fromCache": true
}get
Gets profile references
Authorizations
Query parameters
idstring · min: 1Optional
Group id.
idsany ofOptional
Group ids.
stringOptional
string[]Optional
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
200
The Profile that is saved to the database.
application/json
default
Error
application/json
get
GET /references HTTP/1.1
Host: api2.openreview.net
Accept: */*
{
"count": 1,
"references": [],
"fromCache": true
}get
Returns groups
Authorizations
Query parameters
idstring · min: 1Optional
Group id.
idsany ofOptional
Group ids.
stringOptional
string[]Optional
prefixstring · min: 1Optional
Group id prefix.
parentstring · min: 1Optional
Group parent.
invitationstring · min: 1Optional
Invitation id used to create the Group(s).
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: 1OptionalExample:
Comma separated string with specific fields of the Group object to return.
id,membersdetailsstring · min: 1OptionalExample:
Comma separated values of fields to add to details. Valid value is writable.
writablelimitinteger · min: 1Optional
Maximum number of results to return.
offsetintegerOptional
Offset of the result shown.
countbooleanOptional
Whether to return the count of the groups.
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
200
Group response
application/json
default
Error
application/json
get
GET /groups HTTP/1.1
Host: api2.openreview.net
Accept: */*
{
"count": 1,
"groups": [],
"fromCache": true
}put
Adds members to a Group
Authorizations
Body
idstring · min: 1Required
Group id to which memebers will be added.
membersstring[] · min: 1Required
Members to add to the Group.
Responses
200
Group response
application/json
default
Error
application/json
put
PUT /groups/members HTTP/1.1
Host: api2.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 32
{
"id": "text",
"members": [
"text"
]
}{
"id": "text",
"instructions": "text",
"description": "text",
"invitations": [
"text"
],
"parentInvitations": "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
}
}get
Returns all the Group Edits by filter.
Authorizations
Query parameters
idstring · min: 1Optional
Edit id.
idsany ofOptional
Edit ids.
stringOptional
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
string[]Optional
selectstring · min: 1OptionalExample:
Comma separated string with specific fields of the Note Edit object to return.
id,content.title,content.abstractdetailsstring · min: 1OptionalExample:
Comma separated values of fields to add to details. Valid values are writable, invitation, and all
allsortstring · min: 1Optional
Sort returned Edits by field.
limitintegerOptional
Maximum number of results to return.
offsetintegerOptional
Offset of the result shown.
countbooleanOptional
Whether to return the count of the group edits.
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
200
Edit Group response
application/json
default
Error
application/json
get
GET /groups/edits HTTP/1.1
Host: api2.openreview.net
Accept: */*
{
"count": 1,
"edits": [],
"fromCache": true
}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
domainstring · min: 1Optional
Responses
200
Group Edit response
application/json
default
Error
application/json
post
POST /groups/edits HTTP/1.1
Host: api2.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 634
{
"id": "text",
"invitation": "text",
"tauthor": "text",
"content": {},
"cdate": 1,
"ddate": 1,
"mdate": 1,
"readers": [
"text"
],
"nonreaders": [
"text"
],
"writers": [
"text"
],
"signatures": [
"text"
],
"replacement": true,
"domain": "text",
"group": {
"id": "text",
"instructions": "text",
"description": "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
}
}{
"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",
"instructions": "text",
"description": "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",
"instructions": "text",
"description": "text",
"invitations": [
"text"
],
"parentInvitations": "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",
"parentInvitations": "text",
"forum": "text",
"note": "text",
"group": "text",
"edge": "text",
"edit": "text",
"tag": "text",
"profile": "text",
"label": "text",
"weight": 1,
"cdate": 1,
"ddate": 1,
"mdate": 1,
"tcdate": 1,
"tmdate": 1,
"readers": [
"text"
],
"nonreaders": [
"text"
],
"writers": [
"text"
],
"signature": "text",
"tauthor": "text",
"domain": "text",
"details": {
"forumContent": {
"id": "text",
"externalId": "text",
"externalIds": [
"text"
],
"invitations": [
"text"
],
"parentInvitations": "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]"
}
}
},
"message": {
"signature": "text",
"replyTo": "text",
"useJob": true,
"parentGroup": "text",
"sendAt": 1,
"subject": "text",
"message": "text",
"groups": [
"text"
],
"ignoreGroups": [
"text"
],
"fromEmail": "text",
"fromName": "text"
},
"edit": {
"id": "text",
"invitations": "text",
"invitation": {
"id": "text",
"instructions": "text",
"description": "text",
"invitations": [
"text"
],
"parentInvitations": "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",
"parentInvitations": "text",
"forum": "text",
"note": "text",
"group": "text",
"edge": "text",
"edit": "text",
"tag": "text",
"profile": "text",
"label": "text",
"weight": 1,
"cdate": 1,
"ddate": 1,
"mdate": 1,
"tcdate": 1,
"tmdate": 1,
"readers": [
"text"
],
"nonreaders": [
"text"
],
"writers": [
"text"
],
"signature": "text",
"tauthor": "text",
"domain": "text",
"details": {
"forumContent": {
"id": "text",
"externalId": "text",
"externalIds": [
"text"
],
"invitations": [
"text"
],
"parentInvitations": "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]"
}
}
},
"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"
}
],
"postprocesses": [
{
"script": "text",
"delay": 1,
"dependsOn": 1,
"ignoreFailure": true
}
],
"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": "[Circular Reference]",
"writable": true
},
"readers": [
"text"
],
"nonreaders": [
"text"
],
"writers": [
"text"
],
"signatures": [
"text"
],
"tauthor": "text",
"domain": "text",
"replacement": true
},
"tcdate": 1,
"tmdate": 1,
"cdate": 1,
"mdate": 1,
"ddate": 1,
"duedate": 1,
"expdate": 1,
"responseArchiveDate": 1,
"details": {
"writable": true,
"replytoNote": {
"id": "text",
"externalId": "text",
"externalIds": [
"text"
],
"invitations": [
"text"
],
"parentInvitations": "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": {
"replyCount": 1,
"writable": true,
"revisions": true,
"forumContent": {
"ANY_ADDITIONAL_PROPERTY": {
"description": "text",
"order": 1,
"delete": true,
"value": "text",
"readers": {}
}
},
"tags": "[Circular Reference]",
"invitation": "[Circular Reference]",
"invitations": "[Circular Reference]",
"directReplyCount": 1,
"directReplies": [
{}
],
"replies": [
{}
],
"presentation": [
{
"name": "text",
"order": 1,
"type": "text",
"input": "text",
"description": "text",
"fieldName": "text",
"hidden": true,
"markdown": true,
"scroll": true,
"default": "text",
"value": "text"
}
],
"signatures": [
{
"id": "text",
"readers": [
"text"
],
"members": [
"text"
]
}
]
}
},
"repliedNotes": [],
"repliedEdits": [
{
"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",
"externalId": "text",
"externalIds": [
"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]"
}
],
"repliedTags": [],
"repliedEdges": [],
"writableWith": []
},
"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"
}
],
"postprocesses": [
{
"script": "text",
"delay": 1,
"dependsOn": 1,
"ignoreFailure": true
}
],
"web": "text",
"readers": [
"text"
],
"nonreaders": [
"text"
],
"writers": [
"text"
],
"signatures": [
"text"
],
"invitees": [
"text"
],
"noninvitees": [
"text"
]
}
},
"domain": "text",
"tauthor": "text"
}get
Returns all the Note Edits by filter.
Authorizations
Query parameters
idstring · min: 1Optional
Edit id.
idsany ofOptional
Edit ids.
stringOptional
string[]Optional
note.idstring · min: 1Optional
Note id that the Edits have edited.
invitationstring · min: 1OptionalExample:
Invitation id used to create the Edit(s).
ICLR.cc/2018/Conference/-/Blind_Submissiondomainstring · 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.
stringOptional
string[]Optional
selectstring · min: 1OptionalExample:
Comma separated string with specific fields of the Note Edit object to return.
id,content.title,content.abstractdetailsstring · min: 1OptionalExample:
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. 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.
allsortstring · min: 1Optional
Sort returned Edits by field.
limitintegerOptional
Maximum number of results to return.
offsetintegerOptional
Offset of the result shown.
countbooleanOptional
Whether to return the count of the note edits.
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
200
Edit Note response
application/json
default
Error
application/json
get
GET /notes/edits HTTP/1.1
Host: api2.openreview.net
Accept: */*
{
"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",
"externalId": "text",
"externalIds": [
"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",
"instructions": "text",
"description": "text",
"invitations": [
"text"
],
"parentInvitations": "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",
"parentInvitations": "text",
"forum": "text",
"note": "text",
"group": "text",
"edge": "text",
"edit": "text",
"tag": "text",
"profile": "text",
"label": "text",
"weight": 1,
"cdate": 1,
"ddate": 1,
"mdate": 1,
"tcdate": 1,
"tmdate": 1,
"readers": [
"text"
],
"nonreaders": [
"text"
],
"writers": [
"text"
],
"signature": "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"
}
],
"postprocesses": [
{
"script": "text",
"delay": 1,
"dependsOn": 1,
"ignoreFailure": true
}
],
"web": "text",
"readers": [
"text"
],
"nonreaders": [
"text"
],
"writers": [
"text"
],
"signatures": [
"text"
],
"invitees": [
"text"
],
"noninvitees": [
"text"
]
},
"presentation": [
{
"name": "text",
"order": 1,
"type": "text",
"input": "text",
"description": "text",
"fieldName": "text",
"hidden": true,
"markdown": true,
"scroll": true,
"default": "text",
"value": "text"
}
]
}
}
],
"fromCache": true
}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
Responses
200
Note Edit response
application/json
default
Error
application/json
post
POST /notes/edits HTTP/1.1
Host: api2.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 429
{
"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",
"externalId": "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"
]
}
}{
"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",
"externalId": "text",
"externalIds": [
"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",
"instructions": "text",
"description": "text",
"invitations": [
"text"
],
"parentInvitations": "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",
"parentInvitations": "text",
"forum": "text",
"note": "text",
"group": "text",
"edge": "text",
"edit": "text",
"tag": "text",
"profile": "text",
"label": "text",
"weight": 1,
"cdate": 1,
"ddate": 1,
"mdate": 1,
"tcdate": 1,
"tmdate": 1,
"readers": [
"text"
],
"nonreaders": [
"text"
],
"writers": [
"text"
],
"signature": "text",
"tauthor": "text",
"domain": "text",
"details": {
"forumContent": {
"id": "text",
"externalId": "text",
"externalIds": [
"text"
],
"invitations": [
"text"
],
"parentInvitations": "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]"
}
}
},
"message": {
"signature": "text",
"replyTo": "text",
"useJob": true,
"parentGroup": "text",
"sendAt": 1,
"subject": "text",
"message": "text",
"groups": [
"text"
],
"ignoreGroups": [
"text"
],
"fromEmail": "text",
"fromName": "text"
},
"edit": {
"id": "text",
"invitations": "text",
"invitation": {
"id": "text",
"instructions": "text",
"description": "text",
"invitations": [
"text"
],
"parentInvitations": "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",
"parentInvitations": "text",
"forum": "text",
"note": "text",
"group": "text",
"edge": "text",
"edit": "text",
"tag": "text",
"profile": "text",
"label": "text",
"weight": 1,
"cdate": 1,
"ddate": 1,
"mdate": 1,
"tcdate": 1,
"tmdate": 1,
"readers": [
"text"
],
"nonreaders": [
"text"
],
"writers": [
"text"
],
"signature": "text",
"tauthor": "text",
"domain": "text",
"details": {
"forumContent": {
"id": "text",
"externalId": "text",
"externalIds": [
"text"
],
"invitations": [
"text"
],
"parentInvitations": "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]"
}
}
},
"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"
}
],
"postprocesses": [
{
"script": "text",
"delay": 1,
"dependsOn": 1,
"ignoreFailure": true
}
],
"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": "[Circular Reference]",
"writable": true
},
"readers": [
"text"
],
"nonreaders": [
"text"
],
"writers": [
"text"
],
"signatures": [
"text"
],
"tauthor": "text",
"domain": "text",
"replacement": true
},
"tcdate": 1,
"tmdate": 1,
"cdate": 1,
"mdate": 1,
"ddate": 1,
"duedate": 1,
"expdate": 1,
"responseArchiveDate": 1,
"details": {
"writable": true,
"replytoNote": {
"id": "text",
"externalId": "text",
"externalIds": [
"text"
],
"invitations": [
"text"
],
"parentInvitations": "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": {
"replyCount": 1,
"writable": true,
"revisions": true,
"forumContent": {
"ANY_ADDITIONAL_PROPERTY": {
"description": "text",
"order": 1,
"delete": true,
"value": "text",
"readers": {}
}
},
"tags": "[Circular Reference]",
"invitation": "[Circular Reference]",
"invitations": "[Circular Reference]",
"directReplyCount": 1,
"directReplies": [
{}
],
"replies": [
{}
],
"presentation": [
{
"name": "text",
"order": 1,
"type": "text",
"input": "text",
"description": "text",
"fieldName": "text",
"hidden": true,
"markdown": true,
"scroll": true,
"default": "text",
"value": "text"
}
],
"signatures": [
{
"id": "text",
"readers": [
"text"
],
"members": [
"text"
]
}
]
}
},
"repliedNotes": [],
"repliedEdits": [
{
"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",
"externalId": "text",
"externalIds": [
"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]"
}
],
"repliedTags": [],
"repliedEdges": [],
"writableWith": []
},
"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"
}
],
"postprocesses": [
{
"script": "text",
"delay": 1,
"dependsOn": 1,
"ignoreFailure": true
}
],
"web": "text",
"readers": [
"text"
],
"nonreaders": [
"text"
],
"writers": [
"text"
],
"signatures": [
"text"
],
"invitees": [
"text"
],
"noninvitees": [
"text"
]
},
"presentation": [
{
"name": "text",
"order": 1,
"type": "text",
"input": "text",
"description": "text",
"fieldName": "text",
"hidden": true,
"markdown": true,
"scroll": true,
"default": "text",
"value": "text"
}
]
}
}get
Returns all the Notes by filter.
Authorizations
Query parameters
idstring · min: 1Optional
Note id.
idsany ofOptional
Note ids.
stringOptional
string[]Optional
invitationstring · min: 1OptionalExample:
Invitation id used to create the Note(s).
ICLR.cc/2018/Conference/-/Blind_Submissioninvitationsany ofOptional
Invitation ids.
stringOptional
string[]Optional
forumany ofOptional
Note id of the forum field.
stringOptional
string[]Optional
replytoany ofOptional
Note id of the replyto field.
stringOptional
string[]Optional
numberany ofOptional
Note number.
integer · min: 1Optional
string · min: 1OptionalPattern:
^([1-9][0-9]*,?)*[1-9][0-9]*$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_McCallum1string[]Optional
trashbooleanOptional
Whether to get deleted Notes.
paperhashstringOptionalDeprecatedExample:
paperhash of the Note if exists.
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
string[]Optional
originalany ofOptional
get Notes that are originals
booleanOptional
string · min: 1Optional
selectstring · min: 1OptionalExample:
Comma separated string with specific fields of the Note object to return.
id,content.title,content.abstractdetailsstring · min: 1OptionalExample:
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
allinviteebooleanOptional
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
200
Note response
application/json
default
Error
application/json
get
GET /notes HTTP/1.1
Host: api2.openreview.net
Accept: */*
{
"count": 1,
"notes": [],
"fromCache": true
}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 · enumOptionalPossible values:
Search type
contentstring · enumOptionalDefault:
Fields inside content to look for the term.
allPossible values: groupstring · min: 1Optional
Group that the Invitation belongs to
sourcestring · enumOptionalDefault:
Source of the Note
allPossible values: invitationstring · min: 1OptionalExample:
Invitation id used to create the Note(s).
ICLR.cc/2018/Conference/-/Submissionvenuestring · min: 1Optional
Venue of the Note
venueidstring · min: 1Optional
Venue id of the Note
sortstring · min: 1OptionalExample:
Sort returned Notes by field.
tmdate:desclimitintegerOptional
Maximum number of results to return.
offsetintegerOptional
Offset of the result shown.
countbooleanOptional
Whether to return the count of the notes.
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
200
Note response
application/json
default
Error
application/json
get
GET /notes/search HTTP/1.1
Host: api2.openreview.net
Accept: */*
{
"count": 1,
"notes": [],
"fromCache": true
}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 · enumOptionalPossible values:
Search type
groupstring · min: 1Optional
Group that the Invitation belongs to
sourcestring · enumOptionalDefault:
Source of the Note
allPossible values: invitationstring · min: 1Optional
Invitation id used to create the Note(s).
venuestring · min: 1Optional
Venue of the Note
venueidstring · min: 1Optional
Venue id of the Note
domainstring · min: 1Optional
Domain the Notes belong.
countbooleanOptional
Whether to return the count of the notes.
sortstring · min: 1OptionalExample:
Sort returned Notes by field.
tmdate:desclimitinteger · 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
Note response
application/json
default
Error
application/json
post
POST /notes/search HTTP/1.1
Host: api2.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 354
{
"ids": [
"text"
],
"query": "text",
"term": "text",
"terms": [
"text"
],
"type": "prefix",
"group": "text",
"source": "all",
"invitation": "text",
"content": {
"title": {
"terms": [
"text"
],
"matchMethod": "match"
},
"venue": {
"terms": [
"text"
],
"matchMethod": "match"
}
},
"venue": "text",
"venueid": "text",
"domain": "text",
"count": true,
"sort": "tmdate:desc",
"limit": 1,
"offset": 1,
"cache": true
}{
"count": 1,
"notes": [],
"fromCache": true
}get
Returns Invitation Edits
Authorizations
Query parameters
idstring · min: 1Optional
Edit id.
idsany ofOptional
Edit ids.
stringOptional
string[]Optional
invitation.idstring · min: 1Optional
Invitation id that the Edits have edited.
invitationstring · min: 1OptionalExample:
Invitation id used to create the Edit(s).
ICLR.cc/2018/Conference/-/Blind_SubmissiontrashbooleanOptional
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
string[]Optional
selectstring · min: 1OptionalExample:
Comma separated string with specific fields of the Invitation Edit object to return.
id,content.title,content.abstractdetailsstring · min: 1OptionalExample:
Comma separated values of fields to add to details. Valid values are writable, invitation, presentation, and all
allsortstring · min: 1Optional
Sort returned Edits by field.
limitinteger · min: 1Optional
Maximum number of results to return.
offsetintegerOptional
Offset of the result shown.
countbooleanOptional
Whether to return the count of the invitation edits.
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
200
Invitation response
application/json
default
Error
application/json
get
GET /invitations/edits HTTP/1.1
Host: api2.openreview.net
Accept: */*
{
"count": 1,
"edits": [
{
"id": "text",
"invitations": "text",
"invitation": {
"id": "text",
"instructions": "text",
"description": "text",
"invitations": [
"text"
],
"parentInvitations": "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",
"parentInvitations": "text",
"forum": "text",
"note": "text",
"group": "text",
"edge": "text",
"edit": "text",
"tag": "text",
"profile": "text",
"label": "text",
"weight": 1,
"cdate": 1,
"ddate": 1,
"mdate": 1,
"tcdate": 1,
"tmdate": 1,
"readers": [
"text"
],
"nonreaders": [
"text"
],
"writers": [
"text"
],
"signature": "text",
"tauthor": "text",
"domain": "text",
"details": {
"forumContent": "[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": {
"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
},
"tcdate": 1,
"tmdate": 1,
"cdate": 1,
"mdate": 1,
"ddate": 1,
"duedate": 1,
"expdate": 1,
"responseArchiveDate": 1,
"details": {
"writable": true,
"replytoNote": {
"id": "text",
"externalId": "text",
"externalIds": [
"text"
],
"invitations": [
"text"
],
"parentInvitations": "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]"
},
"repliedNotes": [],
"repliedEdits": [
"[Circular Reference]"
],
"repliedTags": [],
"repliedEdges": [],
"writableWith": []
},
"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"
}
],
"postprocesses": [
{
"script": "text",
"delay": 1,
"dependsOn": 1,
"ignoreFailure": true
}
],
"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",
"instructions": "text",
"description": "text",
"invitations": [
"text"
],
"parentInvitations": "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",
"parentInvitations": "text",
"forum": "text",
"note": "text",
"group": "text",
"edge": "text",
"edit": "text",
"tag": "text",
"profile": "text",
"label": "text",
"weight": 1,
"cdate": 1,
"ddate": 1,
"mdate": 1,
"tcdate": 1,
"tmdate": 1,
"readers": [
"text"
],
"nonreaders": [
"text"
],
"writers": [
"text"
],
"signature": "text",
"tauthor": "text",
"domain": "text",
"details": {
"forumContent": "[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": {
"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
},
"tcdate": 1,
"tmdate": 1,
"cdate": 1,
"mdate": 1,
"ddate": 1,
"duedate": 1,
"expdate": 1,
"responseArchiveDate": 1,
"details": {
"writable": true,
"replytoNote": {
"id": "text",
"externalId": "text",
"externalIds": [
"text"
],
"invitations": [
"text"
],
"parentInvitations": "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]"
},
"repliedNotes": [],
"repliedEdits": [
"[Circular Reference]"
],
"repliedTags": [],
"repliedEdges": [],
"writableWith": []
},
"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"
}
],
"postprocesses": [
{
"script": "text",
"delay": 1,
"dependsOn": 1,
"ignoreFailure": true
}
],
"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
}
],
"fromCache": true
}post
Create or edit a Invitation Edit
Authorizations
Body
idstring · min: 1Optional
invitationsstring · min: 1Optional
replacementbooleanOptional
contentobjectOptional
cdateinteger · max: 9999999999999Optional
mdateinteger · max: 9999999999999Optional
ddateinteger · max: 9999999999999Optional
readersstring[]Optional
nonreadersstring[]Optional
writersstring[]Optional
signaturesstring[]Optional
domainstring · min: 1Optional
Responses
200
Invitation Edit response
application/json
default
Error
application/json
post
POST /invitations/edits HTTP/1.1
Host: api2.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 5998
{
"id": "text",
"invitations": "text",
"replacement": true,
"content": {},
"invitation": {
"id": "text",
"instructions": "text",
"description": "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",
"parentInvitations": "text",
"forum": "text",
"note": "text",
"group": "text",
"edge": "text",
"edit": "text",
"tag": "text",
"profile": "text",
"label": "text",
"weight": 1,
"cdate": 1,
"ddate": 1,
"mdate": 1,
"tcdate": 1,
"tmdate": 1,
"readers": [
"text"
],
"nonreaders": [
"text"
],
"writers": [
"text"
],
"signature": "text",
"tauthor": "text",
"domain": "text",
"details": {
"forumContent": {
"id": "text",
"externalId": "text",
"externalIds": [
"text"
],
"invitations": [
"text"
],
"parentInvitations": "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": {
"replyCount": 1,
"writable": true,
"revisions": true,
"forumContent": {
"ANY_ADDITIONAL_PROPERTY": {
"description": "text",
"order": 1,
"delete": true,
"value": "text",
"readers": {}
}
},
"tags": "[Circular Reference]",
"invitation": "[Circular Reference]",
"invitations": "[Circular Reference]",
"directReplyCount": 1,
"directReplies": [
{}
],
"replies": [
{}
],
"presentation": [
{
"name": "text",
"order": 1,
"type": "text",
"input": "text",
"description": "text",
"fieldName": "text",
"hidden": true,
"markdown": true,
"scroll": true,
"default": "text",
"value": "text"
}
],
"signatures": [
{
"id": "text",
"readers": [
"text"
],
"members": [
"text"
]
}
]
}
}
}
},
"message": {
"signature": "text",
"replyTo": "text",
"useJob": true,
"parentGroup": "text",
"sendAt": 1,
"subject": "text",
"message": "text",
"groups": [
"text"
],
"ignoreGroups": [
"text"
],
"fromEmail": "text",
"fromName": "text"
},
"edit": {
"id": "text",
"invitations": "text",
"replacement": true,
"content": {},
"invitation": {
"id": "text",
"instructions": "text",
"description": "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",
"parentInvitations": "text",
"forum": "text",
"note": "text",
"group": "text",
"edge": "text",
"edit": "text",
"tag": "text",
"profile": "text",
"label": "text",
"weight": 1,
"cdate": 1,
"ddate": 1,
"mdate": 1,
"tcdate": 1,
"tmdate": 1,
"readers": [
"text"
],
"nonreaders": [
"text"
],
"writers": [
"text"
],
"signature": "text",
"tauthor": "text",
"domain": "text",
"details": {
"forumContent": {
"id": "text",
"externalId": "text",
"externalIds": [
"text"
],
"invitations": [
"text"
],
"parentInvitations": "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": {
"replyCount": 1,
"writable": true,
"revisions": true,
"forumContent": {
"ANY_ADDITIONAL_PROPERTY": {
"description": "text",
"order": 1,
"delete": true,
"value": "text",
"readers": {}
}
},
"tags": "[Circular Reference]",
"invitation": "[Circular Reference]",
"invitations": "[Circular Reference]",
"directReplyCount": 1,
"directReplies": [
{}
],
"replies": [
{}
],
"presentation": [
{
"name": "text",
"order": 1,
"type": "text",
"input": "text",
"description": "text",
"fieldName": "text",
"hidden": true,
"markdown": true,
"scroll": true,
"default": "text",
"value": "text"
}
],
"signatures": [
{
"id": "text",
"readers": [
"text"
],
"members": [
"text"
]
}
]
}
}
}
},
"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"
}
],
"postprocesses": [
{
"script": "text",
"delay": 1,
"dependsOn": 1,
"ignoreFailure": true
}
],
"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"
],
"domain": "text"
},
"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"
}
],
"postprocesses": [
{
"script": "text",
"delay": 1,
"dependsOn": 1,
"ignoreFailure": true
}
],
"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"
],
"domain": "text"
}{
"id": "text",
"invitations": "text",
"invitation": {
"id": "text",
"instructions": "text",
"description": "text",
"invitations": [
"text"
],
"parentInvitations": "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",
"parentInvitations": "text",
"forum": "text",
"note": "text",
"group": "text",
"edge": "text",
"edit": "text",
"tag": "text",
"profile": "text",
"label": "text",
"weight": 1,
"cdate": 1,
"ddate": 1,
"mdate": 1,
"tcdate": 1,
"tmdate": 1,
"readers": [
"text"
],
"nonreaders": [
"text"
],
"writers": [
"text"
],
"signature": "text",
"tauthor": "text",
"domain": "text",
"details": {
"forumContent": {
"id": "text",
"externalId": "text",
"externalIds": [
"text"
],
"invitations": [
"text"
],
"parentInvitations": "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": {
"replyCount": 1,
"writable": true,
"revisions": true,
"forumContent": {
"ANY_ADDITIONAL_PROPERTY": {
"description": "text",
"order": 1,
"delete": true,
"value": "text",
"readers": {}
}
},
"tags": "[Circular Reference]",
"invitation": "[Circular Reference]",
"invitations": "[Circular Reference]",
"directReplyCount": 1,
"directReplies": [
{}
],
"replies": [
{}
],
"presentation": [
{
"name": "text",
"order": 1,
"type": "text",
"input": "text",
"description": "text",
"fieldName": "text",
"hidden": true,
"markdown": true,
"scroll": true,
"default": "text",
"value": "text"
}
],
"signatures": [
{
"id": "text",
"readers": [
"text"
],
"members": [
"text"
]
}
]
}
}
}
},
"message": {
"signature": "text",
"replyTo": "text",
"useJob": true,
"parentGroup": "text",
"sendAt": 1,
"subject": "text",
"message": "text",
"groups": [
"text"
],
"ignoreGroups": [
"text"
],
"fromEmail": "text",
"fromName": "text"
},
"edit": {
"id": "text",
"invitations": "text",
"invitation": {
"id": "text",
"instructions": "text",
"description": "text",
"invitations": [
"text"
],
"parentInvitations": "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",
"parentInvitations": "text",
"forum": "text",
"note": "text",
"group": "text",
"edge": "text",
"edit": "text",
"tag": "text",
"profile": "text",
"label": "text",
"weight": 1,
"cdate": 1,
"ddate": 1,
"mdate": 1,
"tcdate": 1,
"tmdate": 1,
"readers": [
"text"
],
"nonreaders": [
"text"
],
"writers": [
"text"
],
"signature": "text",
"tauthor": "text",
"domain": "text",
"details": {
"forumContent": {
"id": "text",
"externalId": "text",
"externalIds": [
"text"
],
"invitations": [
"text"
],
"parentInvitations": "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": {
"replyCount": 1,
"writable": true,
"revisions": true,
"forumContent": {
"ANY_ADDITIONAL_PROPERTY": {
"description": "text",
"order": 1,
"delete": true,
"value": "text",
"readers": {}
}
},
"tags": "[Circular Reference]",
"invitation": "[Circular Reference]",
"invitations": "[Circular Reference]",
"directReplyCount": 1,
"directReplies": [
{}
],
"replies": [
{}
],
"presentation": [
{
"name": "text",
"order": 1,
"type": "text",
"input": "text",
"description": "text",
"fieldName": "text",
"hidden": true,
"markdown": true,
"scroll": true,
"default": "text",
"value": "text"
}
],
"signatures": [
{
"id": "text",
"readers": [
"text"
],
"members": [
"text"
]
}
]
}
}
}
},
"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"
}
],
"postprocesses": [
{
"script": "text",
"delay": 1,
"dependsOn": 1,
"ignoreFailure": true
}
],
"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",
"instructions": "text",
"description": "text",
"invitations": [
"text"
],
"parentInvitations": "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",
"parentInvitations": "text",
"forum": "text",
"note": "text",
"group": "text",
"edge": "text",
"edit": "text",
"tag": "text",
"profile": "text",
"label": "text",
"weight": 1,
"cdate": 1,
"ddate": 1,
"mdate": 1,
"tcdate": 1,
"tmdate": 1,
"readers": [
"text"
],
"nonreaders": [
"text"
],
"writers": [
"text"
],
"signature": "text",
"tauthor": "text",
"domain": "text",
"details": {
"forumContent": {
"id": "text",
"externalId": "text",
"externalIds": [
"text"
],
"invitations": [
"text"
],
"parentInvitations": "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": {
"replyCount": 1,
"writable": true,
"revisions": true,
"forumContent": {
"ANY_ADDITIONAL_PROPERTY": {
"description": "text",
"order": 1,
"delete": true,
"value": "text",
"readers": {}
}
},
"tags": "[Circular Reference]",
"invitation": "[Circular Reference]",
"invitations": "[Circular Reference]",
"directReplyCount": 1,
"directReplies": [
{}
],
"replies": [
{}
],
"presentation": [
{
"name": "text",
"order": 1,
"type": "text",
"input": "text",
"description": "text",
"fieldName": "text",
"hidden": true,
"markdown": true,
"scroll": true,
"default": "text",
"value": "text"
}
],
"signatures": [
{
"id": "text",
"readers": [
"text"
],
"members": [
"text"
]
}
]
}
}
}
},
"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"
}
],
"postprocesses": [
{
"script": "text",
"delay": 1,
"dependsOn": 1,
"ignoreFailure": true
}
],
"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
},
"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"
}
],
"postprocesses": [
{
"script": "text",
"delay": 1,
"dependsOn": 1,
"ignoreFailure": true
}
],
"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",
"instructions": "text",
"description": "text",
"invitations": [
"text"
],
"parentInvitations": "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",
"parentInvitations": "text",
"forum": "text",
"note": "text",
"group": "text",
"edge": "text",
"edit": "text",
"tag": "text",
"profile": "text",
"label": "text",
"weight": 1,
"cdate": 1,
"ddate": 1,
"mdate": 1,
"tcdate": 1,
"tmdate": 1,
"readers": [
"text"
],
"nonreaders": [
"text"
],
"writers": [
"text"
],
"signature": "text",
"tauthor": "text",
"domain": "text",
"details": {
"forumContent": {
"id": "text",
"externalId": "text",
"externalIds": [
"text"
],
"invitations": [
"text"
],
"parentInvitations": "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": {
"replyCount": 1,
"writable": true,
"revisions": true,
"forumContent": {
"ANY_ADDITIONAL_PROPERTY": {
"description": "text",
"order": 1,
"delete": true,
"value": "text",
"readers": {}
}
},
"tags": "[Circular Reference]",
"invitation": "[Circular Reference]",
"invitations": "[Circular Reference]",
"directReplyCount": 1,
"directReplies": [
{}
],
"replies": [
{}
],
"presentation": [
{
"name": "text",
"order": 1,
"type": "text",
"input": "text",
"description": "text",
"fieldName": "text",
"hidden": true,
"markdown": true,
"scroll": true,
"default": "text",
"value": "text"
}
],
"signatures": [
{
"id": "text",
"readers": [
"text"
],
"members": [
"text"
]
}
]
}
}
}
},
"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"
}
],
"postprocesses": [
{
"script": "text",
"delay": 1,
"dependsOn": 1,
"ignoreFailure": true
}
],
"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
}get
Returns Invitations
Authorizations
Query parameters
idstring · min: 1Optional
Invitation id
idsany ofOptional
Invitation ids
stringOptional
string[]Optional
invitationstring · min: 1Optional
Invitation used to validate this invitation.
prefixstring · min: 1Optional
Invitation id prefix
domainstring · min: 1Optional
Invitation domain
typestring · enumOptionalPossible values:
Invitation type
tag.forumstring · min: 1Optional
Forum stored in the field tag.forum of the invitation
tag.notestring · min: 1Optional
Note id stored in the field tag.note of the invitation
message.groups.param.inGroupstring · min: 1Optional
Group id of the group members that the Invitation can send messages to
edit.group.idstring · min: 1Optional
Group id of the Invitation Edit
edit.invitation.idstring · min: 1Optional
Invitation id of the Invitation Edit
edit.note.forumany ofOptional
Forum id of Note that the Invitation Edit is editing
stringOptional
string[]Optional
replyForumstring · min: 1Optional
Note id
replyInvitationstring · min: 1Optional
Invitation id
minduedateintegerOptional
minimum due date of the Invitation
inviteeany ofOptional
invitee id
booleanOptional
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
trashbooleanOptional
Invitations should have ddate
selectstring · min: 1OptionalExample:
Comma separated string with specific fields of the Invitation object to return.
id,content,readers,inviteesdetailsstring · 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.
countbooleanOptional
Whether to return the count of the invitations.
afterstring · min: 1Optional
Return documents that come after the after parameter. After should be an id.
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
Invitation response
application/json
default
Error
application/json
get
GET /invitations HTTP/1.1
Host: api2.openreview.net
Accept: */*
{
"count": 1,
"invitations": [],
"fromCache": true
}get
Find tags by different filters
Authorizations
Query parameters
idstringOptional
Tag id
idsany ofOptional
Tag ids
string · min: 1Optional
string[] · min: 1Optional
invitationstringOptionalExample:
Invitation id used to create the Tag(s).
ICLR.cc/2018/Conference/-/Add_BidparentInvitationsstringOptional
parentInvitations stored in the Tag(s).
labelstring · min: 1Optional
Tag value
signaturestring · min: 1Optional
Tag signature
forumstringOptional
Forum id where the tag appears. This value must be present if the field note is present
notestringOptional
Get tags that are tagging the note.
groupstringOptional
Get tags that are tagging the group.
profilestringOptional
Get tags that are tagging the profile.
editstringOptional
Get tags that are tagging the edit.
edgestringOptional
Get tags that are tagging the edge.
trashbooleanOptional
Get tags deleted too.
tauthorbooleanOptional
Get tags authored by user.
mintmdateintegerOptional
minimum modification date
detailsstring · min: 1Optional
Comma separated values of fields to add to details. Valid values are forumContent, all.
limitintegerOptionalDefault:
Maximum number of results to return.
1000offsetintegerOptional
Offset of the result shown.
countbooleanOptional
Whether to return the count of the tags.
afterstring · min: 1Optional
Return documents that come after the after parameter. After should be an id.
streambooleanOptional
Whether to use a stream to process results or not.
domainstring · min: 1Optional
Domain the Tags belong to to filter transitive members.
Responses
200
Tag response
application/json
default
Error
application/json
get
GET /tags HTTP/1.1
Host: api2.openreview.net
Accept: */*
{
"count": 1,
"tags": [],
"fromCache": true
}post
Create or edit a Tag
Authorizations
Body
idany ofOptional
string · min: 1Optional
invitationstring · min: 1Optional
parentInvitationsstring · min: 1Optional
forumany ofOptional
string · min: 1Optional
noteany ofOptional
string · min: 1Optional
groupany ofOptional
string · min: 1Optional
edgeany ofOptional
string · min: 1Optional
editany ofOptional
string · min: 1Optional
tagany ofOptional
string · min: 1Optional
profileany ofOptional
string · min: 1Optional
labelany ofOptional
stringOptional
weightany ofOptional
numberOptional
cdateany ofOptional
integer · max: 9999999999999Optional
string · min: 1Optional
ddateany ofOptional
integer · max: 9999999999999Optional
string · min: 1Optional
mdateany ofOptional
integer · max: 9999999999999Optional
string · min: 1Optional
tcdateinteger · max: 9999999999999Optional
tmdateinteger · max: 9999999999999Optional
readersany ofOptional
string[]Optional
nonreadersany ofOptional
string[]Optional
writersany ofOptional
string[]Optional
signatureany ofOptional
string · min: 1Optional
tauthorstring · min: 1Optional
domainstring · min: 1Optional
Responses
200
Tag response
application/json
default
Error
application/json
post
POST /tags HTTP/1.1
Host: api2.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",
"parentInvitations": "text",
"forum": "text",
"note": "text",
"group": "text",
"edge": "text",
"edit": "text",
"tag": "text",
"profile": "text",
"label": "text",
"weight": 1,
"cdate": 1,
"ddate": 1,
"mdate": 1,
"tcdate": 1,
"tmdate": 1,
"readers": [
"text"
],
"nonreaders": [
"text"
],
"writers": [
"text"
],
"signature": "text",
"tauthor": "text",
"domain": "text",
"details": {
"forumContent": {
"id": "text",
"externalId": "text",
"externalIds": [
"text"
],
"invitations": [
"text"
],
"parentInvitations": "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": {
"replyCount": 1,
"writable": true,
"revisions": true,
"forumContent": {
"ANY_ADDITIONAL_PROPERTY": {
"description": "text",
"order": 1,
"delete": true,
"value": "text",
"readers": {}
}
},
"tags": [],
"invitation": {
"id": "text",
"instructions": "text",
"description": "text",
"invitations": [
"text"
],
"parentInvitations": "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",
"parentInvitations": "text",
"forum": "text",
"note": "text",
"group": "text",
"edge": "text",
"edit": "text",
"tag": "text",
"profile": "text",
"label": "text",
"weight": 1,
"cdate": 1,
"ddate": 1,
"mdate": 1,
"tcdate": 1,
"tmdate": 1,
"readers": [
"text"
],
"nonreaders": [
"text"
],
"writers": [
"text"
],
"signature": "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"
}
],
"postprocesses": [
{
"script": "text",
"delay": 1,
"dependsOn": 1,
"ignoreFailure": true
}
],
"web": "text",
"readers": [
"text"
],
"nonreaders": [
"text"
],
"writers": [
"text"
],
"signatures": [
"text"
],
"invitees": [
"text"
],
"noninvitees": [
"text"
]
},
"invitations": [],
"directReplyCount": 1,
"directReplies": [
{}
],
"replies": [
{}
],
"presentation": [
{
"name": "text",
"order": 1,
"type": "text",
"input": "text",
"description": "text",
"fieldName": "text",
"hidden": true,
"markdown": true,
"scroll": true,
"default": "text",
"value": "text"
}
],
"signatures": [
{
"id": "text",
"readers": [
"text"
],
"members": [
"text"
]
}
]
}
}
}
}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.
string · min: 1Optional
string[]Optional
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.
countbooleanOptional
Whether to return the count of the messages.
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
200
message response
application/json
default
Error
application/json
get
GET /messages HTTP/1.1
Host: api2.openreview.net
Accept: */*
{
"count": 1,
"messages": []
}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[] | nullableOptionalDefault:
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.
Responses
200
message response
application/json
default
Error
application/json
post
POST /messages HTTP/1.1
Host: api2.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 254
{
"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"
}
}{
"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"
}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.
countbooleanOptional
Whether to return the count of the message requests.
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
200
message response
application/json
default
Error
application/json
get
GET /messages/requests HTTP/1.1
Host: api2.openreview.net
Accept: */*
{
"count": 1,
"requests": []
}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[] | nullableOptionalDefault:
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.
Responses
200
message response
application/json
default
Error
application/json
post
POST /messages/requests HTTP/1.1
Host: api2.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 254
{
"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"
}
}{
"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"
}post
Mark a message as viewed
Authorizations
Body
idsstring[]Required
Message ids to mark as viewed.
vdateinteger | nullableRequired
Viewed date in milliseconds.
Responses
200
Mark as viewed response
application/json
default
Error
application/json
post
POST /messages/viewed HTTP/1.1
Host: api2.openreview.net
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"ids": [
"text"
],
"vdate": 1
}{
"status": "text"
}get
Get logs by different filters
Authorizations
Query parameters
idstring · min: 1Optional
log id
idsany ofOptional
log ids
string · min: 1Optional
string[] · min: 1Optional
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.
selectstring · min: 1Optional
Comma separated string with specific fields of the Logs object to return.
limitintegerOptionalDefault:
Maximum number of results to return.
1000offsetintegerOptional
Offset of the result shown.
countbooleanOptional
Whether to return the count of the logs.
afterstring · min: 1Optional
Return documents that come after the after parameter. After should be an id.
Responses
200
log response
application/json
default
Error
application/json
get
GET /logs/process HTTP/1.1
Host: api2.openreview.net
Accept: */*
{
"count": 1,
"logs": []
}Last updated
Was this helpful?