Retrieve an Attachment

Retrieve an attachment to get the attachment details. If the attachment status is SCANNED, a content URL and thumbnail URL are also returned.

Endpoint

GET /v1/attachments/{attachmentId}

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

attachmentId REQUIRED

string (UUID)

ID of the attachment.

Request Body

None

Returns

Returns the Attachment object. This object contains the attachment details, including the attachment ID and status. If the attachment status is SCANNED, a content URL and thumbnail URL are also returned.

SAMPLE RESPONSE

				
					{
  "businessAccountId": "e8800f5a-26a9-4435-8fec-5fc47126d1cb",
  "entityId": "c924605d-0c65-446f-8f36-1db31df6e80a",
  "entityType": "CUSTOMER",
  "name": "Contract",
  "description": "contract",
  "metadata": {
    "type": "contract"
  },
  "createdBy": {
    "id": "8d86a17a-4ba9-47b1-a510-214dda87d9f3",
    "type": "service-account"
  },
  "createdAt": "2024-06-20T17:13:43.181Z",
  "updatedBy": {
    "id": "8d86a17a-4ba9-47b1-a510-214dda87d9f3",
    "type": "service-account"
  },
  "updatedAt": "2024-06-20T17:14:43.181Z",
  "id": "22e27516-f2b9-469c-a204-15a963e37753",
  "status": "SCANNED",
  "extension": "PDF",
  "url": {
    "value": "https://documents.rocketkor.net/872345",
    "allow": "GET",
    "expiresIn": 600
  },
  "thumbnailUrl": {
    "value": "https://documents.rocketkor.net/652908",
    "allow": "GET",
    "expiresIn": 600
  }
}