Get funnel details

Retrieves detailed information about a specific funnel including its videos

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

GET /funnels/{funnel_id}

Returns a single funnel with its full list of videos and per‑video position/role data.

📘

Authorization

Requires a valid API Key in the Authorization header. Send the key directly — no Bearer prefix.

HTTP Method & Path

GET /funnels/get/{funnel_id}

Base URL: https://api-v2.pandavideo.com.br

Path Parameters

NameTypeRequiredDescription
funnel_idstring (uuid)yesFunnel identifier.

Response

Success Response (200)

{
  "message": "Funnel found",
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Sales Funnel Q1",
    "organization_id": "11111111-2222-3333-4444-555555555555",
    "videos": [
      {
        "id": "f1f2f3f4-aaaa-bbbb-cccc-d1d2d3d4d5d6",
        "name": "Welcome",
        "description": null,
        "status": "converted",
        "created_at": "2025-01-15T10:00:00.000Z",
        "updated_at": "2025-01-15T10:00:00.000Z",
        "metadata": { "length": 90 },
        "converted_at": "2025-01-15T10:15:00.000Z",
        "folder_id": "99999999-8888-7777-6666-555555555555",
        "video_external_id": "abc123",
        "library_id": "lib_xyz",
        "live_id": null,
        "config": {},
        "backup_source": null,
        "video_external_source": null,
        "front_coordinates": { "x": 120, "y": 50 },
        "is_first": true
      }
    ]
  }
}

Response Schema

FieldTypeDescription
data.idstring (uuid)Funnel identifier.
data.namestringFunnel display name.
data.organization_idstring (uuid)Owning organization.
data.videos[]arrayVideos in the funnel (empty if none).
data.videos[].idstring (uuid)Video identifier.
data.videos[].namestringVideo title (mapped from video.title).
data.videos[].descriptionstring | nullVideo description.
data.videos[].statusstringVideo processing status.
data.videos[].metadataobjectIncludes length (seconds).
data.videos[].video_external_idstringExternal provider id used by the player.
data.videos[].library_idstringLibrary that owns the video.
data.videos[].folder_idstring (uuid) | nullSame as the funnel's folder_id once the video is added.
data.videos[].front_coordinates{ x: number, y: number }Position in the dashboard editor.
data.videos[].is_firstbooleantrue for the funnel entry video (present only when true).

Error Responses

  • 404 — funnel not found.
  • 403 — user does not belong to the funnel's organization ("User does not have permission to get this funnel.").
  • 401 — missing/invalid API Key.
  • 500 — internal error.

Example Usage

cURL

curl --request GET \
  --url 'https://api-v2.pandavideo.com.br/funnels/get/a1b2c3d4-e5f6-7890-abcd-ef1234567890' \
  --header 'Authorization: <your-api-key>'

Recipes

Path Params
uuid
required

Unique identifier of the funnel

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json