REST API reference

Deals

Follow a business's funding request to a recipient, manage its stage, and open its application.

Create a deal

A deal tracks a business's funding request to one recipient. Its Deal application collects the answers and documents that recipient needs.

If you already know who should receive the Deal, use List Deal recipients (GET /deal-recipients/). It includes your own team, Marketplace lenders, connected partners, and custom recipients available to your Portal. This needs Deals read access. Search by name and follow next_cursor for more results. Choose a recipient with can_create_deal: true; otherwise, unavailable_reason explains what needs attention.

If you need recommendations, start with Matchmaking and review the results before choosing a recipient.

Use Create a Deal (POST /deals/) with the Business ID and recipient_id. Copy the recipient's id from the recipient list, or recipient.id from a matchmaking result. For a Deal your team will process, choose your own team from the recipient list. Include project_id to link a Project belonging to this Business. Match result IDs are for saving your shortlist.

Creation uses the recipient's current published application and your default Deal pipeline, and starts Autofill. The application stays private to your team and is not submitted. Save the returned Deal and application IDs, then complete the application.

Send a unique Idempotency-Key with each creation request. Reuse the same key and body when retrying to receive the original Deal. Use a new key only when you intend to create another Deal.

Complete and follow the deal

Open the linked Deal application to complete answers, attach documents, use Autofill, check readiness, and submit. A submission receipt does not establish lender acceptance, approval, or funding.

Check the deal name, linked project/application IDs, and pipeline stage. Read the linked records when you need more context to distinguish similarly named deals.

status describes application progress. workflow.stage describes placement on your Portal's board. Moving a stage does not submit an application or change its application status.

To move a deal on your board, discover stages through workflow.stages_url and update the stage with the deal ETag.

Record an application decision

To decline, mark funded, withdraw, mark timed out, reopen, or record submitted/not-submitted status, follow Application decisions.

Update participants or the linked project

Deal participants are a complete replacement set. Read its ETag, choose people available in your Portal, and include the primary person in person_ids. Null clears the primary designation; an empty set clears participants. Read back the result.

To move a deal to another project, use Move a Deal to a Project.

Available operations

GETList Deals/deals/POSTAssociate an existing Deal with a Project/deals/{deal_id}/project/POSTCreate a Deal/deals/GETList Deal participants/deals/{deal_id}/participants/GETRetrieve a Deal/deals/{deal_id}/GETRetrieve Deal financing terms/deals/{deal_id}/terms/PUTReplace Deal participants/deals/{deal_id}/participants/PATCHUpdate a Deal/deals/{deal_id}/PATCHUpdate Deal financing terms/deals/{deal_id}/terms/PATCHMove one Deal to a workflow stage/deals/{deal_id}/stage/

Copy instructions to your AI agent

Request an integration