Assinafy Templates API

openapi: 3.2.0
info:
  title: Assinafy Com Br Templates API
  version: 1.0.0
  description: 'Operations tagged Templates across 2 of this provider''s published API definitions: assinafy-com-br-openapi.json, assinafy-com-br-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.assinafy.com.br
  description: Production
- url: https://sandbox.assinafy.com.br
  description: Sandbox
tags:
- name: Templates
  description: Reusable document templates, their roles, fields and tags.
paths:
  /v1/accounts/{accountId}/templates:
    get:
      tags:
      - Templates
      summary: List templates
      description: 'List the templates of a workspace.


        The `status` field of a template is one of:


        | Status | Description |

        |--------|-------------|

        | `uploading` | The template is being uploaded. |

        | `uploaded` | The template has been uploaded. |

        | `processing` | The template is being processed. |

        | `ready` | The template is ready to use. |

        | `failed` | The template processing has failed. |


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: 2047ea16e15daf13b32fb3dbe7d16962
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/Search'
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/PerPage'
      responses:
        '200':
          description: A page of templates (default_document_tags omitted in the list)
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - properties:
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/Template'
                  type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
      - bearerAuth: []
      - apiKeyAuth: []
    servers:
    - url: https://api.assinafy.com.br
      description: Production
    - url: https://sandbox.assinafy.com.br
      description: Sandbox
components:
  schemas:
    TemplateRole:
      properties:
        id:
          type: string
        name:
          type: string
          example: Editor
        assignment_type:
          type: string
          example: Editor
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      type: object
    TemplateFieldPlacement:
      properties:
        id:
          type: string
        field_id:
          type: string
        role_id:
          type: string
        label:
          type: string
        display_settings:
          description: Rendering metadata for the placement.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      type: object
    TemplatePage:
      properties:
        id:
          type: string
        number:
          type: integer
          example: 1
        height:
          type: integer
          example: 2100
        width:
          type: integer
          example: 1275
        download_url:
          type: string
        fields:
          type: array
          items:
            $ref: '#/components/schemas/TemplateFieldPlacement'
      type: object
    Template:
      description: A reusable document template.
      properties:
        resource:
          type: string
          example: template
        id:
          type: string
          example: fa88b732db84d01427d4cdd1092
        name:
          type: string
          example: template.pdf
        document_name:
          description: Default name for documents created from this template.
          type:
          - string
          - 'null'
        message:
          description: Default invitation message.
          type:
          - string
          - 'null'
        status:
          description: One of uploading, uploaded, processing, ready, failed.
          type: string
          example: ready
        pages:
          type: array
          items:
            $ref: '#/components/schemas/TemplatePage'
        roles:
          type: array
          items:
            $ref: '#/components/schemas/TemplateRole'
        tags:
          type: array
          items:
            properties:
              id:
                type: string
              name:
                type: string
            type: object
        default_document_tags:
          description: Applied to documents created from this template; only returned by the single-template endpoint.
          type: array
          items:
            properties:
              id:
                type: string
              name:
                type: string
            type: object
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      type: object
    Envelope:
      description: Standard success wrapper. Operations add their own `data`.
      properties:
        status:
          description: HTTP status code, mirrored in the body.
          type: integer
          example: 200
        message:
          description: Human-readable message; empty on success.
          type: string
          example: ''
      type: object
    ErrorEnvelope:
      description: Standard error wrapper. `status` mirrors the HTTP status code.
      properties:
        status:
          type: integer
          example: 400
        message:
          description: Human-readable error message.
          type: string
          example: Bad request.
        data:
          type:
          - object
          - 'null'
          example: null
      type: object
  responses:
    Unauthorized:
      description: Missing or invalid credentials.
      content:
        application/json:
          schema:
            type: object
            allOf:
            - $ref: '#/components/schemas/ErrorEnvelope'
            - properties:
                status:
                  type: integer
                  example: 401
                message:
                  type: string
                  example: Your request was made with invalid credentials.
              type: object
    ServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            type: object
            allOf:
            - $ref: '#/components/schemas/ErrorEnvelope'
            - properties:
                status:
                  type: integer
                  example: 500
                message:
                  type: string
                  example: An unexpected error occurred.
              type: object
  parameters:
    AccountId:
      name: accountId
      in: path
      description: Workspace account ID.
      required: true
      schema:
        type: string
    Search:
      name: search
      in: query
      description: Search term.
      schema:
        type: string
    PerPage:
      name: per-page
      in: query
      description: Records per page (max 100).
      schema:
        type: integer
        maximum: 100
        example: 25
    Page:
      name: page
      in: query
      description: Page number.
      schema:
        type: integer
        minimum: 1
        example: 1
  securitySchemes:
    bearerAuth:
      type: http
      description: 'Access token: `Authorization: Bearer {access_token}`.'
      bearerFormat: JWT
      scheme: bearer
    apiKeyAuth:
      type: apiKey
      description: Permanent API key (recommended for back-end integrations).
      name: X-Api-Key
      in: header
    signerAccessCode:
      type: apiKey
      description: 'Signer access code used by signer-facing (Signing) endpoints instead of a user token: the code in the signer''s signing link, sent as the `signer-access-code` query or body parameter. It can be used again and has no expiry; it stops working when the signing request is removed. Treat it as a secret.'
      name: signer-access-code
      in: query
    oauth2:
      type: oauth2
      description: 'OAuth 2.1 authorization code flow with mandatory PKCE (S256), for applications and AI assistants acting in a user''s workspace with that user''s permission — as opposed to `apiKeyAuth`/`bearerAuth`, which authenticate the workspace or user directly. A token carries only the scopes the user approved and works for one workspace. Endpoints are published by the authorization server at `https://auth.assinafy.com.br/.well-known/oauth-authorization-server`. An OAuth token cannot reach billing, account lifecycle, credential management or admin surfaces regardless of scope. A missing scope answers `403` with `WWW-Authenticate: Bearer error="insufficient_scope"` naming it. See **OAuth Integration Guide** for the full flow.'
      flows:
        authorizationCode:
          authorizationUrl: https://auth.assinafy.com.br/oauth/authorize
          tokenUrl: https://api.assinafy.com.br/v1/oauth/token
          refreshUrl: https://api.assinafy.com.br/v1/oauth/token
          scopes:
            documents:read: Read documents, their pages, tags, signers, assignments and activity, and the WhatsApp notifications sent for an assignment.
            documents:write: Create, update and delete documents, and manage their signers, assignments and activity.
            templates:read: Read reusable document templates, their pages, roles, fields and tags.
            templates:write: Create, update and delete templates, their pages, roles, fields and tags.
            account:read: Read the workspace's profile, theme and logo.
            webhooks:write: Change the workspace's webhook subscription (delivery URL, events, contact email), deactivate it, manage webhook endpoints and re-send a delivery.
            openid: Identify the authenticated user (OpenID Connect `sub` claim) and enable the `/v1/oauth/userinfo` endpoint.
            profile: Include the user's name in the `id_token`/userinfo claims.
            email: Include the user's email and its verification status in the `id_token`/userinfo claims.
            offline_access: Request a refresh token, so the app keeps working after the user's session expires without prompting them again. Only granted to a client that explicitly asks for it.
x-refined-from:
- assinafy-com-br-openapi.json
- assinafy-com-br-openapi.json