List series

List series

get

Authorizations

bearerAuth

AuthorizationstringRequired

Your ShortGenius API token

Query parameters

pagenumberOptional

The page number to retrieve.

Default: 0

limitnumber · max: 200Optional

The maximum number of items per page.

Default: 50

Responses

200

Successful response

application/json

400

Invalid request

application/json

get

/series

HTTPcURLJavaScriptPython

GET /api/v1/series HTTP/1.1
Host: shortgenius.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "series": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "text",
      "updated_at": null,
      "next_posting_at": null,
      "type": "SingleVideo",
      "schedule": {
        "time_zone": "Pacific/Pago_Pago",
        "times": [
          {
            "day_of_week": 1,
            "time_of_day": 1
          }
        ]
      },
      "content_type": "Custom",
      "name": null,
      "aspect_ratio": "9:16",
      "soundtrack_behavior": "MutedAfter60s",
      "prompt": null,
      "tiktok_settings": {
        "disable_duet": null,
        "disable_stitch": null,
        "disable_comment": null,
        "privacy_level": "PUBLIC_TO_EVERYONE",
        "disclose_video_content": null,
        "brand_content_toggle": null,
        "brand_organic_toggle": null,
        "consent_to_use": null
      },
      "youtube_settings": {
        "privacy_level": "public",
        "self_declared_made_for_kids": null
      },
      "x_settings": {
        "post_as_a_thread": null
      },
      "locale": "af-ZA",
      "soundtrack": {
        "tracks": [
          {
            "id": "text",
            "url": "text"
          }
        ],
        "recommendations": [
          {
            "id": "text",
            "url": "text",
            "reason": "text"
          }
        ],
        "playback_rate": 1,
        "volume": 1
      },
      "thumbnail": {
        "caption_color": "text",
        "caption_stroke_color": "text",
        "caption_stroke_width": 1,
        "caption_alignment": "top-left",
        "caption_font_family": "text",
        "caption_font_size": 1,
        "caption_text_transform": "lowercase",
        "text": null,
        "theme": "None",
        "media": {
          "url": null,
          "deleted_at": null,
          "metadata": null,
          "last_error": null,
          "associated_product_id": null,
          "type": "text",
          "category": "Stock",
          "state": "text",
          "source": "text",
          "data": {
            "kind": "text",
            "title": "text",
            "html_title": "text",
            "link": "text",
            "display_link": "text",
            "snippet": "text",
            "html_snippet": "text",
            "mime": "text",
            "file_format": "text",
            "image": {
              "context_link": "text",
              "height": 1,
              "width": 1,
              "byte_size": 1,
              "thumbnail_link": "text",
              "thumbnail_height": 1,
              "thumbnail_width": 1
            }
          }
        }
      },
      "styles": {
        "caption_active_word_background_color": "text",
        "caption_active_word_color": "text",
        "caption_active_word_stroke_width": 1,
        "caption_active_word_stroke_color": "text",
        "caption_alignment": "top-left",
        "caption_animation": "ZoomIn",
        "caption_background_color": "text",
        "caption_background_disabled": true,
        "caption_color": "text",
        "caption_display": "karaoke",
        "caption_font_family": "text",
        "caption_font_size": 1,
        "caption_keyword_color": "text",
        "caption_rotate_occasionally": true,
        "caption_stroke_width": 1,
        "caption_stroke_color": "text",
        "caption_text_transform": "lowercase"
      },
      "image_style": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "recommendations": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "reason": "text"
          }
        ]
      },
      "voice": {
        "voices": [
          {
            "id": "text",
            "name": "text",
            "description": null,
            "avatar_url": null,
            "flag_url": null,
            "tags": {
              "language": null,
              "accent": null,
              "age": null,
              "category": null,
              "gender": null,
              "tone": null,
              "useCase": null
            },
            "preview_url": null,
            "locale": "af-ZA",
            "source": "Cartesia"
          }
        ],
        "playback_rate": 1,
        "volume": 1
      },
      "custom_watermark": {
        "caption_color": "text",
        "caption_stroke_color": "text",
        "caption_stroke_width": 1,
        "caption_alignment": "top-left",
        "caption_font_family": "text",
        "caption_font_size": 1,
        "caption_text_transform": "lowercase",
        "text": ""
      },
      "connections": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "Email",
          "name": null
        }
      ],
      "hashtags": null
    }
  ],
  "has_more": true
}