> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://www.comet.com/docs/opik/llms.txt.

# Attachments list for entity

GET http://localhost:5173/api/v1/private/attachment/list

Attachments list for entity

Reference: https://www.comet.com/docs/opik/reference/rest-api/attachments/attachment-list

## Servers

- `http://localhost:5173/api` (Local server, default)
- `https://www.comet.com/opik/api` (Opik Cloud)

## Request

### Query parameters

- `page` (integer, optional, default: 1)
- `size` (integer, optional, default: 100)
- `project_id` (string, required)
- `entity_type` (enum, required)
  - Allowed values: `trace`, `span`
- `entity_id` (string, required)
- `path` (string, required)

## Response

### 200

Attachment Resource

- `page` (integer, optional)
- `size` (integer, optional)
- `total` (long, optional)
- `content` (list of Attachment, optional)
- `sortableBy` (list of string, optional)

## Errors

### 401 Unauthorized Error

Bad Request

- `code` (integer, optional)
- `message` (string, optional)
- `details` (string, optional)

### 403 Forbidden Error

Access forbidden

- `code` (integer, optional)
- `message` (string, optional)
- `details` (string, optional)

## Types

### Attachment

- `file_name` (string, required)
- `file_size` (long, required)
- `mime_type` (string, required)
- `link` (string, optional)

## Examples

**Response**

```json
{
  "page": 1,
  "size": 1,
  "total": 1,
  "content": [
    {
      "file_name": "string",
      "file_size": 1,
      "mime_type": "string",
      "link": "string"
    }
  ],
  "sortableBy": [
    "string"
  ]
}
```

**SDK Code**

```python
import requests

url = "http://localhost:5173/api/v1/private/attachment/list"

querystring = {"entity_id":"entity_id","entity_type":"trace","path":"path","project_id":"project_id"}

response = requests.get(url, params=querystring)

print(response.json())
```

```javascript
const url = 'http://localhost:5173/api/v1/private/attachment/list?entity_id=entity_id&entity_type=trace&path=path&project_id=project_id';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:5173/api/v1/private/attachment/list?entity_id=entity_id&entity_type=trace&path=path&project_id=project_id"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("http://localhost:5173/api/v1/private/attachment/list?entity_id=entity_id&entity_type=trace&path=path&project_id=project_id")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("http://localhost:5173/api/v1/private/attachment/list?entity_id=entity_id&entity_type=trace&path=path&project_id=project_id")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'http://localhost:5173/api/v1/private/attachment/list?entity_id=entity_id&entity_type=trace&path=path&project_id=project_id');

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("http://localhost:5173/api/v1/private/attachment/list?entity_id=entity_id&entity_type=trace&path=path&project_id=project_id");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:5173/api/v1/private/attachment/list?entity_id=entity_id&entity_type=trace&path=path&project_id=project_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```