HYEGRO CRM v1.0.0 is now LIVE!!

Read Attachment By Id

GET

https://backend.test-hyegro.com/attachments/{attachment_id}/download

Retrieve an attachment by ID.

Args:
attachment_id (int): The ID of the attachment to retrieve.
db (Session): The database session.
current_user (schemas.User): The user requesting the attachment.

Returns:
schemas.Attachment: The retrieved attachment.

Request

Path Params

attachment_id

integer

Attachment Id

required

Query Params

schema

Schema

optional

Any of

string

null

Responses

🟢200OK

application/json

Successful Response

Body

file_name

string

File Name

required

file_type

string

File Type

required

file_size

integer

File Size

required

bucket_name

string

Bucket Name

required

storage_path

string

Storage Path

required

description

Description

optional

Any of

string

null

parent_table

string

Parent Table

required

parent_id

integer

Parent Id

required

is_active

boolean

Is Active

optional

Default:

true

is_private

boolean

Is Private

optional

Default:

false

file_url

File Url

optional

Any of

string

null

signed_url_expiry

Signed Url Expiry

optional

Any of

string<date-time>

null

integer

required

created_at

string <date-time>

Created At

required

updated_at

string <date-time>

Updated At

required

Example

{
  "file_name": "string",
  "file_type": "string",
  "file_size": 0,
  "bucket_name": "string",
  "storage_path": "string",
  "description": "string",
  "parent_table": "string",
  "parent_id": 0,
  "is_active": true,
  "is_private": false,
  "file_url": "string",
  "signed_url_expiry": "2019-08-24T14:15:22Z",
  "id": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

🟠422Parameter Error

Modified at 2025-04-14 16:23:20

Delete Attachment