> 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.

# Find annotation queues

GET http://localhost:5173/api/v1/private/annotation-queues

Find annotation queues with filtering and sorting

Reference: https://www.comet.com/docs/opik/reference/rest-api/annotation-queues/find-annotation-queues

## 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: 10)
- `name` (string, optional) — Filter annotation queues by name (partial match, case insensitive)
- `filters` (string, optional)
- `sorting` (string, optional)

## Response

### 200

Annotation queues page

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

## Types

### AnnotationQueue_Public

- `project_id` (string, required)
- `name` (string, required)
- `scope` (enum, required)
  - Allowed values: `trace`, `thread`
- `id` (string, optional)
- `project_name` (string, optional)
- `description` (string, optional)
- `instructions` (string, optional)
- `comments_enabled` (boolean, optional)
- `feedback_definition_names` (list of string, optional)
- `annotators_per_item` (integer, optional)
- `lock_timeout_seconds` (integer, optional)
- `automation` (AnnotationQueueAutomation_Public, optional)
- `reviewers` (list of AnnotationQueueReviewer_Public, optional)
- `feedback_scores` (list of FeedbackScoreAverage_Public, optional)
- `items_count` (long, optional)
- `created_at` (datetime, optional)
- `created_by` (string, optional)
- `last_updated_at` (datetime, optional)
- `last_updated_by` (string, optional)

### AnnotationQueueAutomation_Public

- `enabled` (boolean, optional)
- `conditions` (Conditions_Public, optional)
- `max_items_in_queue` (integer, optional)

### AnnotationQueueReviewer_Public

- `username` (string, optional)
- `status` (long, optional)

### FeedbackScoreAverage_Public

- `name` (string, required)
- `value` (double, required)

### Conditions_Public

- `groups` (list of ConditionGroup_Public, required)

### ConditionGroup_Public

- `conditions` (list of ScoreCondition_Public, required)

### ScoreCondition_Public

- `score_name` (string, required)
- `operator` (enum, required)
  - Allowed values: `>`, `<`, `=`
- `value` (double, required)

## Examples

**Response**

```json
{
  "page": 1,
  "size": 1,
  "total": 1,
  "content": [
    {
      "project_id": "string",
      "name": "string",
      "scope": "trace",
      "id": "string",
      "project_name": "string",
      "description": "string",
      "instructions": "string",
      "comments_enabled": true,
      "feedback_definition_names": [
        "string"
      ],
      "annotators_per_item": 1,
      "lock_timeout_seconds": 1,
      "automation": {
        "enabled": true,
        "conditions": {
          "groups": [
            {
              "conditions": [
                {
                  "score_name": "string",
                  "operator": ">",
                  "value": 1.1
                }
              ]
            }
          ]
        },
        "max_items_in_queue": 1
      },
      "reviewers": [
        {
          "username": "string",
          "status": 1
        }
      ],
      "feedback_scores": [
        {
          "name": "string",
          "value": 1.1
        }
      ],
      "items_count": 1,
      "created_at": "2024-01-15T09:30:00Z",
      "created_by": "string",
      "last_updated_at": "2024-01-15T09:30:00Z",
      "last_updated_by": "string"
    }
  ],
  "sortableBy": [
    "string"
  ]
}
```

**SDK Code**

```python
import requests

url = "http://localhost:5173/api/v1/private/annotation-queues"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'http://localhost:5173/api/v1/private/annotation-queues';
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/annotation-queues"

	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/annotation-queues")

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/annotation-queues")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'http://localhost:5173/api/v1/private/annotation-queues');

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

```csharp
using RestSharp;

var client = new RestClient("http://localhost:5173/api/v1/private/annotation-queues");
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/annotation-queues")! 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()
```