OpenAPI definition

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

PreviousAPI V2 NextEntities

Last updated 1 year ago

Was this helpful?

put

Activate a user

Authorizations

Path parameters

tokenstringRequired

Token used to activate new email

Responses

200

Confirmed email

application/json

put

PUT /activatelink/{token} HTTP/1.1
Host: api2.openreview.net
Accept: */*

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

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

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
    }
  }
}

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"
}

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

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

200

PDF

get

GET /pdf HTTP/1.1
Host: api2.openreview.net
Accept: */*

200

PDF

No content

get

Get a PDF

Authorizations

Path parameters

idstringRequired

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

Responses

200

pdf

get

GET /pdf/{id} HTTP/1.1
Host: api2.openreview.net
Accept: */*

200

pdf

No content

get

Compare PDFs

Authorizations

Query parameters

noteIdstringRequired

Note id

leftIdstringRequired

Edit id

rightIdstringRequired

Edit id

fieldstringOptional

field to compare

Default: pdf

Responses

200

pdf comparison

get

GET /pdf/compare HTTP/1.1
Host: 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.

afterstring · min: 1Optional

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

sortstring · min: 1Optional

Sort returned Edges by field.

invitationstring · min: 1Optional

Invitation id used to create the Edge(s).

headstring · min: 1Optional

head value of the Edge(s).

tailstring · min: 1Optional

tail value of the Edge(s).

labelstring · min: 1Optional

label of the Edge(s).

trashbooleanOptional

Whether to return deleted Edges as well.

groupBystring · min: 1Optional

Group result by different Edge fields.

selectany ofOptional

Fields of the Edge to return in the result. Requires groupBy.

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

string[]Optional

detailsstring · min: 1Optional

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

Example: head,tail

cachebooleanOptional

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

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,
  "cache": true,
  "groupedEdges": [
    {
      "id": {},
      "count": 1,
      "values": [
        {}
      ]
    }
  ]
}

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

get

Get user profiles

Authorizations

Query parameters

idstring · min: 1Optional

Profile id

Pattern: ^~.*\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: 1Optional

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

Example: id,content.names,content.emails

statestring · enumOptional

State of the Profile.

Possible values:

sortstring · min: 1Optional

Sort returned Profiles by field.

limitinteger · min: 1Optional

Maximum number of results to return.

offsetintegerOptional

Offset of the result shown.

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
}

get

Get user profiles

Authorizations

Query parameters

idstring · min: 1Optional

Profile id

Pattern: ^~.*\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: 1Optional

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

Example: id,content.names,content.emails

statestring · enumOptional

State of the Profile.

Possible values:

sortstring · min: 1Optional

Sort returned Profiles by field.

limitinteger · min: 1Optional

Maximum number of results to return.

offsetintegerOptional

Offset of the result shown.

cachebooleanOptional

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

Responses

200

Profile response

application/json

get

GET /profiles/search HTTP/1.1
Host: api2.openreview.net
Accept: */*

200

Profile response

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

post

Get user profiles

Authorizations

Query parameters

idstring · min: 1Optional

Profile id

Pattern: ^~.*\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: 1Optional

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

Example: id,content.names,content.emails

statestring · enumOptional

State of the Profile.

Possible values:

sortstring · min: 1Optional

Sort returned Profiles by field.

limitinteger · min: 1Optional

Maximum number of results to return.

offsetintegerOptional

Offset of the result shown.

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.

memberstring · min: 1Optional

Group id to get its transitive members.

membersstring · min: 1Optional

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

signaturestring · min: 1Optional

Group id used to sign the returned Groups.

signatorystring · min: 1Optional

Group id that can is allowed to sign with the returned Groups.

writerstring · min: 1Optional

Group id that is writer of the returned Groups.

hoststring | nullableOptional

Host of the returned Groups.

selectstring · min: 1Optional

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

Example: id,members

detailsstring · min: 1Optional

Comma separated values of fields to add to details. Valid value is writable.

Example: writable

limitinteger · min: 1Optional

Maximum number of results to return.

offsetintegerOptional

Offset of the result shown.

afterstring · min: 1Optional

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

sortstring · min: 1Optional

Select field to sort by.

webbooleanOptional

Whether to return web ui code

streambooleanOptional

Whether to use a stream to process results or not.

cachebooleanOptional

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

domainstring · min: 1Optional

Domain the Groups belong to to filter transitive members.

Responses

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
}

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: 1Optional

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

Example: id,content.title,content.abstract

detailsstring · min: 1Optional

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

Example: all

sortstring · min: 1Optional

Sort returned Edits by field.

limitintegerOptional

Maximum number of results to return.

offsetintegerOptional

Offset of the result shown.

cachebooleanOptional

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

domainstring · min: 1Optional

Domain the Group Edits belong to to filter transitive members.

Responses

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
}

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: 1Optional

Invitation id used to create the Edit(s).

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

domainstring · min: 1Optional

Domain of the Edits.

trashbooleanOptional

Whether to get deleted Note Edits.

tauthorbooleanOptional

Get Edits authored by user.

writerstring · min: 1Optional

Get Edits written by user.

signaturesany ofOptional

Get Edits signed by users.

stringOptional

string[]Optional

originalany ofOptional

get Edits that are originals

booleanOptional

string · min: 1Optional

selectstring · min: 1Optional

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

Example: id,content.title,content.abstract

detailsstring · min: 1Optional

Comma separated values of fields to add to details. Valid values are: replyCount: Number of replies in a forum. Only available if the Note is a forum. writable: Boolean indicating whether the Note is writable by the user. originalWritable: Boolean indicating whether the original Note is writable by the user. tags: Tags of the Note. invitations: Invitations of the Note. directReplyCount: Number of direct replies to the Note. directReplies: Direct replies to the Note. replies: Replies to the Note. Only available if the Note is a forum. forumContent: Content of the forum Note. Only available if the Note is a reply. presentation: Shows how to render the content of the Note. signatures: Returns members and readers of the signatures of the Note.

Example: all

sortstring · min: 1Optional

Sort returned Edits by field.

limitintegerOptional

Maximum number of results to return.

offsetintegerOptional

Offset of the result shown.

afterstring · min: 1Optional

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

cachebooleanOptional

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

domainstring · min: 1Optional

Domain the Note Edits belong to to filter transitive members.

Responses

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

get

Returns all the Notes by filter.

Authorizations

Query parameters

idstring · min: 1Optional

Note id.

idsany ofOptional

Note ids.

stringOptional

string[]Optional

invitationstring · min: 1Optional

Invitation id used to create the Note(s).

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

invitationsany ofOptional

Invitation ids.

stringOptional

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_McCallum1

string[]Optional

trashbooleanOptional

Whether to get deleted Notes.

paperhashstringOptionalDeprecated

paperhash of the Note if exists.

Example: das|go_for_a_walk_and_arrive_at_the_answer_reasoning_over_paths_in_knowledge_bases_using_reinforcement_learning.

tauthorbooleanOptional

Get Notes authored by user.

writerstring · min: 1Optional

Get Notes written by user.

signaturestring · min: 1Optional

Get Notes signed by user.

transitiveMembersbooleanOptional

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

signaturesany ofOptional

Get Notes signed by users.

stringOptional

string[]Optional

originalany ofOptional

get Notes that are originals

booleanOptional

string · min: 1Optional

selectstring · min: 1Optional

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

Example: id,content.title,content.abstract

detailsstring · min: 1Optional

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

Example: all

inviteebooleanOptional

invitee

mintcdateintegerOptional

minimum creation date

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.