Skip to main content
POST
/
v1
/
buckets
/
{bucket_id}
/
syncs
/
list
List Sync Configurations
curl --request POST \
  --url https://api.mixpeek.com/v1/buckets/{bucket_id}/syncs/list \
  --header 'Content-Type: application/json' \
  --data '
{
  "connection_id": "conn_abc123",
  "status": "pending",
  "is_active": true
}
'
{
  "results": [
    {
      "bucket_id": "<string>",
      "connection_id": "<string>",
      "internal_id": "<string>",
      "namespace_id": "<string>",
      "source_path": "<string>",
      "created_by_user_id": "<string>",
      "sync_config_id": "<string>",
      "file_filters": {
        "include_patterns": [
          "<string>"
        ],
        "exclude_patterns": [
          "<string>"
        ],
        "min_size_bytes": 1,
        "max_size_bytes": 1,
        "modified_after": "2023-11-07T05:31:56Z",
        "modified_before": "2023-11-07T05:31:56Z",
        "mime_types": [
          "<string>"
        ],
        "metadata_filters": [
          {
            "field": "<string>",
            "operator": "contains",
            "value": "<string>"
          }
        ]
      },
      "schema_mapping": {
        "mappings": {}
      },
      "sync_mode": "continuous",
      "polling_interval_seconds": 300,
      "batch_size": 50,
      "create_object_on_confirm": true,
      "skip_duplicates": true,
      "skip_batch_submission": false,
      "reconcile_on_sync": false,
      "status": "PENDING",
      "is_active": true,
      "total_files_discovered": 0,
      "total_files_synced": 0,
      "total_files_failed": 0,
      "total_bytes_synced": 0,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "last_sync_at": "2023-11-07T05:31:56Z",
      "next_sync_at": "2023-11-07T05:31:56Z",
      "last_error": "<string>",
      "consecutive_failures": 0,
      "metadata": {},
      "locked_by_worker_id": "<string>",
      "locked_at": "2023-11-07T05:31:56Z",
      "lock_expires_at": "2023-11-07T05:31:56Z",
      "paused": false,
      "pause_reason": "<string>",
      "paused_at": "2023-11-07T05:31:56Z",
      "paused_by_user_id": "<string>",
      "max_objects_per_run": 100000,
      "max_batch_chunk_size": 1000,
      "batch_chunk_size": 100,
      "current_sync_run_id": "<string>",
      "sync_run_counter": 0,
      "batch_ids": [
        "<string>"
      ],
      "task_ids": [
        "<string>"
      ],
      "batches_created": 0,
      "resume_enabled": true,
      "resume_cursor": "<string>",
      "resume_last_primary_key": "<string>",
      "resume_objects_processed": 0,
      "resume_checkpoint_frequency": 1000
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "page_size": 123,
    "total_pages": 123,
    "next_page": "<string>",
    "previous_page": "<string>",
    "next_cursor": "<string>"
  },
  "total": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Examples:

"Bearer YOUR_API_KEY"

"Bearer YOUR_STRIPE_API_KEY"

​
authorization
string
​
X-Namespace
string

Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'. Falls back to ?namespace= query parameter if the header is omitted.

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Path Parameters

​
bucket_id
string
required

Query Parameters

​
limit
integer | null
Required range: 1 <= x <= 1000
​
offset
integer | null
Required range: 0 <= x <= 10000
​
cursor
string | null
​
include_total
boolean
default:false

Body

application/json

Request to filter sync configurations for listing.

All filters are optional - when omitted, returns all sync configurations for the bucket. Multiple filters can be combined for precise queries.

Use Cases: - Find all syncs for a specific connection - List only active or paused syncs - Filter by status to find failed syncs

Requirements: - All fields are OPTIONAL - Multiple filters are combined with AND logic - Empty request returns all configurations

​
connection_id
string | null

Filter sync configurations by connection ID. NOT REQUIRED. When provided, only returns syncs using this connection. Useful for managing syncs across multiple storage providers. Example: 'conn_abc123'

Example:

"conn_abc123"

​
status
enum<string> | null

Filter sync configurations by status. NOT REQUIRED. Valid values: 'pending', 'processing', 'completed', 'failed', 'paused'. Useful for finding syncs that need attention or monitoring. Example: 'failed' to find syncs with errors.

Available options:
PENDING,
QUEUED,
IN_PROGRESS,
PROCESSING,
COMPLETED,
COMPLETED_WITH_ERRORS,
FAILED,
CANCELED,
UNKNOWN,
SKIPPED,
DRAFT,
ACTIVE,
ARCHIVED,
SUSPENDED
Example:

"pending"

​
is_active
boolean | null

Filter sync configurations by active status. NOT REQUIRED. True: Only active syncs that are currently monitoring/processing. False: Only paused/disabled syncs. Omit to include both active and inactive.

Example:

true

Response

Successful Response

Response containing a list of sync configurations with pagination.

Wraps the list of sync configurations with pagination metadata to support efficient browsing of large result sets.

Response Structure: - results: The actual sync configuration objects - pagination: Links and metadata for navigation - total: Total count for client-side progress indicators

​
results
SyncConfigurationModel · object[]
required

List of sync configurations matching the query filters. ALWAYS PRESENT. May be empty if no configurations match. Each item is a complete SyncConfigurationModel. Ordered by creation date (newest first).

​
pagination
PaginationResponse · object
required

Pagination metadata for navigating result sets. ALWAYS PRESENT. Contains next/previous links, current page info. Use the provided links for cursor-based pagination.

​
total
integer
required

Total number of sync configurations matching the filters. ALWAYS PRESENT. Useful for progress indicators and UI display. Note: This is the total across all pages, not just current page.

Examples:

0

5

42