Skip to main content
GET
/
attachments
/
v1
/
{attachmentId}
Get attachment by ID
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/attachments/v1/{attachmentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --header 'X-Session-Token: <x-session-token>'
{
  "data": {
    "id": 1,
    "name": "document.pdf",
    "mimeType": "image/jpeg",
    "size": 1024,
    "origin": {
      "type": 1,
      "id": 123
    },
    "presignedUrl": "https://example.com/presigned-url",
    "updatedAt": "2024-12-05T14:56:23.000Z",
    "createdAt": "2024-01-15T08:45:00.000Z",
    "uploadedBy": {
      "id": 1,
      "img": "https://www.example.com/image.jpg",
      "firstName": "John",
      "lastName": "Doe",
      "roles": [
        1,
        2
      ]
    },
    "actions": {
      "canBeUpdated": true,
      "canBeDeleted": true
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Content-Type
enum<string>
required

Content type, must be "application/json".

Available options:
application/json
​
X-Session-Token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

Path Parameters

​
attachmentId
integer
required

Unique identifier of the attachment.

Example:

1

Query Parameters

​
extend
enum<string>[]

Extend options:

  • "uploaded-by": Get information about the person that uploaded the attachment

  • "actions-info": Give information about the origin of the attachment

Available options:
uploaded-by,
actions-info

Response

200 - application/json

Attachment retrieved successfully

​
data
object
required