animethemes-api-docs/docs/jsonapi/reference/content/videoscript/index/index.md

title

title
Video Script Index

Video Script Index Endpoint

The video script index endpoint returns a listing of video script resources.

URL

GET /videoscript/

Authentication

None

Parameters

Name	Required	Description
fields	No	Sparse fieldsets for resource types
filter	No	Filters for video script resources
include	No	Inclusion of related resources
page[number]	No	The page of video script resources to display
page[size]	No	The number of video script resources to display for the current page
sort	No	The list of fields to sort the video script resources

Allowed Sort Fields

Name	Description
id	Sort resources on the primary key
path	Sort resources on the path of the file in storage
created_at	Sort resources on the resource creation date
updated_at	Sort resources on the resource last modified date
deleted_at	Sort resources on the resource deletion date
random	Sort resources randomly. Ignored if other sort fields are provided.

Filters

Name	Description
id	Filter resources on the primary key
path	Filter resources on the path of the file in storage
created_at	Filter resources on the resource creation date
updated_at	Filter resources on the resource last modified date
deleted_at	Filter resources on the resource deletion date
trashed	Filter resources on trashed (deleted) status [With, Without, Only]

Response

{
    videoscripts: [
        {
            id: id,
            path: "path",
            created_at: "created_at",
            updated_at: "updated_at",
            deleted_at: "deleted_at",
            link: "link"
        },
        ...
    ],
    links: {
        first: "first",
        last: "last",
        prev: "prev",
        next: "next"
    },
    meta: {
        current_page: current_page,
        from: from,
        path: "path",
        per_page: per_page,
        to: to
    }
}

Example

curl https://api.animethemes.moe/videoscript/