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

title

title
Artist Song Index

Artist Song Index Endpoint

The artist song index endpoint returns a listing of artist song resources.

URL

GET /artistsong/

Authentication

None

Parameters

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

Allowed Sort Fields

Name	Description
created_at	Sort resources on the resource creation date
updated_at	Sort resources on the resource last modified date
alias	Sort resources on distinguishing label for performance by alias
as	Sort resources on distinguishing label for performance by character

Filters

Name	Description
created_at	Filter resources on the resource creation date
updated_at	Filter resources on the resource last modified date
has	Filter resources on relations within allowed include paths
alias	Filter resources on distinguishing label for performance by alias
as	Filter resources on distinguishing label for performance by character

Response

{
    artistsongs: [
        {
            created_at: "created_at",
            updated_at: "updated_at",
            alias: "alias",
            as: "as"
        },
        ...
    ],
    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/artistsong/