Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Notes

Get a list of notes

Retrieves a paged collection of notes (required scope notes:read)

get/v1/notes

Query parameters

sortBy'createdAt' | 'dueAt' | 'progressedAt' | 'status' | 'progressPercentage'

Represents the fields that can be used to sort notes<p>Possible values:</p><ul><li><b>createdAt</b>: The creation date</li><li><b>dueAt</b>: The due date</li><li><b>progressedAt</b>: The last progress date</li><li><b>status</b>: The status</li><li><b>progressPercentage</b>: The progress percentage</li></ul>

Example:createdAt

The field to sort items in the page by

direction'ascending' | 'descending'

Represents the direction in which sorting should be applied<p>Possible values:</p><ul><li><b>ascending</b>: Indicates ascending sorting order</li><li><b>descending</b>: Indicates descending sorting order</li></ul>

Example:ascending

The direction to apply the sort

idinteger[]

Only return notes where id matches the value(s) provided (Max items: 50)

entityType'contact' | 'job' | 'stockItem' | 'resource' | 'vehicle' | 'salesOpportunity' | 'contract'

The type of entity that the note is associated to<p>Possible values:</p><ul><li><b>contact</b>: Associated with a contact entity</li><li><b>job</b>: Associated with a job entity</li><li><b>stockItem</b>: Associated with a stock item entity</li><li><b>resource</b>: Associated with a resource entity</li><li><b>vehicle</b>: Associated with a vehicle entity</li><li><b>salesOpportunity</b>: Associated with a sales opportunity entity</li><li><b>contract</b>: Associated with a contract entity</li></ul>

Example:contact

Only return notes where entityType matches the value provided

entityIdinteger[]

Only return notes where entityId matches the value(s) provided. To use this filter, entityType must also be provided (Max items: 50)

typeIdinteger[]

Only return notes where typeId matches the value(s) provided (Max items: 50)

ownedByUserIdinteger[]

Only return notes where ownedByUserId matches the value(s) provided (Max items: 50)

referencestring[]

Only return notes where reference matches the value(s) provided (Max items: 50)

statusNoteStatus[]

Only return notes where status matches the value(s) provided (Max items: 50)

[
  "open"
]
contactIdinteger[]

Only return notes where contactId matches the value(s) provided (Max items: 50)

dueAtTostring date-time

Only return notes where dueAt occurs at or before the UTC timestamp provided

dueAtFromstring date-time

Only return notes where dueAt occurs at or after the UTC timestamp provided

createdAtFromstring date-time

Only return notes where createdAt is the same or newer than this UTC value

createdAtTostring date-time

Only return notes where createdAt is the same or older than this UTC value

pageNumberinteger

The page number being requested (minimum: 1, maximum: 2147483)

pageSizeinteger

The page size being requested (minimum: 1, maximum: 1000)

Headers

Customer-Idinteger required

The customer identifier

Response

OK

pageNumberinteger

The page number of the response where 1 is the first page

pageSizeinteger

The number of items requested for the current page

pageItemCountinteger

The number of items returned in the current page

Example response

{
  "items": [
    {
      "id": 5514123,
      "entityType": "contact",
      "entityId": 5514123,
      "contactId": 47644689,
      "typeId": 5514123,
      "createdAt": "2022-11-29T16:50:16.0000000+00:00",
      "subject": "Call Mr Brown",
      "parentId": 5514123,
      "dueAt": "2022-11-29T16:50:16.0000000+00:00",
      "progressedAt": "2022-11-29T16:50:16.0000000+00:00",
      "reference": "5514123",
      "status": "open",
      "description": "Message left by Mr Brown regarding the recent installation of his CCTC cameras. He can't get one of them working and needs some technical support.",
      "completionText": "Called the customer, he is now happy with the work",
      "progressPercentage": 50,
      "createdByUserName": "Mr. Jones",
      "ownedByUserId": 1245,
      "ownedByUserName": "Mr. Smith",
      "customFields": [
        {
          "definitionId": 5514123,
          "value": "Purple",
          "definition": {
            "caption": "Favourite colour",
            "type": "boolean",
            "listOptions": [
              "Red",
              "Blue",
              "Green",
              "Purple"
            ],
            "isRequired": true,
            "isEditable": true,
            "default": "10"
          },
          "systemListValueMetadata": {
            "label": "John Doe",
            "entityType": "resource"
          }
        }
      ]
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}