BizKitHub
DocsAPI ReferenceContract/bff/contract/detail
getContractAdmin BFF

/bff/contract/detail

Returns full contract detail including markdown content, status, validity dates, and all contract parties with their roles.

ContractgetBffContractDetail

Parameters

1 query

Query parameters

· 1
idstringRequired

Contract external ID.

Examplectr_abc123

Response schema

1 status code documented

200Success
idstringRequired

Contract external ID.

internalIdnumberRequired

Contract internal ID.

titlestringRequired

Contract title.

contentstringRequired

Contract body in Markdown format.

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

Contract lifecycle status.

Examplesdraftactivesigned
localestringRequired

Locale code of the contract (cs, en, de, …).

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

Validity start.

One of 4:
Variant 1
Date

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

Validity end.

One of 4:
Variant 1
Date

Validity end.

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

Date when the contract was signed.

One of 4:
Variant 1
Date

Date when the contract was signed.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
Variant 2
null
hasPdfbooleanRequired

Whether a finalized PDF exists in blob storage.

templateIdnumber | nullRequired
One of 2:
Variant 1
number

ID of the template used to create this contract.

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
partiesobject[]Required

List of contract parties (signatories).

Each array item:
contactIdnumberRequired

Internal contact ID.

Example42
contactExternalIdstringRequired

Public contact external ID.

Examplecnt_abc123
rolestringRequired

Party role in the contract (issuer, party).

Examplespartyissuer
namestringRequired

Full name or email as fallback.

ExampleJan Novak
emailstring | nullRequired
One of 2:
Variant 1
string

Party e-mail. null for phone-only contacts and anonymised contacts. Contracts with a null issuer e-mail cannot be sent for e-signature via e-mail link; UI should warn before letting the user trigger that flow.

Examplejan@example.com
Variant 2
null
companyNamestring | nullRequired
One of 2:
Variant 1
string

Company name if the contact is a legal entity.

ExampleAcme s.r.o.
Variant 2
null

Response example

application/json
{
  "id": "example_id",
  "internalId": 0,
  "title": "example_title",
  "content": "example_content",
  "status": "draft",
  "locale": "cs",
  "hasPdf": false,
  "parties": [
    {
      "contactId": 42,
      "contactExternalId": "cnt_abc123",
      "role": "party",
      "name": "Jan Novak"
    }
  ]
}

Request example

GET /bff/contract/detail

get
curl -X GET "https://api.bizkithub.com/bff/contract/detail?id=ctr_abc123" \
  -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