Get metadata descriptor rows

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://api-docs.kitsu.cloud/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "Kitsu API MCP server": {
    "url": "https://api-docs.kitsu.cloud/mcp"
  }
}
Close
GET /data/metadata-descriptors
Jwt authorization

Get the metadata descriptor rows. Add a query parameter for each column to filter on, for example name=Modeling. The name filter does not make a difference between upper case and lower case. To get the rows that have one value of a list, give the list in JSON, for example task_status_id=["",""]. If you are not an administrator, you get only the descriptors of the open projects of your team. Your role on each project sets what you get. A client gets only the descriptors for clients. A vendor gets only the descriptors of their departments or of no department.

Query parameters

  • page integer

    Page to get. Without this parameter, the response has all the rows.

  • limit integer

    Number of rows in a page. The default value is 100.

  • cursor_id string(uuid)

    Without page, id of the last row of the previous request. With limit, it walks the whole list from the newest created row to the oldest, request after request, until one returns fewer rows than limit

  • relations boolean

    Add the departments of each descriptor. Without any query parameter, the response includes the departments of each descriptor. With a query parameter, give relations=true to get them.

  • fields string

    Comma-separated list of the fields to get for each row. The response always has id and type. The names that are not fields are ignored.

Responses

  • 200 application/json

    The list of metadata descriptor rows, or a page of rows if you give page

    One of:
    array-1 array[object] object-2 object
    Hide attributes Show attributes object
    • id string(uuid)
    • name string
    • field_name string
    • data_type string
    • project_id string(uuid)
    • created_at string(date-time)
    • updated_at string(date-time)
  • 400

    A filter is not valid

  • 403

    You cannot read these rows

GET /data/metadata-descriptors 
curl -X GET "http://api.example.com/data/metadata-descriptors/?page=1&limit=50&relations=true" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"
import requests

url = "http://api.example.com/data/metadata-descriptors/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json"
}
params = {
    "page": 1,
    "limit": 50,
    "relations": true
}
payload = None

response = requests.get(
    url,
    headers=headers,
    params=params,
    json=payload
)

response.raise_for_status()

if response.content:
    print(response.json())
Response examples (200) 
[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c250",
    "name": "Custom Field",
    "field_name": "custom_field",
    "data_type": "text",
    "project_id": "b24a6ea4-ce75-4665-a070-57453082c250",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
]
{
  "data": [
    {}
  ],
  "total": 42,
  "nb_pages": 42,
  "limit": 42,
  "offset": 42,
  "page": 42
}