GET    /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/issue-attachments/
POST   /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/issue-attachments/
PATCH  /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/issue-attachments/asset-id/

Upload Process

  1. Get the upload credentials.
  2. Upload the file to storage.
  3. Complete attachment upload to notify server.

Issue attachment object

Attributes

  • id string

    Unique identifier for the attachment

  • created_at , updated_at, deleted_at timestamp

    Timestamp when the attachment was created, when it was last modified or deleted

  • attributes object

    Contains file metadata:

    • name string

    Original filename of the attachment

    • size integer

    File size in bytes

    • type string

    MIME type of the file

  • asset string

    Storage path/identifier for the attachment file

  • entity-type string

    Always ISSUE_ATTACHMENT for issue attachments

  • is_deleted boolean

    Whether the attachment has been deleted

  • is_archived boolean

    Whether the attachment has been archived

  • external_id string or null

    External identifier if the issue and its attachments are imported to Plane

  • external_source string or null

    Name of the source if the issue and its attachments are imported to Plane

  • size integer

    File size in bytes

  • is_uploaded boolean

    Whether the file has been successfully uploaded

  • storage_metadata object

    Cloud storage metadata:

    • ETag string

    Storage provider’s entity tag

    • Metadata object

    Additional storage metadata

    • ContentType object

    MIME type of stored file

    • LastModified timestamp

    Last modification time in storage

    • ContentLength integer

    File size in bytes

  • created_by string

    ID of user who created the attachment

  • updated_by string

    ID of user who last modified the attachment

  • deleted_by string

    ID of user who deleted the attachment

  • workspace string

    ID of workspace containing the attachment

  • project string

    ID of project containing the issue

  • issue string

    ID of issue containing the attachment