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

title

title
Resource Index

Resource Index Endpoint

The resource index endpoint returns a listing of external resources.

URL

GET /resource/

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
sort	No	The list of fields to sort the resources

Allowed Sort Fields

Name	Description
id	Sort resources on the primary key
link	Sort resources on the URL of the resource
external_id	Sort resources on the identifier of the resource on the external site
site	Sort resources on the premiere year 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
link	Filter resources on the URL of the resource
external_id	Filter resources on the identifier of the resource on the external site
site	Filter resources on the premiere year 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

{
    resources: [
        {
            id: id,
            link: "link",
            external_id: external_id,
            site: "site",
            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/resource/