OpenAPI definition

get

Returns all the Notes by filter.

Authorizations

Query parameters

idstring · min: 1optional

Note id.

idsany ofoptional

Note ids.

invitationstring · min: 1optional

Invitation id used to create the Note(s).

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

invitationsany ofoptional

Invitation ids.

referentstring · min: 1optional

Reference referent.

forumany ofoptional

Note id of the forum field.

replytoany ofoptional

Note id of the replyto field.

numberany ofoptional

Note number.

content.titlestring · min: 1optional

Note title.

content.confidencestring · min: 1optional

Note content confidence field value.

content.strengthsstring · min: 1optional

Note content strengths field value.

content.weaknessesstring · min: 1optional

Note content weaknesses field value.

content.decisionstring · min: 1optional

Note content decision field value.

content.certificationsstring · min: 1optional

Note content certification field values.

content.previous_URLstring · min: 1optional

Note content previous_URL field value.

content.userstring · min: 1optional

User email in recruitment.

content.responsestring · min: 1optional

User response in recruitment.

content.submission_idstring · min: 1optional

content.venuestring · min: 1optional

Note venue.

content.venueidstring · min: 1optional

Note venueid.

content.venue_idstring · min: 1optional

Note venue_id.

content.presentation_typestring · min: 1optional

Presentation Type.

content.sessionsstring · min: 1optional

Sessions.

content.trackstring · min: 1optional

Track.

content.authoridsany ofoptional

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

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

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

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

[]

Note response