Skip to main content
GET
https://api.pictory.ai
/
pictoryapis
/
v1
/
vimeo-connections
/
{connectionid}
Get Vimeo Connection by ID
curl --request GET \
  --url https://api.pictory.ai/pictoryapis/v1/vimeo-connections/{connectionid} \
  --header 'Authorization: <authorization>'
{
  "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 detailed information about a specific Vimeo connection using its unique identifier. For security, sensitive credentials (client secret and access token) are excluded from the response. The connection must belong to your account.
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/{connectionid}

​
Request Parameters

​
Headers

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

​
Path Parameters

​
connectionid
string
required
The unique identifier of the Vimeo connection to retrieveExample: "20251222155613307xv0nodhitf9cd0f"

​
Response

Returns the Vimeo connection object with all configuration details including connectionId, name, description, clientIdentifier, type, enabled status, createdDate, updatedDate, and version number. For security, sensitive credentials (clientSecret and accessToken) are never returned in API responses.

​
Response Examples

{
  "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 a specific Vimeo connection by ID
# Replace YOUR_API_KEY with your actual API key
# Replace CONNECTION_ID with the actual connection ID

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

​
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: The connection ID doesn’t exist or you don’t have access to itSolution:
  • Verify the connection ID is correct and complete
  • Ensure the connection belongs to your account
  • Check if the connection has been deleted
  • Connection IDs are case-sensitive - confirm the exact casing
  • Use the Get Vimeo Connections endpoint to list all your connections
Cause: The returned connection details don’t match expectationsSolution:
  • Double-check the connection ID in the URL path
  • Verify you’re using the correct API key for the account that owns the connection
  • Ensure you haven’t confused this connection with another one
  • Check if the connection was recently updated by someone else