Skip to main content
GET
https://api.pictory.ai
/
pictoryapis
/
v1
/
vimeo-connections
Get Vimeo Connections
curl --request GET \
  --url https://api.pictory.ai/pictoryapis/v1/vimeo-connections \
  --header 'Authorization: <authorization>'
{
  "Items": [
    {
      "connectionId": "20251004004125558w7qnfweid5ilsos",
      "name": "Pictory API",
      "clientIdentifier": "925dbcbdc591d6463c5e289a3825e1a3e0602b97",
      "type": "VIMEO",
      "enabled": true,
      "createdDate": "2025-10-04T00:41:24.597Z",
      "updatedDate": "2025-10-04T00:41:24.597Z",
      "version": 1
    },
    {
      "connectionId": "20251222155613307xv0nodhitf9cd0f",
      "name": "Test Vimeo Connection",
      "description": "Testing Vimeo connection via API",
      "clientIdentifier": "test_client_id_123",
      "type": "VIMEO",
      "enabled": true,
      "createdDate": "2025-12-22T15:56:12.309Z",
      "updatedDate": "2025-12-22T15:56:12.309Z",
      "version": 1
    }
  ]
}

​
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

GET https://api.pictory.ai/pictoryapis/v1/vimeo-connections

​
Request Parameters

​
Headers

​
Authorization
string
required
API key for authentication (starts with pictai_)
Authorization: YOUR_API_KEY

​
Query Parameters

​
nextPageKey
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

{
  "Items": [
    {
      "connectionId": "20251004004125558w7qnfweid5ilsos",
      "name": "Pictory API",
      "clientIdentifier": "925dbcbdc591d6463c5e289a3825e1a3e0602b97",
      "type": "VIMEO",
      "enabled": true,
      "createdDate": "2025-10-04T00:41:24.597Z",
      "updatedDate": "2025-10-04T00:41:24.597Z",
      "version": 1
    },
    {
      "connectionId": "20251222155613307xv0nodhitf9cd0f",
      "name": "Test Vimeo Connection",
      "description": "Testing Vimeo connection via API",
      "clientIdentifier": "test_client_id_123",
      "type": "VIMEO",
      "enabled": true,
      "createdDate": "2025-12-22T15:56:12.309Z",
      "updatedDate": "2025-12-22T15:56:12.309Z",
      "version": 1
    }
  ]
}

​
Code Examples

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 key

curl --request GET \
  --url https://api.pictory.ai/pictoryapis/v1/vimeo-connections \
  --header 'Authorization: YOUR_API_KEY' | python -m json.tool

​
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: 
GET https://api.pictory.ai/pictoryapis/v1/vimeo-connections?nextPageKey=eyJsYXN0RXZhbHVhdGVkS2V5Ijp7fX0=

​
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 normal if you haven’t created any Vimeo connections yet
  • Use the Create Vimeo Connection endpoint to add your first connection
  • Verify you’re using the correct API key for your account
Cause: Getting the same results when using nextPageKey or pagination not workingSolution:
  • Ensure you’re passing the nextPageKey value exactly as returned (Base64-encoded)
  • Don’t modify or decode the nextPageKey value before sending it
  • If no nextPageKey is returned in the response, you’ve reached the end of results
  • The nextPageKey is only valid for the current result set