Sign in
Attachment

Get a specific attachment

get/api/attachments/{attachmentId}

Path parameters

attachmentIdstring required

Response

The attachment for the given id

idstring required

Unique Id associated to this entity

namestring nullable

The file name.

descriptionstring nullable

Description

type'standard' | 'externalAccessDocument' | 'certification'

Attachment types

format'undefined' | 'cad' | 'document' | 'image' | 'video'

Attachment format

sizeinteger nullable

File size in bytes

fileIdstring required

Internal file identifier

createdUtcstring date-time

UTC timestamp when this attachment record was created on its current owner. Note: when an attachment is copied between owners (for example, from a quote to a job), a new attachment record is created and this value reflects the copy time, not the original upload time.

Changes

Changed in 1 of the 23 revisions of this API.2

  • ad309c11f9542See the full diff
    • ●

      added the new shipment enum value to the / response property for the response status (media type: application/json)

      response-property-enum-value-added

    • ●

      added the new shipment enum value to the / response property for the response status (media type: application/problem+json)

      response-property-enum-value-added