Get attachment metadata

GET/v3/attachments/{attachmentId}

Retrieve metadata for a specific attachment including its status, file information, and URLs for downloading.

Path ParametersExpand Collapse

attachmentId: string

formatuuid

ReturnsExpand Collapse

id: string

Unique identifier for the attachment (UUID)

content_type: SupportedContentType

Supported MIME types for file attachments and media URLs.

Images: image/jpeg, image/png, image/gif, image/heic, image/heif, image/tiff, image/bmp, image/svg+xml, image/webp, image/x-icon

Videos: video/mp4, video/quicktime, video/mpeg, video/mpeg2, video/x-msvideo, video/3gpp

Audio: audio/mpeg, audio/x-m4a, audio/x-caf, audio/x-wav, audio/x-aiff, audio/aac, audio/midi, audio/amr

Documents: application/pdf, text/plain, text/markdown, text/vcard, text/rtf, text/csv, text/html, text/calendar, text/xml, application/json, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.ms-powerpoint, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/x-iwork-pages-sffpages, application/x-iwork-numbers-sffnumbers, application/x-iwork-keynote-sffkey, application/epub+zip, application/zip, application/x-gzip

Transcoded on delivery:

audio/x-caf — CAF files are transcoded to audio/mp4 for delivery.

Deprecated (accepted but transcoded):

audio/mp3 — Deprecated. Use audio/mpeg instead. Files sent as audio/mp3 will be delivered as audio/mpeg.
audio/mp4 — Deprecated. Use audio/x-m4a instead. Files sent as audio/mp4 will be delivered as audio/x-m4a.
audio/aiff — Deprecated. Use audio/x-aiff instead. Files sent as audio/aiff will be delivered as audio/x-aiff.
image/tiff — Accepted, but TIFF images are transcoded to JPEG for delivery.

Unsupported: FLAC, OGG, and executable files are explicitly rejected.

One of the following:

"image/jpeg"

"image/png"

"image/gif"

"image/heic"

"image/heif"

"image/tiff"

"image/bmp"

"image/svg+xml"

"image/webp"

"image/x-icon"

"video/mp4"

"video/quicktime"

"video/mpeg"

"video/mpeg2"

"video/x-m4v"

"video/x-msvideo"

"video/3gpp"

"audio/mpeg"

"audio/mp3"

"audio/x-m4a"

"audio/mp4"

"audio/x-caf"

"audio/x-wav"

"audio/x-aiff"

"audio/aiff"

"audio/aac"

"audio/midi"

"audio/amr"

"application/pdf"

"text/plain"

"text/markdown"

"text/vcard"

"text/rtf"

"text/csv"

"text/html"

"text/calendar"

"application/msword"

"application/vnd.openxmlformats-officedocument.wordprocessingml.document"

"application/vnd.ms-excel"

"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"

"application/vnd.ms-powerpoint"

"application/vnd.openxmlformats-officedocument.presentationml.presentation"

"application/x-iwork-pages-sffpages"

"application/x-iwork-numbers-sffnumbers"

"application/x-iwork-keynote-sffkey"

"application/epub+zip"

"text/xml"

"application/json"

"application/zip"

"application/x-gzip"

created_at: string

When the attachment was created

formatdate-time

filename: string

Original filename of the attachment

size_bytes: number

Size of the attachment in bytes

formatint64

status: "pending" or "complete" or "failed"

Current upload/processing status

One of the following:

"pending"

"complete"

"failed"

download_url: optional string

URL to download the attachment

formaturi

Get attachment metadata

curl https://api.linqapp.com/api/partner/v3/attachments/$ATTACHMENT_ID \
    -H "Authorization: Bearer $LINQ_API_V3_API_KEY"

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "filename": "photo.jpg",
  "content_type": "image/jpeg",
  "size_bytes": 1024000,
  "status": "complete",
  "download_url": "https://cdn.linqapp.com/attachments/550e8400-e29b-41d4-a716-446655440000/photo.jpg",
  "created_at": "2024-01-15T10:30:00Z"
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token"
  },
  "success": false
}

{
  "error": {
    "status": 404,
    "code": 2001,
    "message": "Resource not found"
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error"
  },
  "success": false
}

Returns Examples

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "filename": "photo.jpg",
  "content_type": "image/jpeg",
  "size_bytes": 1024000,
  "status": "complete",
  "download_url": "https://cdn.linqapp.com/attachments/550e8400-e29b-41d4-a716-446655440000/photo.jpg",
  "created_at": "2024-01-15T10:30:00Z"
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token"
  },
  "success": false
}

{
  "error": {
    "status": 404,
    "code": 2001,
    "message": "Resource not found"
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error"
  },
  "success": false
}