Financials
Deals

Get a list of deals

Get a paginated list of deals with optional filters.

Supported filters via query params:

  • deal_status: filter by deal status
  • main_borrower_id: filter by main borrower customer ID
  • name: fuzzy filter by deal name (min 5 characters)
get/api/v1/financials/deals

Request

  • Base URL: https://api.withaccend.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.withaccend.com/api/v1/financials/deals
  • Auth: HTTP bearer

Query parameters

offsetinteger

Pagination offset

limitinteger

Pagination limit

deal_status'in_progress' | 'on_hold' | 'withdrawn' | 'cancelled' | 'rejected' | 'duplicate'

Universal operational state for deals and loans — the "what's happening right now?" axis, independent of product. Lifecycle position lives in the per-program stage column. There is no positive terminal here; "done well" is expressed by stage reaching active/closed_out. The four negative terminals freeze the stage wherever it was.

Filter by operational status

deal_stagestring nullable

Filter by lifecycle stage

main_borrower_idstring nullable

Filter by main borrower ID

namestring nullable

Fuzzy filter by deal name (min 5 chars)

Response

Successful Response

totalinteger required
next_offsetinteger nullable
next_cursorstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.