---
schema: rendered-html/v1
title: "Article Attachments | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/resource-api-articles-articleID-attachments.html
generated_at: 2026-06-11T15:11:16.632270+00:00
---

Feedback

Thanks for your feedback!

Was this page helpful?

YesNo

Developer Portal for YouTrack and Hub

- Developer Portal
- Apps
- MCP Tools
- YouTrack Workflows
- YouTrack Import Scripts
- YouTrack Form API
- YouTrack REST API
- Get Started with REST API
- REST API Reference
- Entities
- Resources
- Activity Items
- Issue Activities Page
- Build Bundles
- Enum Bundles
- Owned Bundles
- State Bundles
- User Bundles
- Version Bundles
- Custom Fields
- Field Types
- Backup Files
- Database Backup Settings
- Global Settings
- Organizations
- [Projects](jetbrains__com__help__youtrack__devportal__resource-api-admin-projects.md)
- [Telemetry data](jetbrains__com__help__youtrack__devportal__resource-api-admin-telemetry.md)
- [Global Time Tracking Settings](jetbrains__com__help__youtrack__devportal__resource-api-admin-timetrackingsettings.md)
- [Agiles](jetbrains__com__help__youtrack__devportal__resource-api-agiles.md)
- Articles
- Operations with Specific Article
- Sub-resources
- [Article Attachments](resource-api-articles-articleID-attachments.html)
- Operations with Specific ArticleAttachment
- [Sub-articles](jetbrains__com__help__youtrack__devportal__resource-api-articles-articleid-childarticles.md)
- Article Comments
- Parent Article
- Tags
- Assigned Roles
- Commands
- Command Suggestions
- User Groups
- Issue Link Types
- Issue Tag
- Issues
- Issue Count
- Permissions
- Roles
- Saved Queries
- Search Suggestions
- Tags
- Users
- My User Profile
- Issue Work Items
- REST API Use Cases
- REST API Troubleshooting
- Color Indices List
- Hub REST API

1. YouTrack REST API
2. REST API Reference
3. Resources
4. Articles
5. [Sub-resources](#0)
6. [Article Attachments](#0)

# Article Attachments﻿

Last modified: 24 March 2026

This resource lets you work with attachments in a specific article.

| Resource | ``` /api/articles/{articleID}/attachments ``` |
| --- | --- |
| Returned entity | ArticleAttachment. For the description of the entity attributes, see [Supported Fields](/help/youtrack/devportal/resource-api-articles-articleID-attachments.html#ArticleAttachment-supported-fields) section. |
| Supported methods | - `GET`: [Read a List of ArticleAttachments](/help/youtrack/devportal/resource-api-articles-articleID-attachments.html#get_all-ArticleAttachment-method). - `POST`: [Add a New ArticleAttachment](/help/youtrack/devportal/resource-api-articles-articleID-attachments.html#create-ArticleAttachment-method). |

## ArticleAttachment attributes﻿

Represents a file that is attached to an article or a comment to an article.

### Related Resources﻿

Below you can find the list of resources that let you work with this entity.

- Article Attachments

### Attributes﻿

This table describes attributes of the `ArticleAttachment` entity.

- To receive an attribute in the response from the server, specify it explicitly in the `fields` request parameter.
- To update an attribute, provide it in the body of a POST request.

| Field | Type | Description |
| --- | --- | --- |
| id | String | The ID of the article attachment. `Read-only`. |
| name | String | The name of the file. |
| author | User | The user who attached the file to the article. `Read-only`. `Can be null`. |
| created | Long | The timestamp in milliseconds indicating the moment when the attachment was created. Stored as a unix timestamp at UTC. `Read-only`. |
| updated | Long | The timestamp in milliseconds indicating the last update of the attachment. Stored as a unix timestamp at UTC. `Read-only`. |
| size | Long | The size of the attached file in bytes. `Read-only`. |
| extension | String | The extension that defines the file type. `Read-only`. `Can be null`. |
| charset | String | The charset of the file. `Read-only`. `Can be null`. |
| mimeType | String | The MIME type of the file. `Read-only`. `Can be null`. |
| metaData | String | The dimensions of an image file. For an image file, the value is `rw=&rh=`. For a non-image file, the value is empty. `Read-only`. `Can be null`. |
| draft | Boolean | If `true`, the attachment is not yet published, otherwise `false`. `Read-only`. |
| removed | Boolean | If `true`, the attachment is considered to be removed. `Read-only`. |
| base64Content | String | The data URI that represents the attachment with the following syntax:  ``` data:[<media type>][;base64],<data> ```  For example:  ``` "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==" ```  `Can be null`. |
| url | String | The URL of the file. `Read-only`. `Can be null`. |
| visibility | Visibility | The visibility settings of the attachment. `Can be null`. |
| article | BaseArticle | The article that the file is attached to. `Read-only`. `Can be null`. |
| comment | ArticleComment | The comment that the file is attached to. Returns `null` if the file was attached directly to the article. `Read-only`. |

## Read a List of ArticleAttachments﻿

Get a list of all attachments to a specific article.

### Required permissions﻿

- Requires permissions: Read Article.
- If the attachment is added to a comment, Read Comment is also required.
- If the attachment visibility is limited to specific groups or users, only users from this set and the attachment author will be able to access the attachment. Override Visibility Restrictions permission allows to override these limitations.

### Request syntax﻿

```
GET /api/articles/{articleID}/attachments?{fields}&{$top}&{$skip}
```

| null | The database ID of ArticleAttachment |
| --- | --- |

### Request parameters﻿

| Parameter | Type | Description |
| --- | --- | --- |
| fields | String | A list of ArticleAttachment attributes that should be returned in the response. If no field is specified, only the `entityID` is returned. |
| $skip | Int | Optional. Lets you set a number of returned entities to skip before returning the first one. |
| $top | Int | Optional. Lets you specify the maximum number of entries that are returned in the response. If you don't set the $top value, the server limits the maximum number of returned entries.  The server returns a maximum of 42 entries for most resources that return collections. For more information, see Pagination. |

### Sample﻿

#### Sample request﻿

```
https://example.youtrack.cloud/api/articles/NP-A-7/attachments?fields=id,name,author(id,name),created,updated,size,mimeType,extension,url
```

#### Sample response body﻿

```
[
  {
    "created": 1629978590790,
    "extension": "png",
    "author": {
      "name": "John Smith",
      "id": "24-0",
      "$type": "User"
    },
    "updated": 1629978590790,
    "url": "/youtrack/api/files/237-3?sign=MTYzMDE5NTIwMDAwMHwyNC0wfDIzNy0zfFUtWDhBOGkyMF9uSTVRN2xTVHNzLWJBYjN2LUF2Y2pB%0D%0AUXYzSFc2bHRkeE0NCg%0D%0A%26updated=1629978590790",
    "mimeType": "image/png",
    "name": "jetbrains.png",
    "size": 64014,
    "id": "237-3",
    "$type": "ArticleAttachment"
  }
]
```

## Add a New ArticleAttachment﻿

Add an attachment to the article.

### Required permissions﻿

Requires permissions: Add Attachment

### Request syntax﻿

```
POST /api/articles/{articleID}/attachments?{fields}&{muteUpdateNotifications}
```

| null | The database ID of ArticleAttachment |
| --- | --- |

### Request parameters﻿

| Parameter | Type | Description |
| --- | --- | --- |
| fields | String | A list of ArticleAttachment attributes that should be returned in the response. If no field is specified, only the `entityID` is returned. |
| muteUpdateNotifications | Boolean | Set this parameter to `true` if no notifications should be sent on changes made by this request. This doesn't mute notifications sent by any workflow rules. Using this parameter requires Apply Commands Silently permission in all projects affected by the request. Available since 2021.3. |

### Sample﻿

To create an attachment in an article, you need to send a `POST` request to an endpoint like the one specified in this sample. As the format for request differs for various languages and tools, we do not provide specific example here. Instead, please see a sample step-by-step procedure on the use case page.

#### Sample request﻿

```
https://example.youtrack.cloud/api/articles/NP-A-7/attachments?fields=id,name,author(id,name),created,updated,size,mimeType,extension,url
```

- [Article Attachments](/help/youtrack/devportal/resource-api-articles-articleID-attachments.html)
- [ArticleAttachment attributes](/help/youtrack/devportal/resource-api-articles-articleID-attachments.html#ArticleAttachment-supported-fields)
- [Read a List of ArticleAttachments](/help/youtrack/devportal/resource-api-articles-articleID-attachments.html#get_all-ArticleAttachment-method)
- [Add a New ArticleAttachment](/help/youtrack/devportal/resource-api-articles-articleID-attachments.html#create-ArticleAttachment-method)

Operations with Specific ArticleOperations with Specific ArticleAttachment

- Privacy & Security
- Terms Of Use
- Trademarks
- Legal

Copyright © 2000–2026 JetBrains s.r.o.
