Get attachment metadata

client.Attachments.Get(ctx, attachmentID) (*AttachmentGetResponse, error)

GET/v3/attachments/{attachmentId}

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

ParametersExpand Collapse

attachmentID string

formatuuid

ReturnsExpand Collapse

type AttachmentGetResponse struct{…}

ID string

Unique identifier for the attachment (UUID)

ContentType 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:

const SupportedContentTypeImageJpeg SupportedContentType = "image/jpeg"

const SupportedContentTypeImagePng SupportedContentType = "image/png"

const SupportedContentTypeImageGif SupportedContentType = "image/gif"

const SupportedContentTypeImageHeic SupportedContentType = "image/heic"

const SupportedContentTypeImageHeif SupportedContentType = "image/heif"

const SupportedContentTypeImageTiff SupportedContentType = "image/tiff"

const SupportedContentTypeImageBmp SupportedContentType = "image/bmp"

const SupportedContentTypeImageSvgXml SupportedContentType = "image/svg+xml"

const SupportedContentTypeImageWebp SupportedContentType = "image/webp"

const SupportedContentTypeImageXIcon SupportedContentType = "image/x-icon"

const SupportedContentTypeVideoMP4 SupportedContentType = "video/mp4"

const SupportedContentTypeVideoQuicktime SupportedContentType = "video/quicktime"

const SupportedContentTypeVideoMpeg SupportedContentType = "video/mpeg"

const SupportedContentTypeVideoMpeg2 SupportedContentType = "video/mpeg2"

const SupportedContentTypeVideoXM4v SupportedContentType = "video/x-m4v"

const SupportedContentTypeVideoXMsvideo SupportedContentType = "video/x-msvideo"

const SupportedContentTypeVideo3gpp SupportedContentType = "video/3gpp"

const SupportedContentTypeAudioMpeg SupportedContentType = "audio/mpeg"

const SupportedContentTypeAudioMP3 SupportedContentType = "audio/mp3"

const SupportedContentTypeAudioXM4a SupportedContentType = "audio/x-m4a"

const SupportedContentTypeAudioMP4 SupportedContentType = "audio/mp4"

const SupportedContentTypeAudioXCaf SupportedContentType = "audio/x-caf"

const SupportedContentTypeAudioXWav SupportedContentType = "audio/x-wav"

const SupportedContentTypeAudioXAiff SupportedContentType = "audio/x-aiff"

const SupportedContentTypeAudioAiff SupportedContentType = "audio/aiff"

const SupportedContentTypeAudioAac SupportedContentType = "audio/aac"

const SupportedContentTypeAudioMidi SupportedContentType = "audio/midi"

const SupportedContentTypeAudioAmr SupportedContentType = "audio/amr"

const SupportedContentTypeApplicationPdf SupportedContentType = "application/pdf"

const SupportedContentTypeTextPlain SupportedContentType = "text/plain"

const SupportedContentTypeTextMarkdown SupportedContentType = "text/markdown"

const SupportedContentTypeTextVcard SupportedContentType = "text/vcard"

const SupportedContentTypeTextRtf SupportedContentType = "text/rtf"

const SupportedContentTypeTextCsv SupportedContentType = "text/csv"

const SupportedContentTypeTextHTML SupportedContentType = "text/html"

const SupportedContentTypeTextCalendar SupportedContentType = "text/calendar"

const SupportedContentTypeApplicationMsword SupportedContentType = "application/msword"

const SupportedContentTypeApplicationVndOpenxmlformatsOfficedocumentWordprocessingmlDocument SupportedContentType = "application/vnd.openxmlformats-officedocument.wordprocessingml.document"

const SupportedContentTypeApplicationVndMsExcel SupportedContentType = "application/vnd.ms-excel"

const SupportedContentTypeApplicationVndOpenxmlformatsOfficedocumentSpreadsheetmlSheet SupportedContentType = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"

const SupportedContentTypeApplicationVndMsPowerpoint SupportedContentType = "application/vnd.ms-powerpoint"

const SupportedContentTypeApplicationVndOpenxmlformatsOfficedocumentPresentationmlPresentation SupportedContentType = "application/vnd.openxmlformats-officedocument.presentationml.presentation"

const SupportedContentTypeApplicationXIworkPagesSffpages SupportedContentType = "application/x-iwork-pages-sffpages"

const SupportedContentTypeApplicationXIworkNumbersSffnumbers SupportedContentType = "application/x-iwork-numbers-sffnumbers"

const SupportedContentTypeApplicationXIworkKeynoteSffkey SupportedContentType = "application/x-iwork-keynote-sffkey"

const SupportedContentTypeApplicationEpubZip SupportedContentType = "application/epub+zip"

const SupportedContentTypeTextXml SupportedContentType = "text/xml"

const SupportedContentTypeApplicationJson SupportedContentType = "application/json"

const SupportedContentTypeApplicationZip SupportedContentType = "application/zip"

const SupportedContentTypeApplicationXGzip SupportedContentType = "application/x-gzip"

CreatedAt Time

When the attachment was created

formatdate-time

Filename string

Original filename of the attachment

SizeBytes int64

Size of the attachment in bytes

formatint64

Status AttachmentGetResponseStatus

Current upload/processing status

One of the following:

const AttachmentGetResponseStatusPending AttachmentGetResponseStatus = "pending"

const AttachmentGetResponseStatusComplete AttachmentGetResponseStatus = "complete"

const AttachmentGetResponseStatusFailed AttachmentGetResponseStatus = "failed"

DownloadURL stringOptional

URL to download the attachment

formaturi

Get attachment metadata

package main

import (
  "context"
  "fmt"

  "github.com/linq-team/linq-go"
  "github.com/linq-team/linq-go/option"
)

func main() {
  client := linqgo.NewClient(
    option.WithAPIKey("My API Key"),
  )
  attachment, err := client.Attachments.Get(context.TODO(), "abc12345-1234-5678-9abc-def012345678")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", attachment.ID)
}

{
  "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
}