Get the list of attachments

GET /{recordType}/{alias}/{id}/attachments

Error

A valid request URL is required to generate request examples

200

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

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

recordType · string<string> · required

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

alias · string<string> · required

The application alias

id · string<string> · required

The record ID

Response

200

application/json

Ok

id · string

The attachment ID

name · string

The attachment filename

description · string

The attachment description

mediaType · string

The MIME type of the attachment

size · integer<int32>

The file size in bytes

state · string

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

viewState · string

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

contentUrl · string

URL path to download the attachment content

createdAt · string<date-time>

When the attachment was created