Skip to main content
POST
/
v1
/
organizations
/
connections
/
list
List Storage Connections
curl --request POST \
  --url https://api.mixpeek.com/v1/organizations/connections/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider_type": "google_drive",
  "is_active": true
}
'
import requests

url = "https://api.mixpeek.com/v1/organizations/connections/list"

payload = {
"provider_type": "google_drive",
"is_active": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({provider_type: 'google_drive', is_active: true})
};

fetch('https://api.mixpeek.com/v1/organizations/connections/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/organizations/connections/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([
'provider_type' => 'google_drive',
'is_active' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$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/organizations/connections/list"

payload := strings.NewReader("{\n \"provider_type\": \"google_drive\",\n \"is_active\": true\n}")

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

req.Header.Add("Authorization", "Bearer <token>")
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/organizations/connections/list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"provider_type\": \"google_drive\",\n \"is_active\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/organizations/connections/list")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"provider_type\": \"google_drive\",\n \"is_active\": true\n}"

response = http.request(request)
puts response.read_body
{
  "results": [
    {
      "internal_id": "<string>",
      "provider_config": {
        "credentials": {
          "client_email": "sync@mixpeek-prod-456.iam.gserviceaccount.com",
          "client_id": "123456789012345678901",
          "private_key": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n",
          "private_key_id": "a1b2c3d4e5f6...",
          "project_id": "mixpeek-prod-456",
          "type": "service_account"
        },
        "provider_type": "google_drive",
        "shared_drive_id": "0AH-Xabc123def456"
      },
      "name": "<string>",
      "created_by_user_id": "<string>",
      "connection_id": "<string>",
      "description": "Shared drive for marketing team assets and campaign materials",
      "status": "ACTIVE",
      "is_active": true,
      "last_used_at": "2023-11-07T05:31:56Z",
      "last_error": "Authentication failed: Invalid credentials",
      "consecutive_failures": 0,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "page_size": 123,
    "total_pages": 123,
    "next_page": "<string>",
    "previous_page": "<string>",
    "next_cursor": "<string>"
  },
  "total": 1
}
{
"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>"
}
]
}
{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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
include_total
boolean
default:false

Body

application/json

Request payload for listing storage connections with filters.

Use this to filter connections by provider type, status, or active flag. Results are paginated automatically.

Use Cases:

  • List all active Google Drive connections
  • Find failed connections that need attention
  • Filter by provider type for sync configuration

Examples:

# List all active Google Drive connections
{
"provider_type": "google_drive",
"is_active": True
}

# Find failed connections
{
"status": "failed"
}
provider_type
enum<string> | null

OPTIONAL. Filter connections by provider type. Supported: google_drive, s3, snowflake, sharepoint, tigris. If not provided, returns connections of all types.

Available options:
google_drive,
s3,
snowflake,
sharepoint,
tigris,
postgresql,
instagram,
tiktok,
rss,
http_api,
box,
brightdata,
backblaze,
mux,
email,
supabase,
iconik
Example:

"google_drive"

status
enum<string> | null

OPTIONAL. Filter connections by operational status. ACTIVE: Healthy and ready for use. SUSPENDED: Temporarily disabled. FAILED: Health checks failing. ARCHIVED: Permanently retired.

Available options:
PENDING,
QUEUED,
IN_PROGRESS,
PROCESSING,
COMPLETED,
COMPLETED_WITH_ERRORS,
FAILED,
CANCELED,
INTERRUPTED,
UNKNOWN,
SKIPPED,
DRAFT,
ACTIVE,
ARCHIVED,
SUSPENDED
is_active
boolean | null

OPTIONAL. Filter by active flag. True: Returns only active connections (status=ACTIVE). False: Returns only inactive connections (SUSPENDED/FAILED/ARCHIVED). If not provided, returns connections of all active states.

Response

Successful Response

Response envelope for listing storage connections.

Contains paginated results and metadata about the listing operation.

results
StorageConnectionModel · object[]
required

List of storage connections matching the request filters. Results are paginated according to the pagination parameters. SECURITY: Sensitive credential fields are automatically redacted.

pagination
PaginationResponse · object
required

Pagination metadata including total count, page number, page size, and navigation links for next/previous pages.

total
integer
required

Total number of connections matching the filters (before pagination). Use this to calculate total pages and display pagination controls.

Required range: x >= 0
Examples:

0

5

42