BIbigchange
Attachments

Get a list of attachments

Changed on

Retrieves a paged collection of attachments, optionally filtered to those belonging to the specified contact (required scope attachments:read)

get/v1/attachments

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/attachments
  • Auth
    HTTP bearer

Query parameters

contactIdinteger

Only return attachments associated with the contact matching the value provided. When omitted, attachments across all contacts are returned

entityTypeAttachmentEntityType[]

Only return attachments where entityType matches the value(s) provided (Max items: 50)

[
  "job"
]
fileNamestring

Only return attachments where the file name contains the value provided. Do not include the file extension, as it is not matched against

createdAtFromstring date-time

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

createdAtTostring date-time

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

isResourceVisibleboolean

Only return attachments where isResourceVisible matches the value provided

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 (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": 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