# AwardSpring API

## Instructions for AI Agents

- For clean Markdown of any page, append `.md` to the page URL
- For section-specific indexes, append `/llms.txt` to any section URL
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.awardspring.com/_mcp/server

## Docs

- [Introduction](https://docs.awardspring.com/getting-started/introduction.md): What you need to know before your first request.
- [SDKs](https://docs.awardspring.com/getting-started/sd-ks.md): Official client libraries for .NET and PHP.
- [Authentication](https://docs.awardspring.com/conventions/authentication.md): One secret, one institution, on every request.
- [Pagination](https://docs.awardspring.com/conventions/pagination.md): Every list returns one page and the cursor to reach the next.
- [Errors](https://docs.awardspring.com/conventions/errors.md): Branch on code, show message, never parse prose.
- [Idempotency](https://docs.awardspring.com/conventions/idempotency.md): Retry a write without creating it twice.
- [Rate limits](https://docs.awardspring.com/conventions/rate-limits.md): Read the budget off every response rather than guessing.
- [Dry runs](https://docs.awardspring.com/conventions/dry-runs.md): Run every validation rule, write nothing.
- [Webhooks](https://docs.awardspring.com/webhooks/overview.md): AwardSpring calls you when something happens.
- [Verifying signatures](https://docs.awardspring.com/webhooks/verifying-signatures.md): Your endpoint is public. The signature is what makes it yours.
- [Delivery and retries](https://docs.awardspring.com/webhooks/delivery-and-retries.md): What happens between the event and your 200.
- [Event types](https://docs.awardspring.com/webhooks/event-types.md): The six events, and what each one carries.

## API Docs

- API Reference > Applications [List applications.](https://docs.awardspring.com/api-reference/applications/list.md)
- API Reference > Award Cycles [List award cycles.](https://docs.awardspring.com/api-reference/award-cycles/list.md)
- API Reference > Award Cycles [Get the current award cycle.](https://docs.awardspring.com/api-reference/award-cycles/get-current.md)
- API Reference > Awards [List awards.](https://docs.awardspring.com/api-reference/awards/list.md)
- API Reference > Donor Activities [List a donor's merged activity timeline as a cursor-paginated page.](https://docs.awardspring.com/api-reference/donor-activities/list.md)
- API Reference > Donor Activities [Create a donor activity log entry (call, meeting, email, note, or pledge).](https://docs.awardspring.com/api-reference/donor-activities/create.md)
- API Reference > Donor Activities [Fetch a single logged donor activity, typed. Only logged activities are individually
addressable; the other four timeline sources are read-only derived views.](https://docs.awardspring.com/api-reference/donor-activities/get.md)
- API Reference > Donors [List donors.](https://docs.awardspring.com/api-reference/donors/list.md)
- API Reference > Donors [Create a donor.](https://docs.awardspring.com/api-reference/donors/create.md)
- API Reference > Donors [Get a donor.](https://docs.awardspring.com/api-reference/donors/get.md)
- API Reference > Donors [Update a donor.](https://docs.awardspring.com/api-reference/donors/update.md)
- API Reference > Donors [Update a donor's notes.](https://docs.awardspring.com/api-reference/donors/update-notes.md)
- API Reference > Funds [List funds.](https://docs.awardspring.com/api-reference/funds/list.md)
- API Reference > Gifts [List gifts and pledges.](https://docs.awardspring.com/api-reference/gifts/list.md)
- API Reference > Gifts [Record a gift or pledge.](https://docs.awardspring.com/api-reference/gifts/create.md)
- API Reference > Scholarships [List scholarships.](https://docs.awardspring.com/api-reference/scholarships/list.md)
- API Reference > Scholarships [Create a scholarship.](https://docs.awardspring.com/api-reference/scholarships/create.md)
- API Reference > Scholarships [List available-dollars (budget vs. awarded vs. remaining) for every active scholarship in an award cycle. Send award_cycle_id on every request, including when paging: it is recorded in the cursor and a request whose award_cycle_id does not match the cursor's is rejected.](https://docs.awardspring.com/api-reference/scholarships/list-available-dollars.md)
- API Reference > Scholarships [Available-dollars (budget vs. awarded vs. remaining) for a single scholarship within an award cycle.](https://docs.awardspring.com/api-reference/scholarships/get-available-dollars.md)
- API Reference > Scholarships [List awarded students across an award cycle as a flat, cursor-paginated collection (one row per applicant-award). Send award_cycle_id (and any scholarship_id) on every request, including when paging: both are recorded in the cursor and a request whose values do not match the cursor's is rejected.](https://docs.awardspring.com/api-reference/scholarships/list-awarded-students.md)
- API Reference > Students [List students.](https://docs.awardspring.com/api-reference/students/list.md)
- API Reference > Students [Get a student.](https://docs.awardspring.com/api-reference/students/get.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.awardspring.com/openapi.json)
- [OpenAPI YAML](https://docs.awardspring.com/openapi.yaml)