API reference

Every operation of the API, by resource, generated from the OpenAPI document. 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.

• POST /oauth/token — Obtain an access token with the OAuth 2.0 client-credentials grant.

Funding Rounds

The Organisation’s funding rounds. Read the Funding Rounds reference.

• GET /api/v2/funding_rounds — List funding rounds.
• GET /api/v2/funding_rounds/{id} — Get one funding round.

Funding Applications

Applications, their entries, moves, notes and tags. Read the Funding Applications reference.

• GET /api/v2/funding_applications — List funding applications.
• GET /api/v2/funding_applications/{id} — Get one funding application with its form entry.
• POST /api/v2/funding_applications/{id}/notes — Add a note to a funding application.
• PUT /api/v2/funding_applications/{id}/tags — Replace a funding application’s tags.
• POST /api/v2/funding_applications/{id}/transitions — Move a funding application.

Registration Entities

Applicant organisations and individuals. Read the Registration Entities reference.

• GET /api/v2/registration_entities — List registration entities.
• POST /api/v2/registration_entities — Add an applicant: a person and their registration entity.
• GET /api/v2/registration_entities/{id} — Get one registration entity with its users.
• PATCH /api/v2/registration_entities/{id} — Edit an organisation’s Founded date and stage override.
• POST /api/v2/registration_entities/{id}/users — Invite a user to a registration entity.

Assessment Rounds

Assessor assignments. Read the Assessment Rounds reference.

• POST /api/v2/assessment_rounds/{id}/assignments — Assign an Assessor to applications in an assessment round.

Contracts

Contracts and their recorded statuses. Read the Contracts reference.

• GET /api/v2/contracts — List contracts.
• GET /api/v2/contracts/{id} — Get one contract.
• POST /api/v2/contracts/{id}/status — Record a contract executed or terminated.

Milestones

Milestones with their deliverables. Read the Milestones reference.

• GET /api/v2/milestones — List milestones.
• POST /api/v2/milestones — Create a milestone on a funding application.
• GET /api/v2/milestones/{id} — Get one milestone.
• POST /api/v2/milestones/{id}/approve — Approve a milestone.

Payments

Payment batches. Read the Payments reference.

• POST /api/v2/payments/{id}/mark_paid — Mark a payment batch paid.

File Inputs

Downloads of files held by application and deliverable inputs. Read the File Inputs reference.

• GET /api/v2/file_inputs/{id} — Download the file an input holds.

Files

The three-step file upload. Read the Files reference.

• POST /api/v2/files — Reserve a file upload.
• POST /api/v2/files/{id}/attach — Attach a scanned file to its target.
• POST /api/v2/files/{id}/confirm — Confirm a file upload.

Reference

This document. Read the Reference reference.

• GET /api/v2/openapi.json — This OpenAPI 3.1 document.

Webhook deliveries are in the Event catalogue, and the OData reporting feed in Connect Power BI.