The various entity endpoints like /characters
, /locations
etc support many filters.
To get a list of filters, first call /filters
to get the endpoint for each entity type.
Method | URI | Headers |
---|---|---|
GET/HEAD | filters |
Default |
{
"data": [
{
"code": "character",
"url": ".../filters/1"
},
{
"code": "family",
"url": ".../filters/2"
},
]
}
To get a list of available filters for the characters endpoint, call the following endpoint.
Method | URI | Headers |
---|---|---|
GET/HEAD | filters/1 |
Default |
{
"data": [
"title",
"age",
"sex",
"pronouns",
"location_id",
"is_dead",
"member_id",
"race_id",
"family_id",
"races",
"name",
"type",
"is_private",
"template",
"tag_id",
"tags",
"has_image",
"has_posts",
"has_entity_files",
"has_attributes",
"created_by",
"updated_by",
"attribute_name",
"attribute_value"
]
}