GuidesREST API ReferenceRelease Notes
Guides

API Request Modifiers

There are some ways of changing the behaviour of an API request or including additional information through the use of request modifiers.

Including the updatedByUser property

The value of updatedByUser is the ID of the user who last modified the document.

Documents which can have an updatedByUser property are:

  • categories
  • contacts
  • labels
  • projects
  • research

To include this property, set &includeUpdatedBy to true in the request parameters.

Request: GET v1/research

{
	'&includeUpdatedBy' : true
}

Response:

{
  {
    "id": "64510dfb3ec001163003dbff",
    "labels": [
      
    ],
    "created": "02\/05\/2023 13:19:55",
    "updated": "02\/05\/2023 13:20:29",
    "title": "Service Update Call",
    "content": "",
    "textContent": "",
    "type": "note",
    "user": "6450dd0d6b31f51deb015fa6",
    "attachments": {
      "645131220e6e973f9305a4f8": "Service Integration.pdf"
    },
    "sharedGroups": [],
    "sharedUsers": [],
    "complete": true,
    "collaborate": false,
    "updatedByUser": "6450dd0d6b31f51deb015fa6"
  }
}

Updated 3 months ago