Attachments

Search attachments.

Returns a list containing basic information for the attachments. The ID in each result entry can be used to fetch complete attachment details with the GET /attachments/{attachmentId} endpoint. The document management need to be active in order to use this endpoint, it can be set on to an environment from Management -> Company info -> Usage settings -> Documents -> Activate Documents in environment. There is a fee associated with having 'Document management' on for non Solo environments!

This endpoint supports username parameter in HTTP header.

get/attachments

Request

  • Base URL: https://pts-api.procountor.com/api
  • URL: https://pts-api.procountor.com/api/attachments
  • Auth: HTTP bearer

Query parameters

createdStartDatestring date

Start date of the search (Attached date)

createdEndDatestring date

End date of the search (Attached date)

minSizeinteger

Minimum size of attachment in bytes

maxSizeinteger

Maximum size of attachment in bytes

namestring

Name of the attachment file

typestring[]

Attachment type

referenceIdinteger

Attachment reference ID

orderById'ASC' | 'DESC'

Order the results by attachment ID

orderByCreatedDate'ASC' | 'DESC'

Order the results by attachment date

orderByName'ASC' | 'DESC'

Order the results by attachment name

orderBySize'ASC' | 'DESC'

Order the results by attachment size

sizeinteger

Page size for the results. Maximum value: 200.

pageinteger

Page number for the results

previousIdinteger

Previous attachment ID for pagination

Headers

usernamestring

Name of the user.

Response

Attachments successfully returned.

Changes

No recorded changes to this operation across all 1 revision of this API.