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

/bff/contract/template/list

Returns all active contract templates for the organisation. Templates serve as reusable blueprints for creating new contracts with predefined content.

ContractgetBffContractTemplateList

Parameters

2 query

Query parameters

· 2
categoryIdstringOptional

Filter by template category ID.

Example3
localestringOptional

Filter by locale code.

Examplecs

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
idstringRequired

Template external ID.

internalIdnumberRequired

Template internal ID.

titlestringRequired

Template title.

descriptionstring | nullRequired
One of 2:
Variant 1
string

Short description of the template purpose.

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

Name of the assigned category.

Variant 2
null
localestringRequired

Locale code of the template.

Examplescsen
activebooleanRequired

Whether the template is active and available for use.

insertedDateDate | string | string | numberRequired

Creation date.

One of 4:
Variant 1
Date

Creation date.

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

Total matching templates.

Response example

application/json
{
  "items": [
    {
      "id": "example_id",
      "internalId": 0,
      "title": "example_title",
      "locale": "cs",
      "active": false
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/contract/template/list

get
curl -X GET "https://api.bizkithub.com/bff/contract/template/list?categoryId=3&locale=cs" \
  -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