> ## Documentation Index
> Fetch the complete documentation index at: https://juridiqsoftware.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Campos de um modelo de peça jurídica

> Devolve os campos `{{MÓDULO.coluna}}` do modelo, um por marcador, na ordem em que aparecem. Na criação da peça:
- PERSON da pessoa 1 (`PERSON.name` ou `PERSON.name.1`) sai do cliente de `personId`, com os dados de GET /person/{id};
- LAW_SUIT sai do processo de `lawSuitId`, com os dados de GET /lawSuit/{id} (ex.: valor da causa em R$);
- GENERAL.date e GENERAL.time saem de agora, no horário de Brasília;
- o resto (PERSONALIZED, pessoa 2 em diante, GENERAL.cityState) só por `values`.

Marcador partido entre trechos de formatação diferente e campo antigo do editor não aparecem na lista; o editor os mostra como campo ao abrir a peça.

**Permissão:** qualquer usuário do escritório da chave.

**Erros:** 404 quando o modelo não existe neste escritório. 403 quando a chave é do Claude e o plano do escritório não inclui o MCP, ou quando o acesso do escritório está bloqueado.



## OpenAPI

````yaml https://api.juridiq.com.br/api-docs/client/openapi.json get /docs/templates/{id}
openapi: 3.1.0
info:
  title: Juridiq API — Documentação para Integradores
  description: >-
    API REST para integradores autenticados com chave (`x-juridiq-api-key`).


    ## Rate limit


    A API aberta limita **120 requisições a cada 60s por chave**.

    Ao exceder, a resposta é `429 Too Many Requests` com os headers
    `x-ratelimit-limit`, `x-ratelimit-remaining`, `x-ratelimit-reset` e
    `retry-after`.

    Respeite o `retry-after` antes de tentar de novo. Sincronizações em lote
    devem paginar e tratar 429 com backoff.
  version: 1.0.0
servers:
  - url: https://api.juridiq.com.br
    description: Production server
security:
  - apiKeyAuth: []
tags: []
paths:
  /docs/templates/{id}:
    get:
      tags:
        - Documents
      summary: Campos de um modelo de peça jurídica
      description: >-
        Devolve os campos `{{MÓDULO.coluna}}` do modelo, um por marcador, na
        ordem em que aparecem. Na criação da peça:

        - PERSON da pessoa 1 (`PERSON.name` ou `PERSON.name.1`) sai do cliente
        de `personId`, com os dados de GET /person/{id};

        - LAW_SUIT sai do processo de `lawSuitId`, com os dados de GET
        /lawSuit/{id} (ex.: valor da causa em R$);

        - GENERAL.date e GENERAL.time saem de agora, no horário de Brasília;

        - o resto (PERSONALIZED, pessoa 2 em diante, GENERAL.cityState) só por
        `values`.


        Marcador partido entre trechos de formatação diferente e campo antigo do
        editor não aparecem na lista; o editor os mostra como campo ao abrir a
        peça.


        **Permissão:** qualquer usuário do escritório da chave.


        **Erros:** 404 quando o modelo não existe neste escritório. 403 quando a
        chave é do Claude e o plano do escritório não inclui o MCP, ou quando o
        acesso do escritório está bloqueado.
      parameters:
        - schema:
            type: string
            format: uuid
          in: path
          name: id
          required: true
          description: ID do modelo (campo id de GET /docs/templates)
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: ID do modelo
                  name:
                    type: string
                    description: Nome do modelo
                  fields:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                          description: >-
                            Marcador como está no modelo, sem chaves (ex.:
                            PERSON.name.2); é a chave em values
                        module:
                          type: string
                          enum:
                            - LAW_SUIT
                            - PERSON
                            - PERSONALIZED
                            - GENERAL
                          description: >-
                            PERSON (cadastro do cliente), LAW_SUIT (processo),
                            GENERAL (data e hora de agora; cityState é digitado)
                            ou PERSONALIZED (só digitado)
                        personIndex:
                          type: integer
                          nullable: true
                          description: >-
                            Só PERSON: a pessoa do modelo (1 é o cliente de
                            personId; 2 em diante só por values)
                        label:
                          type: string
                          description: >-
                            Rótulo do campo no escritório; sem rótulo
                            cadastrado, a coluna. Pessoa 2 em diante leva
                            "(pessoa N)"
                      required:
                        - key
                        - module
                        - personIndex
                        - label
                      additionalProperties: false
                    description: >-
                      Campos do modelo, um por marcador, na ordem em que
                      aparecem
                required:
                  - id
                  - name
                  - fields
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  issues: {}
                required:
                  - message
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  statusCode:
                    type: number
                  translateMessage:
                    type: string
                required:
                  - message
                  - statusCode
                  - translateMessage
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  statusCode:
                    type: number
                  translateMessage:
                    type: string
                required:
                  - message
                  - statusCode
                  - translateMessage
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  statusCode:
                    type: number
                  translateMessage:
                    type: string
                required:
                  - message
                  - statusCode
                  - translateMessage
                additionalProperties: false
      security:
        - apiKeyAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-juridiq-api-key
      description: >-
        Chave de API do escritório (criada no painel). Envie o valor no header
        x-juridiq-api-key. A API aberta aplica rate limit por chave (veja a
        documentação de integradores).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.