OpenAPI definition

get

Returns all the Notes by filter.

Authorizations
Query parameters
idstring · min: 1Optional

Note id.

idsany ofOptional

Note ids.

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

Invitation id used to create the Note(s).

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

Invitation ids.

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

Reference referent.

forumany ofOptional

Note id of the forum field.

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

Note id of the replyto field.

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

Note number.

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

Note title.

content.confidencestring · min: 1Optional

Note content confidence field value.

content.strengthsstring · min: 1Optional

Note content strengths field value.

content.weaknessesstring · min: 1Optional

Note content weaknesses field value.

content.decisionstring · min: 1Optional

Note content decision field value.

content.certificationsstring · min: 1Optional

Note content certification field values.

content.previous_URLstring · min: 1Optional

Note content previous_URL field value.

content.userstring · min: 1Optional

User email in recruitment.

content.responsestring · min: 1Optional

User response in recruitment.

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

Note venue.

content.venueidstring · min: 1Optional

Note venueid.

content.venue_idstring · min: 1Optional

Note venue_id.

content.presentation_typestring · min: 1Optional

Presentation Type.

content.sessionsstring · min: 1Optional

Sessions.

content.trackstring · min: 1Optional

Track.

content.authoridsany ofOptional

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

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

Whether to get deleted Notes.

paperhashstringOptionalDeprecated

paperhash of the Note if exists.

Example: das|go_for_a_walk_and_arrive_at_the_answer_reasoning_over_paths_in_knowledge_bases_using_reinforcement_learning.
tauthorbooleanOptional

Get Notes authored by user.

writerstring · min: 1Optional

Get Notes written by user.

signaturestring · min: 1Optional

Get Notes signed by user.

signaturesstring[]Optional

Get Notes signed by users.

originalany ofOptional

get Notes that are originals

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

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

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

Comma separated values of fields to add to details. Valid values are: replyCount: Number of replies in a forum. Only available if the Note is a forum. original: Include original Note if available. revisions: Boolean indicating whether the Note has revisions. writable: Boolean indicating whether the Note is writable by the user. originalWritable: Boolean indicating whether the original Note is writable by the user. tags: Tags of the Note. invitation: Invitation of the Note. originalInvitation: Invitation of the original Note. directReplyCount: Number of direct replies to the Note. directReplies: Direct replies to the Note. replies: Replies to the Note. Only available if the Note is a forum.

Example: all
inviteebooleanOptional

invitee

mintcdateintegerOptional

minimum creation date

duedatebooleanOptional

due date

sortstring · min: 1Optional

Sort returned Notes by field.

limitinteger · int32Optional

Maximum number of results to return.

offsetinteger · int32Optional

Offset of the result shown.

cachebooleanOptional

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

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

Last updated

Was this helpful?