Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
Contracts > MaterializedTemplate

Reads all Materialized templates

Reads all Materialized templates

get/api/2026-07-01/resources/contracts/materialized_templates

Query parameters

company_idstring required

The identifier of the company whose templates you want to retrieve. All results are scoped to this company.

Example:1

The identifier of the company whose templates you want to retrieve. All results are scoped to this company.

legal_entity_ids[]string[]

Optional list of legal entity identifiers to filter results. When provided alongside template_type: legal_entity, returns only the materialized templates for those legal entities. Ignored for company and country template types.

Optional list of legal entity identifiers to filter results. When provided alongside template_type: legal_entity, returns only the materialized templates for those legal entities. Ignored for company and country template types.

[
  "1"
]
countries[]string[]

Optional list of ISO 3166-1 alpha-2 country codes to filter results. When provided alongside template_type: country, returns only templates for those countries. When used with template_type: legal_entity, narrows results to legal entities operating in those countries.

Optional list of ISO 3166-1 alpha-2 country codes to filter results. When provided alongside template_type: country, returns only templates for those countries. When used with template_type: legal_entity, narrows results to legal entities operating in those countries.

[
  "es"
]
template_type'company' | 'country' | 'legal_entity' | 'contract_type' required

The template level to retrieve. Use company to get the organization-wide base field definitions. Use country to get country-specific overrides merged with company defaults. Use legal_entity to get the final effective template for a specific legal entity, which is the most common use case when building contract creation or editing flows.

Example:legal_entity

The template level to retrieve. Use company to get the organization-wide base field definitions. Use country to get country-specific overrides merged with company defaults. Use legal_entity to get the final effective template for a specific legal entity, which is the most common use case when building contract creation or editing flows.

field_ids[]string[]

Optional list of field identifiers to filter the template fields returned. When provided, each materialized template will only include fields whose field_id matches one of the values in this list. Use this to retrieve a specific subset of fields (e.g. ["contract_type"]) without fetching the full template structure.

Optional list of field identifiers to filter the template fields returned. When provided, each materialized template will only include fields whose field_id matches one of the values in this list. Use this to retrieve a specific subset of fields (e.g. ["contract_type"]) without fetching the full template structure.

[
  "contract_type"
]
include_archivedboolean required

When true, archived options are included in the response alongside active ones. Defaults to false, which returns only active options. Set to true when you need to display contracts that reference options that have since been archived.

When true, archived options are included in the response alongside active ones. Defaults to false, which returns only active options. Set to true when you need to display contracts that reference options that have since been archived.

Response

OK

Example response

{
  "data": [
    {
      "id": "1-legal_entity-42-es",
      "company_id": "1",
      "legal_entity_id": "1",
      "country_code": "es",
      "template_type": "legal_entity"
    }
  ]
}