list_author
Retrieve Author instances with filtering, searching, ordering, and pagination. Supports advanced field lookups and relation paths for precise results.
Instructions
List Author instances with filtering, searching, ordering, and pagination.
Filter lookups: field (exact), field__iexact, field__contains, field__icontains, field__startswith, field__istartswith, field__endswith, field__iendswith, field__gt, field__gte, field__lt, field__lte, field__in, field__range, field__isnull; date fields also take field__year, field__month, field__day (and field__date on datetimes), optionally followed by a comparison (field__year__gte). Relation paths (e.g. category__slug) and custom filter parameters work only when the admin declares them in list_filter / date_hierarchy: describe_author lists them under admin_config.filters. Invalid filters return an error.
Available fields:
articles (ForeignKey)
id (BigAutoField)
name (CharField) [required]
email (CharField) [required]
bio (TextField)
created_at (DateTimeField)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of items to return (default: 100) | |
| offset | No | Number of items to skip (default: 0) | |
| search | No | Search term to match against searchable fields | |
| filters | No | Filter criteria. Keys are field names with optional lookups (e.g., {'status': 'published', 'created_at__gte': '2024-01-01'}), or filter names listed by describe under admin_config.filters | |
| order_by | No | Fields to order by. Prefix with '-' for descending (e.g., ['-created_at', 'title']) |