DevelopersVideo Intros
List Video Intros
GET/v1/video-intros
Filter by status, member or your own reference to find the Video Intro for a record in your system.
Authentication
A bearer API key. Authentication.
Headers
AuthorizationstringrequiredBearer followed by your API key. A test key works in the test environment only.
Query parameters
statusstringrequested, ready, sent, cancelled or expired.
memberstringA member id.
reference_idstringThe id you sent in reference.
limitintegerHow many to return. Default 20.
starting_afterstringAn identifier from the previous page, to continue after it.
Errors
| Status | Code | When |
|---|---|---|
401 | unauthorized | The API key is missing, malformed or revoked. |
curl https://api.videointros.com/v1/video-intros \
-H "Authorization: Bearer $VIDEO_INTROS_API_KEY"const response = await fetch("https://api.videointros.com/v1/video-intros", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.VIDEO_INTROS_API_KEY}`,
},
});
const result = await response.json();import os, requests
response = requests.get(
"https://api.videointros.com/v1/video-intros",
headers={
"Authorization": f"Bearer {os.environ['VIDEO_INTROS_API_KEY']}",
},
)
result = response.json(){
"object": "list",
"data": [
{
"id": "vi_5b0e7c1e-2a64-4d0f-9b1c-7d2f6a8e9c10",
"object": "video_intro",
"status": "ready",
"touchpoint": null,
"member": {
"id": "mem_3f9a1c27",
"external_id": "rep_456",
"first_name": "Anthony",
"last_name": "Baker"
},
"recipient": {
"first_name": "Andrea",
"last_name": "Smith",
"phone": "+12405550100"
},
"reference": {
"source": "your_app",
"type": "order",
"id": "order_981"
},
"delivery": {
"responsibility": "integration",
"recipient_url": "https://app.videointros.com/your-company/v/…"
},
"metadata": {
"order_id": "order_981"
},
"environment": "test",
"created_at": "2026-10-05T17:40:01Z"
}
],
"has_more": false
}