> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.awardspring.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.awardspring.com/_mcp/server. # List gifts and pledges. GET https://api.awardspring.com/api/v1/gifts Returns one page at a time, newest first. Without filters the list covers the whole institution. Narrow it with `donor_id` (a donor's stored ID) to scope to a single donor, `type` to return only gifts or only pledges, and `q` to search the subject and description. Assistant capability: `springiq_list_gifts`. Required permission: Donors (applies when called on behalf of a signed-in person). Reference: https://docs.awardspring.com/api-reference/gifts/list ## Authentication - `X-Spring-API-Key` header (required) — Secret API key issued per institution. Send it on every request. ## Servers - `https://api.awardspring.com` (UnitedStates, default) - `https://api.awardspring.ca` (Canada) ## Request ### Query parameters - `donor_id` (string, optional) — Optional donor scope (`?donor_id=`): the donor's stored ID. Omit for a tenant-wide list. - `type` (string, optional) — Record-type filter (`?type=`): `gift` or `pledge`. Omit for both. - `q` (string, optional) — Free-text search (`?q=`): case-insensitive substring match on subject or description. - `limit` (integer, optional, default: 25) — Page size. Defaults to 25. Values outside 1–100 are clamped rather than rejected. - `starting_after` (string, optional) — Opaque cursor. Pass the `next_cursor` from the previous page to page forward. Mutually exclusive with `ending_before`; if both are supplied, `starting_after` wins. - `ending_before` (string, optional) — Opaque cursor. Pass the `previous_cursor` from the current page to page backward. - `include` (list of enum, optional) — Optional extras to add to the response, comma-separated. `total_count` is the only supported value: it adds `total_count`, the number of records that match this request across all pages. The count is taken fresh at the moment of each request, so it can change while you page; ask for it on the first page. Without it, `total_count` is left out of the response. Asking or not never invalidates a cursor. Any other value returns `400 validation_failed`. - Allowed values: `total_count` ## Response ### 200 OK - `object` (string, optional, nullable) — Discriminator constant. Always `"list"`, mirroring Stripe's list objects. - `url` (string, optional, nullable) — The request path this collection was served from (e.g. `/api/v1/scholarships`). - `has_more` (boolean, optional) — True when another page exists in the current paging direction. - `next_cursor` (string, optional, nullable) — Opaque cursor for the next page (pass as `starting_after`). Null when there is none. - `previous_cursor` (string, optional, nullable) — Opaque cursor for the previous page (pass as `ending_before`). Null when there is none. - `total_count` (integer, optional, nullable) — The number of records that match the request across all pages, counted fresh on each request. Present only when the request includes `include=total_count`; otherwise the key is omitted. - `data` (list of GiftV1, optional, nullable) — The page of items. ## Errors ### 400 Bad Request Error Bad Request - `error` (V1ErrorBody, optional) — Stripe-shaped error object for the `/api/v1/*` surface. Serialized snake\_case (via V1SnakeCaseNamingStrategy) and always nested under the `error` key of a V1ErrorEnvelope: `{ "error": { "type": "...", "code": "...", "message": "...", "param": null, "doc_url": null, "recovery": "..." } }` ### 404 Not Found Error Not Found - `error` (V1ErrorBody, optional) — Stripe-shaped error object for the `/api/v1/*` surface. Serialized snake\_case (via V1SnakeCaseNamingStrategy) and always nested under the `error` key of a V1ErrorEnvelope: `{ "error": { "type": "...", "code": "...", "message": "...", "param": null, "doc_url": null, "recovery": "..." } }` ### 429 Too Many Requests Error Rate limit exceeded for this API key. Retry after the interval in the `Retry-After` header. - `error` (V1ErrorBody, optional) — Stripe-shaped error object for the `/api/v1/*` surface. Serialized snake\_case (via V1SnakeCaseNamingStrategy) and always nested under the `error` key of a V1ErrorEnvelope: `{ "error": { "type": "...", "code": "...", "message": "...", "param": null, "doc_url": null, "recovery": "..." } }` ## Types ### GiftV1 - `object` (string, optional, nullable) — Stripe-style resource discriminator. Stable, snake_case string naming the resource type. Serialized first so it reads as the leading field of every V1 resource body. - `id` (string, optional, nullable) — The gift's or pledge's stored ID: 9 characters, sent exactly as stored. A dry-run create returns `null`, because nothing was saved. - `donor_id` (string, optional, nullable) — The stored ID of the donor the gift or pledge is attributed to. - `type` (string, optional, nullable) - `gift_type` (string, optional, nullable) - `amount` (double, optional, nullable) - `subject` (string, optional, nullable) - `description` (string, optional, nullable) - `fund_id` (string, optional, nullable) — The school's own code for the fund the gift is directed toward, as plain text. - `campaign_id` (string, optional, nullable) — The stored ID of the campaign the gift or pledge belongs to, or `null`. - `is_completed` (boolean, optional) - `gift_acknowledgement_sent` (boolean, optional) - `date` (integer, optional) - `soft_credits` (list of SoftCreditV1, optional, nullable) ### V1ErrorBody Stripe-shaped error object for the `/api/v1/*` surface. Serialized snake\_case (via V1SnakeCaseNamingStrategy) and always nested under the `error` key of a V1ErrorEnvelope: `{ "error": { "type": "...", "code": "...", "message": "...", "param": null, "doc_url": null, "recovery": "..." } }` - `type` (string, optional, nullable) — Coarse error category from V1ErrorType (e.g. `invalid_request_error`). - `code` (string, optional, nullable) — Stable fine-grained machine code from ErrorCode (e.g. `donor_not_found`). - `message` (string, optional, nullable) — Human-readable summary safe to surface to the caller. - `param` (string, optional, nullable) — The request parameter the error relates to, when attributable to a single field; otherwise null. - `doc_url` (string, optional, nullable) — Link to documentation for this error, when one exists; otherwise null. - `recovery` (string, optional, nullable) — Plain-language guidance on how to recover from this error, suitable for showing to the person who triggered it. Not present on every error. - `details` (any, optional) — Optional structured payload (e.g. a list of ValidationDetail for validation failures). Omitted from the wire when null so the canonical Stripe shape stays minimal. ### SoftCreditV1 - `name` (string, optional, nullable) - `user_id` (string, optional, nullable) — The stored ID of the person credited, or `null` for a name-only credit. ## Examples **Response** ```json { "object": "string", "url": "string", "has_more": true, "next_cursor": "string", "previous_cursor": "string", "total_count": 1, "data": [ { "object": "string", "id": "string", "donor_id": "string", "type": "string", "gift_type": "string", "amount": 1.1, "subject": "string", "description": "string", "fund_id": "string", "campaign_id": "string", "is_completed": true, "gift_acknowledgement_sent": true, "date": 1, "soft_credits": [ { "name": "string", "user_id": "string" } ] } ] } ``` **SDK Code** ```python import requests url = "https://api.awardspring.com/api/v1/gifts" headers = {"X-Spring-API-Key": ""} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.awardspring.com/api/v1/gifts'; const options = {method: 'GET', headers: {'X-Spring-API-Key': ''}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.awardspring.com/api/v1/gifts" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-Spring-API-Key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.awardspring.com/api/v1/gifts") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["X-Spring-API-Key"] = '' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.awardspring.com/api/v1/gifts") .header("X-Spring-API-Key", "") .asString(); ``` ```php request('GET', 'https://api.awardspring.com/api/v1/gifts', [ 'headers' => [ 'X-Spring-API-Key' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.awardspring.com/api/v1/gifts"); var request = new RestRequest(Method.GET); request.AddHeader("X-Spring-API-Key", ""); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["X-Spring-API-Key": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api.awardspring.com/api/v1/gifts")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```