This guide introduces the Give Interactive REST API, a JSON HTTP API for integrating with Give Interactive. The authoritative contract is the OpenAPI document Give-Interactive-REST-API.yaml in this repository.

What you get

• Machine-readable spec: OpenAPI 3.1 (openapi: 3.1.0 in the spec).

• Documented operations: Paths, request bodies, responses, and shared components (parameters, schemas) are defined in the YAML file.

• Environments: Sandbox and production API hosts are listed under servers in the spec (for example, https://api-sandbox.giveinteractive.com/api/v1 and https://api.giveinteractive.com/api/v1).

Related documentation

• Stoplight: The backend REST README points to Public API Documentation (Stoplight) for published docs. Use that site if your team maintains examples or walkthroughs there; this repo’s OpenAPI file is the source of truth for the contract as checked in.

Next steps

• Versioning — API version in the URL and in the spec.

• Authentication — OAuth2 client credentials and how requests are tied to a user profile.

• Pagination — limit, page, and list response metadata.

• Errors — HTTP status codes, error envelope, and other response shapes.

• Changelog — Release notes template, deprecation entries, and removal dates when posted.