Skip to main content
GET
Get Vimeo Connections

Overview

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.

API Endpoint


Request Parameters

Headers

string
required
API key for authentication (starts with pictai_)

Query Parameters

string
Base64-encoded pagination token for retrieving the next page of results. Returned in the previous response when more results are available.Example: "eyJsYXN0RXZhbHVhdGVkS2V5Ijp7fX0="

Response

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.

Response Examples


Code Examples

Replace YOUR_API_KEY with your actual API key that starts with pictai_

Pagination

This endpoint supports pagination for handling large result sets:
  1. First Request: Make initial request without the nextPageKey parameter
  2. Check for More Results: If the response includes nextPageKey, additional results are available
  3. Subsequent Requests: Include the nextPageKey value as a query parameter to retrieve the next page
Example with pagination:

Error Handling

Cause: Invalid or missing API keySolution:
  • Verify your API key is correct and starts with pictai_
  • Check the Authorization header is properly formatted: YOUR_API_KEY
  • Ensure your API key hasn’t expired
  • Get a new API key from the API Access page
Cause: No Vimeo connections exist in your accountSolution:
  • This is expected if you have not created any Vimeo connections yet
  • Use the Create Vimeo Connection endpoint to add your first connection
  • Verify you are using the correct API key for your account
Cause: Getting the same results when using nextPageKey or pagination not workingSolution:
  • Ensure you are passing the nextPageKey value exactly as returned (Base64-encoded)
  • Do not modify or decode the nextPageKey value before sending it
  • If no nextPageKey is returned in the response, you have reached the end of results
  • The nextPageKey is only valid for the current result set