Assinafy Tags API

openapi: 3.2.0
info:
  title: Assinafy Com Br Tags API
  version: 1.0.0
  description: 'Operations tagged Tags 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: Tags
  description: Workspace-scoped labels attachable to documents and templates.
paths:
  /v1/accounts/{accountId}/tags:
    get:
      tags:
      - Tags
      summary: List tags
      description: 'List the tags of a workspace.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: fbc69bb6a998ae85014ff7838b61d795
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/Search'
      responses:
        '200':
          description: The workspace tags
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - properties:
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/Tag'
                  type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
      - bearerAuth: []
      - apiKeyAuth: []
    post:
      tags:
      - Tags
      summary: Create tag
      description: 'Create a tag in the workspace. Names are unique per workspace (case-insensitive); a collision returns 409.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: cad8c1f3ef2e9658a45e7acbbf3d1f2f
      parameters:
      - $ref: '#/components/parameters/AccountId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              properties:
                name:
                  description: Trimmed; whitespace collapsed; max 64 chars.
                  type: string
                  example: Contracts
                color:
                  description: '6-char hex (with or without leading #).'
                  type:
                  - string
                  - 'null'
                  example: ff8800
              type: object
      responses:
        '200':
          description: The created tag
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - properties:
                    data:
                      $ref: '#/components/schemas/Tag'
                  type: object
        '400':
          $ref: '#/components/responses/ValidationError'
        '409':
          description: A tag with the same name already exists.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/ErrorEnvelope'
                - properties:
                    status:
                      type: integer
                      example: 409
                  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
  /v1/accounts/{accountId}/tags/{tagId}:
    put:
      tags:
      - Tags
      summary: Update tag
      description: 'Update a tag''s name or color.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: 678d6e02e486fa502171c9b2779ff50f
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - name: tagId
        in: path
        description: The tag ID.
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                name:
                  type: string
                  example: Signed Contracts
                color:
                  type:
                  - string
                  - 'null'
                  example: 00aa55
              type: object
      responses:
        '200':
          description: The updated tag
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - properties:
                    data:
                      $ref: '#/components/schemas/Tag'
                  type: object
        '400':
          $ref: '#/components/responses/ValidationError'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
      - bearerAuth: []
      - apiKeyAuth: []
    delete:
      tags:
      - Tags
      summary: Delete tag
      description: 'Delete a tag. Pass `?force=true` to detach it from any documents/templates it is attached to.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: 12cf354dabea81eb5f5ef55d9530ed93
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - name: tagId
        in: path
        description: The tag ID.
        required: true
        schema:
          type: string
      - name: force
        in: query
        description: Detach from resources before deleting.
        schema:
          type: boolean
      responses:
        '200':
          description: Tag deleted
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - properties:
                    data:
                      properties:
                        deleted:
                          type: boolean
                          example: true
                      type: object
                  type: object
        '404':
          $ref: '#/components/responses/NotFound'
        '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:
  responses:
    NotFound:
      description: The requested resource does not exist.
      content:
        application/json:
          schema:
            type: object
            allOf:
            - $ref: '#/components/schemas/ErrorEnvelope'
            - properties:
                status:
                  type: integer
                  example: 404
                message:
                  type: string
                  example: The requested resource was not found.
              type: object
    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
    ValidationError:
      description: One or more fields failed validation.
      content:
        application/json:
          schema:
            type: object
            allOf:
            - $ref: '#/components/schemas/ErrorEnvelope'
            - properties:
                status:
                  type: integer
                  example: 422
                message:
                  type: string
                  example: One or more fields failed validation.
              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
  schemas:
    Tag:
      description: A workspace-scoped label. Names are unique per workspace (case-insensitive).
      properties:
        resource:
          type: string
          example: tag
        id:
          type: string
          example: fa8c09f3e709a8a1c82d69b1454
        name:
          type: string
          example: Contracts
        color:
          description: '6-char hex without leading #.'
          type:
          - string
          - 'null'
          example: ff8800
        created_at:
          type: string
          format: date-time
          example: '2026-05-14T12:00:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-05-14T12:00:00Z'
      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
  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