Choose search, list, or get-by-id when you look up chapters and events. Page results with page and page_size. Search endpoints also have a 50-requests-per-minute ceiling on top of the account daily limit.
Use this page when you need to discover chapters or events through the public API. Shared base URL, authentication, status codes, and account rate limits stay in Using public Bevy APIs. Parameter and field details stay in Bevy API Reference.
Choose search, list, or get by ID
| When you… | Use | Example paths |
|---|---|---|
| Match text, location, or other discovery filters | Search | /api/search/chapter/, /api/search/event/ |
| Walk the collection with filters and paging | List | /api/chapter/, /api/event/ |
| Already know the resource ID | Get by ID | /api/chapter/{id}/, /api/event/{id}/ |
Prefer get-by-id when you already have the ID. Prefer search when you are matching a query or geo radius. Prefer list when you need a paged walk of the collection with the list endpoint’s filters.
Page through results
List and search responses return one page at a time. Control the page with these query parameters:
page— which page to return (starts at 1)page_size— how many records to return on that page
Paged responses typically include:
results— the records for the current pagecount— total matching records (when the endpoint provides a count)links.next/links.previous— ready-made URLs for neighboring pages when more pages exist
Omit page to start on page 1. If you omit page_size, Bevy uses the endpoint default. Asking for a page_size above the endpoint ceiling is capped — check Bevy API Reference for each operation’s parameters.
Example:
GET /api/chapter/?page=2&page_size=50
Search chapters and events
Search is for discovery — text match, optional geo radius, and other search filters documented in the reference.
- Chapters:
GET /api/search/chapter/ - Events:
GET /api/search/event/
Common search parameters include q (query text) and, when searching near a point, latitude, longitude, and around_radius (kilometers). Event search also accepts filters such as status, chapter, and region_id. Full parameter lists stay in Bevy API Reference.
Important: Every path under /api/search/** has an extra ceiling of 50 requests per minute per user (or per IP when anonymous), in addition to the account daily limit. When you exceed a limit, Bevy returns 429 with a Retry-After header. Shared rate-limit rules are in Using public Bevy APIs.
List and get chapters
- List:
GET /api/chapter/— paged collection of chapters - Get by ID:
GET /api/chapter/{id}/— one chapter
Use list when you need to walk chapters with list filters and page / page_size. Use get-by-id when you already have the chapter ID from a previous call, webhook, or admin workflow.
List and get events
- List:
GET /api/event/— paged collection of events - Get by ID:
GET /api/event/{id}/— one event
You can also list events for one chapter with GET /api/chapter/{chapter}/event/. Prefer get-by-id when you already have the event ID.
Look up chapter regions and status
Chapter records can include region and status values. Use these helpers to resolve what those values mean on your instance:
- Regions:
GET /api/chapter_region/(andGET /api/chapter_region/{id}/for one region) - Status definitions:
GET /api/chapter/status/
Call these when you need the region or status vocabulary for filters or for interpreting a chapter payload. Do not treat them as chapter search — they return the lookup lists, not chapter matches.
Tip: For request headers, authentication, and account-wide rate limits, see Using public Bevy APIs. For every parameter and response field, open the matching operation in Bevy API Reference.