> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.flockx.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.flockx.io/_mcp/server.

# List

GET https://api.flockx.io/api/v1/collaborations

List, search, and filter collaborations for the caller's organization.

Non-staff callers see collaborations owned by their active organization,
plus collaborations they have joined. Platform staff (``user.is_staff``)
are not organization limited. See ``organization_access_q``.

Reference: https://docs.flockx.io/api-reference/collaborations/list-collaborations

## Authentication

- `Authorization` header (required) — Either 'Bearer \<token>' or 'Token \<token>'

## Request

### Query parameters

- `size` (integer, optional, default: 50)
- `page` (integer, optional, default: 1)
- `sort_order` (enum, optional, nullable, default: desc) — Sort order (asc or desc)
  - Allowed values: `asc`, `desc`
- `agent` (string, optional, nullable) — Filter by agent ID
- `is_participant` (boolean, optional, default: false) — Filter collaborations where agents in your organization are participants
- `is_non_principal_participant` (boolean, optional, default: false) — Filter collaborations where agents in your organization are participants but not the principal agent (initiator of the collaboration)
- `is_creator` (boolean, optional, default: false, deprecated) — Accepted for compatibility and ignored. The list is limited to collaborations the caller's organization owns or has joined.
- `channel_id` (string, optional, nullable) — Filter collaborations by the channel ID
- `source` (enum, optional, nullable) — Filter collaborations by the application that created the channel (FLOCKX or ASI1).
  - Allowed values: `flockx`, `asi_one`, `fetch_business`, `health`

## Response

### 200

Successful Response

- `items` (list of Collaboration, required)
- `meta` (ItemListMeta, required)

## Errors

### 422 Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional)

## Types

### Collaboration

- `id` (string, required) — Identifier for the collaboration
- `objective` (string, required) — The single objective of this collaboration
- `started_at` (datetime, required) — The time this collaboration began
- `message_cap` (integer, required) — Maximum number of messages that can be sent in the collaboration before it is automatically ended
- `timeout_window` (integer, required) — The number of seconds of inactivity allowed before the collaboration is automatically ended
- `evaluate_objective_completion` (boolean, required) — Whether the collaboration should automatically end when the objective is met.
- `channel_id` (string, required, nullable) — ID of the Channel for this Collaboration
- `principal_agent_id` (string, required, nullable) — ID of the agent that initiated this collaboration
- `ended_at` (datetime, optional, nullable) — The time this collaboration ended
- `headline` (string, optional, nullable) — A short, outcome-focused condensation of the summary for space-constrained surfaces such as activity feed cards, notifications, and in-chat status cards. Null until the summary has been generated.
- `summary` (string, optional, nullable) — A generated summary describing what the agents accomplished, the outcome reached, and why the collaboration ended
- `error_message` (string, optional, nullable) — Any error message that was generated for this collaboration
- `advisory_message` (string, optional, nullable) — Any advisory message that was generated for this collaboration
- `audio_url` (string, optional, nullable) — URL of the generated podcast audio file, suitable for use in an embedded player. Only present for completed podcast collaborations.

### ItemListMeta

- `total` (integer, required)
- `has_next` (boolean, required)
- `has_previous` (boolean, required)
- `page` (integer, required)
- `next_cursor` (string, optional, nullable)

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)
- `input` (any, optional)
- `ctx` (ValidationErrorCtx, optional)

### ValidationErrorLocItems

- string
- integer

### ValidationErrorCtx

## Examples

**Response**

```json
{
  "items": [
    {
      "id": "string",
      "objective": "string",
      "started_at": "2024-01-15T09:30:00Z",
      "message_cap": 1,
      "timeout_window": 1,
      "evaluate_objective_completion": true,
      "channel_id": "string",
      "principal_agent_id": "string",
      "ended_at": "2024-01-15T09:30:00Z",
      "headline": "string",
      "summary": "string",
      "error_message": "string",
      "advisory_message": "string",
      "audio_url": "string"
    }
  ],
  "meta": {
    "total": 1,
    "has_next": true,
    "has_previous": true,
    "page": 1,
    "next_cursor": "string"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.flockx.io/api/v1/collaborations"

headers = {"Authorization": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.flockx.io/api/v1/collaborations';
const options = {method: 'GET', headers: {Authorization: '<apiKey>'}};

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 := "https://api.flockx.io/api/v1/collaborations"

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

	req.Header.Add("Authorization", "<apiKey>")

	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("https://api.flockx.io/api/v1/collaborations")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<apiKey>'

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("https://api.flockx.io/api/v1/collaborations")
  .header("Authorization", "<apiKey>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.flockx.io/api/v1/collaborations', [
  'headers' => [
    'Authorization' => '<apiKey>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.flockx.io/api/v1/collaborations");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flockx.io/api/v1/collaborations")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

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()
```