BIbigchange
ContactNote

Get a list of attachments for a note

Retrieve a paged collection of attachments belonging to a note (required scope attachments:read)

get/v1/ContactNote/{noteId}/attachments

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/ContactNote/{noteId}/attachments
  • Auth
    HTTP bearer

Path parameters

noteIdinteger required

The note id

Query parameters

fileNamestring

Only return attachments where the file name contains this value

isResourceVisibleboolean

Only return attachments that are visible to a resource (mobile field engineer) when true

sortBy'createdAt'

The field to sort attachments by<p>Possible values:</p><ul><li><b>createdAt</b>: Sort by the date the attachment was created</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

pageNumberinteger

The page number being requested

pageSizeinteger

The page size being requested

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": 123456,
      "fileName": "invoice.pdf",
      "fileDescription": "Signed contract",
      "fileType": "application/pdf",
      "fileExtension": "pdf",
      "isNew": true,
      "isImage": true,
      "createdAt": "2024-01-15T09:30:00.0000000+00:00",
      "entityType": "job",
      "isResourceVisible": true
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}

Changes