> This is the Markdown of https://backed.giving/developers/reference, a page of the Backed developer documentation. Every page is listed at https://backed.giving/developers/llms.txt. # API reference Every operation of the Backed API, read and write, by resource, with a link to each one’s full reference. Every operation of the API, by resource, generated from the [OpenAPI document](https://backed.giving/developers/openapi.json). Paths are on your organisation’s own address. Lists answer at most `50` records a page; every read is also served under the documented product’s `/funding_system/api/v2` alias; any method a path does not serve answers `405 method_not_allowed`. ## Authentication Exchange a credential for an access token. [Read the Authentication reference](https://backed.giving/developers/reference/authentication.md). - [POST /oauth/token](https://backed.giving/developers/reference/authentication.md#issueOAuthToken) — Obtain an access token with the OAuth 2.0 client-credentials grant. ## Funding Rounds The Organisation’s funding rounds. [Read the Funding Rounds reference](https://backed.giving/developers/reference/funding-rounds.md). - [GET /api/v2/funding\_rounds](https://backed.giving/developers/reference/funding-rounds.md#listFundingRounds) — List funding rounds. - [GET /api/v2/funding\_rounds/{id}](https://backed.giving/developers/reference/funding-rounds.md#getFundingRound) — Get one funding round. ## Funding Applications Applications, their entries, moves, notes and tags. [Read the Funding Applications reference](https://backed.giving/developers/reference/funding-applications.md). - [GET /api/v2/funding\_applications](https://backed.giving/developers/reference/funding-applications.md#listFundingApplications) — List funding applications. - [GET /api/v2/funding\_applications/{id}](https://backed.giving/developers/reference/funding-applications.md#getFundingApplication) — Get one funding application with its form entry. - [POST /api/v2/funding\_applications/{id}/notes](https://backed.giving/developers/reference/funding-applications.md#createApplicationNote) — Add a note to a funding application. - [PUT /api/v2/funding\_applications/{id}/tags](https://backed.giving/developers/reference/funding-applications.md#replaceApplicationTags) — Replace a funding application’s tags. - [POST /api/v2/funding\_applications/{id}/transitions](https://backed.giving/developers/reference/funding-applications.md#transitionFundingApplication) — Move a funding application. ## Registration Entities Applicant organisations and individuals. [Read the Registration Entities reference](https://backed.giving/developers/reference/registration-entities.md). - [GET /api/v2/registration\_entities](https://backed.giving/developers/reference/registration-entities.md#listRegistrationEntities) — List registration entities. - [POST /api/v2/registration\_entities](https://backed.giving/developers/reference/registration-entities.md#createRegistrationEntity) — Add an applicant: a person and their registration entity. - [GET /api/v2/registration\_entities/{id}](https://backed.giving/developers/reference/registration-entities.md#getRegistrationEntity) — Get one registration entity with its users. - [PATCH /api/v2/registration\_entities/{id}](https://backed.giving/developers/reference/registration-entities.md#updateRegistrationEntity) — Edit an organisation’s Founded date and stage override. - [POST /api/v2/registration\_entities/{id}/users](https://backed.giving/developers/reference/registration-entities.md#addRegistrationEntityUser) — Invite a user to a registration entity. ## Assessment Rounds Assessor assignments. [Read the Assessment Rounds reference](https://backed.giving/developers/reference/assessment-rounds.md). - [POST /api/v2/assessment\_rounds/{id}/assignments](https://backed.giving/developers/reference/assessment-rounds.md#createAssessorAssignment) — Assign an Assessor to applications in an assessment round. ## Contracts Contracts and their recorded statuses. [Read the Contracts reference](https://backed.giving/developers/reference/contracts.md). - [GET /api/v2/contracts](https://backed.giving/developers/reference/contracts.md#listContracts) — List contracts. - [GET /api/v2/contracts/{id}](https://backed.giving/developers/reference/contracts.md#getContract) — Get one contract. - [POST /api/v2/contracts/{id}/status](https://backed.giving/developers/reference/contracts.md#recordContractStatus) — Record a contract executed or terminated. ## Milestones Milestones with their deliverables. [Read the Milestones reference](https://backed.giving/developers/reference/milestones.md). - [GET /api/v2/milestones](https://backed.giving/developers/reference/milestones.md#listMilestones) — List milestones. - [POST /api/v2/milestones](https://backed.giving/developers/reference/milestones.md#createMilestone) — Create a milestone on a funding application. - [GET /api/v2/milestones/{id}](https://backed.giving/developers/reference/milestones.md#getMilestone) — Get one milestone. - [POST /api/v2/milestones/{id}/approve](https://backed.giving/developers/reference/milestones.md#approveMilestone) — Approve a milestone. ## Payments Payment batches. [Read the Payments reference](https://backed.giving/developers/reference/payments.md). - [POST /api/v2/payments/{id}/mark\_paid](https://backed.giving/developers/reference/payments.md#markPaymentPaid) — Mark a payment batch paid. ## File Inputs Downloads of files held by application and deliverable inputs. [Read the File Inputs reference](https://backed.giving/developers/reference/file-inputs.md). - [GET /api/v2/file\_inputs/{id}](https://backed.giving/developers/reference/file-inputs.md#downloadFileInput) — Download the file an input holds. ## Files The three-step file upload. [Read the Files reference](https://backed.giving/developers/reference/files.md). - [POST /api/v2/files](https://backed.giving/developers/reference/files.md#reserveFileUpload) — Reserve a file upload. - [POST /api/v2/files/{id}/attach](https://backed.giving/developers/reference/files.md#attachFileUpload) — Attach a scanned file to its target. - [POST /api/v2/files/{id}/confirm](https://backed.giving/developers/reference/files.md#confirmFileUpload) — Confirm a file upload. ## Reference This document. [Read the Reference reference](https://backed.giving/developers/reference/reference.md). - [GET /api/v2/openapi.json](https://backed.giving/developers/reference/reference.md#documentApiOpenApi) — This OpenAPI 3.1 document. > Webhook deliveries are in the [Event catalogue](https://backed.giving/developers/events.md), and the OData reporting feed in [Connect Power BI](https://backed.giving/developers/guides/power-bi.md).