Sign in

v1

latestOpenAPI 3.0.12026-07-26272332.0 KB
Attachments

Find an attachment by ID

get/{recordType}/{alias}/{id}/attachments/{attachmentId}

Path parameters

recordTypestring string required

'apps', 'elements', 'tasks', or 'transactions'

aliasstring string required

The application alias

idstring string required

The record ID

attachmentIdstring string required

The ID of the attachment

Response

Ok

idstring

The attachment ID

namestring

The attachment filename

descriptionstring

The attachment description

mediaTypestring

The MIME type of the attachment

sizeinteger

The file size in bytes

statestring

The processing state of the attachment (e.g., VALID, PROCESSING, ERROR)

viewStatestring

The visibility state of the attachment (e.g., PRIVATE, PUBLIC)

contentUrlstring

URL path to download the attachment content

createdAtstring date-time

When the attachment was created

Example response

{
  "id": "abc-123",
  "name": "invoice.pdf",
  "description": "Q4 Invoice",
  "mediaType": "application/pdf",
  "size": 245678,
  "state": "VALID",
  "viewState": "PRIVATE",
  "contentUrl": "/v1/apps/my-namespace/REC-001/attachments/abc-123/content",
  "createdAt": "2026-02-03T10:30:00Z"
}