Files
animethemes-api-docs/docs/page/index
paranarimasuandGitHub 57dd7eecd7 fix: update links to production domain (#23)
* fix: update links to production domain

* add missing README change
2022-05-31 20:46:45 -05:00
..

title
title
Page Index

Page Index Endpoint

The page index endpoint returns a listing of page resources.

URL

GET /api/page/

Authentication

None

Parameters

Name Required Description
fields No Sparse fieldsets for resource types
filter No Filters for page resources
page[number] No The page of page resources to display
page[size] No The number of page 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
name Sort resources on the title of the page
slug Sort resources on the URL slug of the page
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 page
slug Filter resources on the URL slug of the page
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

{
    pages: [
        {
            id: id,
            name: "name",
            slug: "slug",
            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/page/ ```