BizKitHub
DocsAPI ReferenceContract/bff/contract/list
getContractAdmin BFF

/bff/contract/list

Returns a paginated list of contracts for the authenticated organisation. Supports filtering by status and full-text search by title.

ContractgetBffContractList

Parameters

1 query

Query parameters

· 1
status"draft" | "pending_review" | "approved" | "signed" | "active" | "expired" | "cancelled" | "archived"Optional

Contract lifecycle status.

Exampledraft

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
idstringRequired

Contract external ID.

internalIdnumberRequired

Contract internal ID.

titlestringRequired

Contract title.

status"draft" | "pending_review" | "approved" | "signed" | "active" | "expired" | "cancelled" | "archived"Required

Contract lifecycle status.

Examplesdraftactivesigned
partyCountnumberRequired

Number of contract parties.

hasPdfbooleanRequired

Whether the contract has a finalized PDF.

validFromDate | string | string | number | nullRequired
One of 2:
Variant 1
Date | string | string | number

Contract validity start.

One of 4:
Variant 1
Date

Contract validity start.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
Variant 2
null
validToDate | string | string | number | nullRequired
One of 2:
Variant 1
Date | string | string | number

Contract validity end.

One of 4:
Variant 1
Date

Contract validity end.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
Variant 2
null
insertedDateDate | string | string | numberRequired

Creation date.

One of 4:
Variant 1
Date

Creation date.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
updatedDateDate | string | string | numberRequired

Last modification date.

One of 4:
Variant 1
Date

Last modification date.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
itemCountnumberRequired

Total matching contracts.

Response example

application/json
{
  "items": [
    {
      "id": "example_id",
      "internalId": 0,
      "title": "example_title",
      "status": "draft",
      "partyCount": 0,
      "hasPdf": false
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/contract/list

get
curl -X GET "https://api.bizkithub.com/bff/contract/list?status=draft" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key