---
title: "List excluded videos"
method: GET
path: "/videos/excluded"
tags: ["Video Analytics"]
---

# List excluded videos

`GET /videos/excluded`

## Request

- Base URL: `https://viral.app/api/v1`
- URL: `https://viral.app/api/v1/videos/excluded`
- Auth: API key in header `x-api-key`

Retrieves paginated excluded videos scoped to the active organization.

## Query parameters

- `page` number: Page number (1-based index)
- `perPage` number: Number of items per page (1-100)
- `sortCol` string: Sort column
- `sortDir` 'asc' | 'desc': Sort direction
- `search` string
- `accounts` string[], nullable: Organization account IDs
- `platforms` string[], nullable: Social media platforms (facebook, instagram, tiktok, youtube, snapchat)

## Response `200`

OK

- object: Paginated excluded videos response
  - `data` object[], required
    - `id` string, required
    - `orgId` string, required: Organization ID with org_ prefix
    - `orgAccountId` string, required
    - `platform` 'facebook' | 'instagram' | 'tiktok' | 'youtube' | 'snapchat', required: Social media platform (facebook, instagram, tiktok, youtube, snapchat)
    - `platformAccountId` string, required
    - `platformVideoId` string, required
    - `sourceType` 'manual' | 'account_rule' | 'workflow' | 'ai' | 'creative', required: Where the tag on this video comes from: manual (added to the video), account_rule (a tag on its account or creator), workflow (a tag workflow), ai (an AI tagging rule) or creative (a tag on the creative the video is a copy of, which every copy carries; removing it from one copy opts only that copy out)
    - `actorType` 'user' | 'system' | 'api_token', required
    - `userId` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `username` string, nullable, required
    - `accountDisplayName` string, nullable, required
    - `caption` string, nullable, required
    - `thumbnailUrl` string, nullable, required
    - `contentType` string, nullable, required
    - `user` object, nullable, required
      - `id` string, required
      - `name` string, required
      - `image` string, nullable, required
      - `firstName` string, required
      - `lastName` string, required
      - `role` string, nullable, required
  - `pageCount` number, required: Total number of pages
  - `totalRows` number, required: Total number of rows

## Other responses

- `400`: 400
- `401`: 401
- `402`: 402
- `404`: 404
- `408`: 408
- `429`: 429
- `500`: 500

---

[API](https://skmtc.dev/viral/apis/viral-app-api.md) · [All operations](https://skmtc.dev/viral/apis/viral-app-api/llms.txt) · [OpenAPI document](https://skmtc.dev/viral/apis/viral-app-api/revisions/31e97fa79ef1?raw)