Endpoints
Endpoints
All ten read-only v1 endpoints for public sessions, characters, locations, factions and items in one campaign.
All endpoints use GET and the bearer header. Your key picks out the campaign. Add the paths shown below to https://app.saga20.com.
Endpoint reference
Requests for a list take limit and cursor, and what comes back holds data along with pagination. A request for a single record gives the record back on its own, with no data wrapper. Take ids from the matching list response.
| Method | Path | Returns |
|---|---|---|
GET |
/api/public/v1/sessions |
Public session metadata. |
GET |
/api/public/v1/sessions/{id} |
One public session with summary_markdown and summary_text. |
GET |
/api/public/v1/characters |
Wiki-visible character metadata, including is_player_character. |
GET |
/api/public/v1/characters/{id} |
One wiki-visible character with description_markdown and description_text. |
GET |
/api/public/v1/locations |
Wiki-visible location metadata, including type, parent_id and image_url. |
GET |
/api/public/v1/locations/{id} |
One wiki-visible location with description_markdown and description_text. |
GET |
/api/public/v1/factions |
Wiki-visible faction metadata, including image_url. |
GET |
/api/public/v1/factions/{id} |
One wiki-visible faction with description_markdown and description_text. |
GET |
/api/public/v1/items |
Wiki-visible item metadata, including image_url. |
GET |
/api/public/v1/items/{id} |
One wiki-visible item with description_markdown and description_text. |
Shared behavior
Visibility and content formatting are covered in what the API returns. Each list shares the same pagination, and requests also share the rate limits.
To learn the status codes and the exact error bodies, look at errors.