animethemes-api-docs/docs/anime/index

title

title
Anime Index

Anime Index Endpoint

The anime index endpoint returns a listing of anime resources.

URL

GET /api/anime/

Authentication

None

Parameters

Name	Required	Description
fields	No	Sparse fieldsets for resource types
filter	No	Filters for anime resources & constraining the inclusion of related resources
include	No	Inclusion of related resources
page[number]	No	The page of anime resources to display
page[size]	No	The number of anime resources to display for the current page
q	No	The query to search for matching anime resources
sort	No	The list of fields to sort the resources

Allowed Sort Fields

Name	Description
id	Sort resources on the primary key
name	Sort resources on the title of the anime
slug	Sort resources on the URL slug of the anime
year	Sort resources on the premiere year of the anime
season	Sort resources on the premiere season of the anime
synopsis	Sort resources on the brief summary of the anime
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
name	Filter resources on the title of the anime
slug	Filter resources on the URL slug of the anime
year	Filter resources on the premiere year of the anime
season	Filter resources on the premiere season of the anime
synopsis	Filter resources on the brief summary of the anime
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}
has	Filter resources on relations within allowed include paths

Response

{
    anime: [
        {
            id: id,
            name: "name",
            slug: "slug",
            year: year,
            season: "season",
            synopsis: "synopsis",
            created_at: "created_at",
            updated_at: "updated_at",
            deleted_at: "deleted_at"
        },
        ...
    ],
    links: {
        first: "first",
        last: "last",
        prev: "prev",
        next: "next"
    },
    meta: {
        current_page: current_page,
        from: from,
        path: "path",
        per_page: per_page,
        to: to
    }
}

```bash curl https://api.animethemes.moe/anime/ ```