BIbigchange
Contacts

Get a list of attachments for a contact

Changed on

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

get/v1/contacts/{contactId}/attachments

Request

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

Path parameters

contactIdinteger required

The unique identifier of the contact

Query parameters

folderIdinteger

Only return attachments within the folder with the given ID. Omit, or supply 0, to return attachments outside of any folder

isResourceVisibleboolean

Only return attachments that are visible to a resource (mobile field engineer) when true. Omit to return attachments regardless of resource visibility

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