mirror of
https://github.com/AnimeThemes/animethemes-api-docs.git
synced 2026-07-11 01:34:06 +02:00
Kyrch
77 lines
2.3 KiB
Markdown
77 lines
2.3 KiB
Markdown
---
|
|
title: Anime Studio Index
|
|
---
|
|
|
|
# Anime Studio Index Endpoint
|
|
|
|
The anime studio index endpoint returns a listing of anime studio resources.
|
|
|
|
## URL
|
|
|
|
```sh
|
|
GET /animestudio/
|
|
```
|
|
|
|
## Authentication
|
|
|
|
None
|
|
|
|
## Parameters
|
|
|
|
| Name | Required | Description |
|
|
| :----------: | :------: | :----------------------------------------------------------------------------------- |
|
|
| fields | No | Sparse fieldsets for resource types |
|
|
| filter | No | Filters for anime studio resources & constraining the inclusion of related resources |
|
|
| include | No | Inclusion of related resources |
|
|
| page[number] | No | The page of anime studio resources to display |
|
|
| page[size] | No | The number of anime studio 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 |
|
|
|
|
## 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 |
|
|
|
|
## Response
|
|
|
|
```json
|
|
{
|
|
animestudios: [
|
|
{
|
|
created_at: "created_at",
|
|
updated_at: "updated_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
|
|
}
|
|
}
|
|
```
|
|
|
|
## Example
|
|
|
|
```bash
|
|
curl https://api.animethemes.moe/animestudio/
|
|
```
|