BizKitHub
DocsAPI ReferenceContract/bff/contract/template/detail
getContractAdmin BFF

/bff/contract/template/detail

Returns full template detail including the Markdown content. Use this content as the initial body when creating a new contract from a template.

ContractgetBffContractTemplateDetail

Parameters

1 query

Query parameters

· 1
idstringRequired

Template external ID.

Exampletpl_xyz789

Response schema

1 status code documented

200Success
idstringRequired

Template external ID.

internalIdnumberRequired

Template internal ID.

titlestringRequired

Template title.

descriptionstring | nullRequired
One of 2:
Variant 1
string

Template description.

Variant 2
null
contentstringRequired

Template body in Markdown format — use as initial contract content.

categoryIdnumber | nullRequired
One of 2:
Variant 1
number

Assigned category ID.

Variant 2
null
categoryNamestring | nullRequired
One of 2:
Variant 1
string

Assigned category name.

Variant 2
null
localestringRequired

Locale code.

Examplescsen
activebooleanRequired

Whether the template is active.

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

Response example

application/json
{
  "id": "example_id",
  "internalId": 0,
  "title": "example_title",
  "content": "example_content",
  "locale": "cs",
  "active": false
}

Request example

GET /bff/contract/template/detail

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