Retrieve a paginated list of all Vimeo connections associated with your account. The response includes connection metadata while excluding sensitive credentials (client secrets and access tokens) for security.
You need a valid API key to use this endpoint. Get your API key from the API Access page in your Pictory dashboard.
Base64-encoded pagination token for retrieving the next page of results. Returned in the previous response when more results are available.Example:"eyJsYXN0RXZhbHVhdGVkS2V5Ijp7fX0="
Returns a paginated array of Vimeo connection objects in the Items field. Each connection includes connectionId, name, description, clientIdentifier, type, enabled status, timestamps, and version number. If more results are available, a nextPageKey is included for pagination. For security, sensitive credentials (clientSecret and accessToken) are never returned in API responses.
Replace YOUR_API_KEY with your actual API key that starts with pictai_
# Retrieve all Vimeo connections# Replace YOUR_API_KEY with your actual API keycurl --request GET \ --url https://api.pictory.ai/pictoryapis/v1/vimeo-connections \ --header 'Authorization: YOUR_API_KEY' | python -m json.tool
// Replace 'YOUR_API_KEY' with your actual API keyconst getVimeoConnections = async (apiKey, nextPageKey = null) => { const url = new URL('https://api.pictory.ai/pictoryapis/v1/vimeo-connections'); // Add pagination parameter if provided if (nextPageKey) { url.searchParams.append('nextPageKey', nextPageKey); } const response = await fetch(url, { method: 'GET', headers: { 'Authorization': `${apiKey}` } }); if (!response.ok) { const error = await response.json(); throw new Error(`Failed: ${error.message}`); } return await response.json();};// Usagetry { const result = await getVimeoConnections('YOUR_API_KEY'); console.log('Vimeo Connections:', result.Items); console.log('Total Connections:', result.Items.length); // Handle pagination if nextPageKey exists if (result.nextPageKey) { console.log('More results available. Use nextPageKey for next page.'); const nextPage = await getVimeoConnections('YOUR_API_KEY', result.nextPageKey); console.log('Next Page:', nextPage.Items); }} catch (error) { console.error('Error:', error.message);}
# Replace 'YOUR_API_KEY' with your actual API keyimport requestsdef get_vimeo_connections(api_key, next_page_key=None): """Retrieve all Vimeo connections""" url = "https://api.pictory.ai/pictoryapis/v1/vimeo-connections" headers = { "Authorization": api_key } # Add pagination parameter if provided params = {} if next_page_key: params['nextPageKey'] = next_page_key response = requests.get(url, headers=headers, params=params) response.raise_for_status() return response.json()# Usagetry: result = get_vimeo_connections("YOUR_API_KEY") print(f"Vimeo Connections: {result['Items']}") print(f"Total Connections: {len(result['Items'])}") # Handle pagination if nextPageKey exists if 'nextPageKey' in result: print("More results available. Use nextPageKey for next page.") next_page = get_vimeo_connections("YOUR_API_KEY", result['nextPageKey']) print(f"Next Page: {next_page['Items']}")except requests.exceptions.HTTPError as e: error = e.response.json() print(f"Error: {error.get('message', 'Request failed')}")
<?php// Replace 'YOUR_API_KEY' with your actual API keyfunction getVimeoConnections($apiKey, $nextPageKey = null) { $url = 'https://api.pictory.ai/pictoryapis/v1/vimeo-connections'; // Add pagination parameter if provided if ($nextPageKey) { $url .= '?nextPageKey=' . urlencode($nextPageKey); } $ch = curl_init($url); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_HTTPHEADER, [ 'Authorization: ' . $apiKey ]); $response = curl_exec($ch); $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch); if ($httpCode !== 200) { $error = json_decode($response, true); throw new Exception($error['message'] ?? 'Request failed'); } return json_decode($response, true);}// Usagetry { $result = getVimeoConnections('YOUR_API_KEY'); echo "Vimeo Connections:\n"; print_r($result['Items']); echo "Total Connections: " . count($result['Items']) . "\n"; // Handle pagination if nextPageKey exists if (isset($result['nextPageKey'])) { echo "More results available. Use nextPageKey for next page.\n"; $nextPage = getVimeoConnections('YOUR_API_KEY', $result['nextPageKey']); echo "Next Page:\n"; print_r($nextPage['Items']); }} catch (Exception $e) { echo "Error: " . $e->getMessage() . "\n";}?>
// Replace "YOUR_API_KEY" with your actual API keypackage mainimport ( "encoding/json" "fmt" "io" "net/http" "net/url")type VimeoConnection struct { ConnectionID string `json:"connectionId"` Name string `json:"name"` Description string `json:"description"` ClientIdentifier string `json:"clientIdentifier"` Type string `json:"type"` Enabled bool `json:"enabled"` CreatedDate string `json:"createdDate"` UpdatedDate string `json:"updatedDate"` Version int `json:"version"`}type VimeoConnectionsResponse struct { Items []VimeoConnection `json:"Items"` NextPageKey string `json:"nextPageKey,omitempty"`}func getVimeoConnections(apiKey string, nextPageKey string) (*VimeoConnectionsResponse, error) { baseURL := "https://api.pictory.ai/pictoryapis/v1/vimeo-connections" // Add pagination parameter if provided if nextPageKey != "" { params := url.Values{} params.Add("nextPageKey", nextPageKey) baseURL = baseURL + "?" + params.Encode() } req, err := http.NewRequest("GET", baseURL, nil) if err != nil { return nil, err } req.Header.Set("Authorization", apiKey) client := &http.Client{} resp, err := client.Do(req) if err != nil { return nil, err } defer resp.Body.Close() body, err := io.ReadAll(resp.Body) if err != nil { return nil, err } if resp.StatusCode != http.StatusOK { return nil, fmt.Errorf("request failed (status %d): %s", resp.StatusCode, string(body)) } var result VimeoConnectionsResponse if err := json.Unmarshal(body, &result); err != nil { return nil, err } return &result, nil}// Usagefunc main() { result, err := getVimeoConnections("YOUR_API_KEY", "") if err != nil { panic(err) } fmt.Printf("Vimeo Connections: %+v\n", result.Items) fmt.Printf("Total Connections: %d\n", len(result.Items)) // Handle pagination if nextPageKey exists if result.NextPageKey != "" { fmt.Println("More results available. Use nextPageKey for next page.") nextPage, err := getVimeoConnections("YOUR_API_KEY", result.NextPageKey) if err != nil { panic(err) } fmt.Printf("Next Page: %+v\n", nextPage.Items) }}