List Sync Configurations

curl --request POST \
  --url https://api.mixpeek.com/v1/buckets/{bucket_id}/syncs/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <api-key>' \
  --data '
{
  "connection_id": "conn_abc123",
  "status": "pending",
  "is_active": true
}
'

import requests

url = "https://api.mixpeek.com/v1/buckets/{bucket_id}/syncs/list"

payload = {
    "connection_id": "conn_abc123",
    "status": "pending",
    "is_active": True
}
headers = {
    "Authorization": "Bearer <token>",
    "X-Namespace": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Namespace': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({connection_id: 'conn_abc123', status: 'pending', is_active: true})
};

fetch('https://api.mixpeek.com/v1/buckets/{bucket_id}/syncs/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mixpeek.com/v1/buckets/{bucket_id}/syncs/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'connection_id' => 'conn_abc123',
    'status' => 'pending',
    'is_active' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Namespace: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.mixpeek.com/v1/buckets/{bucket_id}/syncs/list"

	payload := strings.NewReader("{\n  \"connection_id\": \"conn_abc123\",\n  \"status\": \"pending\",\n  \"is_active\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Namespace", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.mixpeek.com/v1/buckets/{bucket_id}/syncs/list")
  .header("Authorization", "Bearer <token>")
  .header("X-Namespace", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connection_id\": \"conn_abc123\",\n  \"status\": \"pending\",\n  \"is_active\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/buckets/{bucket_id}/syncs/list")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"connection_id\": \"conn_abc123\",\n  \"status\": \"pending\",\n  \"is_active\": true\n}"

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

{
  "results": [
    {
      "bucket_id": "<string>",
      "connection_id": "<string>",
      "internal_id": "<string>",
      "namespace_id": "<string>",
      "source_path": "<string>",
      "created_by_user_id": "<string>",
      "locked": true,
      "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_delete": true,
        "on_update": true,
        "on_filter_drift": true,
        "re_extract_on_update": true,
        "re_extract_fields": [
          "<string>"
        ]
      },
      "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",
      "per_shard_last_sync_at": {},
      "next_sync_at": "2023-11-07T05:31:56Z",
      "last_error": "<string>",
      "consecutive_failures": 0,
      "provider_filters": {},
      "source_type": "<string>",
      "metadata": {},
      "locked_by_worker_id": "<string>",
      "locked_at": "2023-11-07T05:31:56Z",
      "lock_expires_at": "2023-11-07T05:31:56Z",
      "pending_full_sync": false,
      "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,
      "current_cursor": "<string>",
      "sync_checkpoints": {},
      "schedule": {},
      "sync_progress": {}
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "page_size": 123,
    "total_pages": 123,
    "next_page": "<string>",
    "previous_page": "<string>",
    "next_cursor": "<string>"
  },
  "total": 123
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

POST

buckets

{bucket_id}

syncs

list

List Sync Configurations

curl --request POST \
  --url https://api.mixpeek.com/v1/buckets/{bucket_id}/syncs/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <api-key>' \
  --data '
{
  "connection_id": "conn_abc123",
  "status": "pending",
  "is_active": true
}
'

import requests

url = "https://api.mixpeek.com/v1/buckets/{bucket_id}/syncs/list"

payload = {
    "connection_id": "conn_abc123",
    "status": "pending",
    "is_active": True
}
headers = {
    "Authorization": "Bearer <token>",
    "X-Namespace": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Namespace': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({connection_id: 'conn_abc123', status: 'pending', is_active: true})
};

fetch('https://api.mixpeek.com/v1/buckets/{bucket_id}/syncs/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mixpeek.com/v1/buckets/{bucket_id}/syncs/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'connection_id' => 'conn_abc123',
    'status' => 'pending',
    'is_active' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Namespace: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.mixpeek.com/v1/buckets/{bucket_id}/syncs/list"

	payload := strings.NewReader("{\n  \"connection_id\": \"conn_abc123\",\n  \"status\": \"pending\",\n  \"is_active\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Namespace", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.mixpeek.com/v1/buckets/{bucket_id}/syncs/list")
  .header("Authorization", "Bearer <token>")
  .header("X-Namespace", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connection_id\": \"conn_abc123\",\n  \"status\": \"pending\",\n  \"is_active\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/buckets/{bucket_id}/syncs/list")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"connection_id\": \"conn_abc123\",\n  \"status\": \"pending\",\n  \"is_active\": true\n}"

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

{
  "results": [
    {
      "bucket_id": "<string>",
      "connection_id": "<string>",
      "internal_id": "<string>",
      "namespace_id": "<string>",
      "source_path": "<string>",
      "created_by_user_id": "<string>",
      "locked": true,
      "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_delete": true,
        "on_update": true,
        "on_filter_drift": true,
        "re_extract_on_update": true,
        "re_extract_fields": [
          "<string>"
        ]
      },
      "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",
      "per_shard_last_sync_at": {},
      "next_sync_at": "2023-11-07T05:31:56Z",
      "last_error": "<string>",
      "consecutive_failures": 0,
      "provider_filters": {},
      "source_type": "<string>",
      "metadata": {},
      "locked_by_worker_id": "<string>",
      "locked_at": "2023-11-07T05:31:56Z",
      "lock_expires_at": "2023-11-07T05:31:56Z",
      "pending_full_sync": false,
      "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,
      "current_cursor": "<string>",
      "sync_checkpoints": {},
      "schedule": {},
      "sync_progress": {}
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "page_size": 123,
    "total_pages": 123,
    "next_page": "<string>",
    "previous_page": "<string>",
    "next_cursor": "<string>"
  },
  "total": 123
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

Authorizations

Authorization

string

header

required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.

X-Namespace

string

header

required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

Path Parameters

bucket_id

string

required

Query Parameters

limit

integer | null

Required range: 1 <= x <= 1000

page_size

integer | null

Required range: 1 <= x <= 1000

offset

integer | null

Required range: 0 <= x <= 10000

page

integer | null

Required range: x >= 1

cursor

string | null

next_cursor

string | null

after

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,

INTERRUPTED,

UNKNOWN,

SKIPPED,

DRAFT,

ACTIVE,

ARCHIVED,

SUSPENDED,

DEACTIVATED

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

Show child attributes

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.

Show child attributes

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

Organization

Namespaces

Buckets

Feature Extractors

Batch Queue

Collections

Documents

Retrievers

Taxonomies

Clusters

Triggers

Alerts

Webhooks

Apps

Agent Sessions

Annotations

Templates

Manifest

Discovery

Analytics

Notifications

Tasks

Inference

Resource Search

Pricing

Events

Onboarding

List Sync Configurations

Authorizations

Path Parameters

Query Parameters

Body

Response