Skip to main content

List Collections

Retrieve a paginated list of collections.

GET /api/collections

Authorization

  • Customer: Can view their own collections only
  • Analyst: Can view all collections

Query Parameters

ParameterTypeRequiredDescription
statusstringNoFilter by status: pending, in_progress, completed, signed_off, delivered
customer_idstringNoFilter by customer (Analyst only)
assigned_analyst_idstringNoFilter by assigned analyst (Analyst only)
limitnumberNoItems per page (default: 20, max: 100)
offsetnumberNoItems to skip (default: 0)
sortstringNoSort field: created_at, updated_at, priority
orderstringNoSort direction: asc, desc

Response

{
"collections": [
{
"id": "col_abc123",
"customer": {
"id": "cus_xyz789",
"company_name": "Acme Corp",
"contact_name": "Jane Smith"
},
"connector": {
"id": "conn_slack001",
"platform_name": "Slack"
},
"status": "in_progress",
"priority": "high",
"case_reference": "CASE-2024-001",
"progress": {
"completed_endpoints": 5,
"total_endpoints": 12,
"files_collected": 234,
"bytes_collected": 15728640
},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T14:22:00Z",
"estimated_completion": "2024-01-15T18:00:00Z"
}
],
"total": 47,
"limit": 20,
"offset": 0,
"has_more": true
}
note

Analyst test collections are always excluded from this list.

Example Request

curl -X GET "https://api.traces.io/api/collections?status=in_progress&limit=10" \
-H "Authorization: Bearer <token>"

Example: Filter by Customer (Analyst)

curl -X GET "https://api.traces.io/api/collections?customer_id=cus_xyz789" \
-H "Authorization: Bearer <token>"