Skip to content
Video IntrosDevelopers
TestLive not yet available
videointros.com

Preview Developer preview. The API described here is not available yet. Examples are illustrative and every console screen uses sample data: nothing is sent, created or stored.

Events

List events

GET/v1/events

Each accepted request is an event you can look up later: what you sent, the touchpoint and member it resolved to, and the Video Intro it produced.

Authentication

A bearer API key. Authentication.

Headers

  • Authorizationstringrequired

    Bearer followed by your API key. A test key works in the test environment only.

Query parameters

  • statusstring

    accepted, duplicate, processed or failed.

  • touchpointstring

    A touchpoint slug.

  • limitinteger

    How many to return. Default 20.

  • starting_afterstring

    An identifier from the previous page, to continue after it.

Errors

StatusCodeWhen
401
unauthorized
The API key is missing, malformed or revoked.

All errors

Request
curl https://api.videointros.com/v1/events \
  -H "Authorization: Bearer $VIDEO_INTROS_API_KEY"
const response = await fetch("https://api.videointros.com/v1/events", {
  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/events",
    headers={
        "Authorization": f"Bearer {os.environ['VIDEO_INTROS_API_KEY']}",
    },
)
result = response.json()
Response · 200
{
  "object": "list",
  "data": [
    {
      "id": "evt_8f3c2a71d04e",
      "object": "touchpoint_event",
      "status": "processed",
      "touchpoint": "new_appointment",
      "environment": "test",
      "created_at": "2026-10-05T17:40:01Z",
      "video_intro": "vi_5b0e7c1e-2a64-4d0f-9b1c-7d2f6a8e9c10"
    }
  ],
  "has_more": false
}