Merge
Merge subpackage_attachments API

The subpackage_attachments API from Merge — 12 operation(s) for subpackage_attachments.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.1.0
info:
  title: Accounting subpackage_attachments API
  version: 1.0.0
servers:
- url: https://api.merge.dev/api
- url: https://api-eu.merge.dev/api
- url: https://api-ap.merge.dev/api
tags:
- name: subpackage_attachments
paths:
  /accounting/v1/attachments:
    get:
      operationId: list
      summary: List
      description: Returns a list of `AccountingAttachment` objects.{/* BEGIN_ACCOUNTING_ATTACHMENT_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA9WU227aQBCGXwXtJcJ2gdAolqqKUw5UmARIlSiKVsN6MAvrXWcPQIny7pXBCtBGai+SSr3zjHb+mfnml58JA4uJ0j9ISIAx5aTlMiEVkqoYBQlJ8zXZtBbYLEVpSYVAxiNI8aiKLmukQozLMqUtxuccRWwuNU5JSIIUdYKek3zKMQ72RQGXFhMNlitpgtdib7qtJhUiuFxgXIzxZ7ndc6/I/BKaQHCTj5+BMXamlUtmQ3xyaP5COZ9NYL4/CC8GC8GBiqd3Mm/l8i1iFGgx7oCFDlpk+bpFx5m1mQmDYIYi87fd/RiXAcoAtOVMoAka9bPa6VnDK1S23b/SRHypludPEzU5LdOECQqu3B+zdTS+WkXz5CRqn6yjzW0j2iw20XzxqUwTKPfH/cZgfF8fdJrVwRsP6Ojz3dn3VqfVi8ps061H8/tVNGbV/pgtJpureu+CrXqXN+toc1/rd27r0bjb6F2o6qA9NP32UPWbvk8q5PCqJHx4PkwUxhloYAJL585wJUttoVxc6g6vj4uvUkjwANLuOpBxL3MTwZlv6j6ksFESVsZnKg1SjDkEO3G6E6dbcdodXlOPjp4caPSzrcu3QLmSrzchIelGl82o3e0c26S5BC5gIpCEVjv8zeckfCC4zlAazO895QKpzBctvp0WpEI0psoize93HNEM7Gyf4jF5zIMnxzXG16AhRYs67/L4UnmL5o3jbNFSamFKAym4xPfhuJf1zBYcvZ3WPrdOqx8C8J9TG0GCpZYzXKIxhQf3f7z3QZj3oK12s3Ae/ba8W9ZH8w8H+HHU7lCr92GTKxXG+u8M9fjyExV8kBo+BwAA" /></Footer>{/* END_ACCOUNTING_ATTACHMENT_FETCH_SUPPORTED_FIELDS */}
      tags:
      - subpackage_attachments
      parameters:
      - name: company_id
        in: query
        description: If provided, will only return accounting attachments for this company.
        required: false
        schema:
          type: string
      - name: created_after
        in: query
        description: If provided, will only return objects created after this datetime.
        required: false
        schema:
          type: string
          format: date-time
      - name: created_before
        in: query
        description: If provided, will only return objects created before this datetime.
        required: false
        schema:
          type: string
          format: date-time
      - name: cursor
        in: query
        description: The pagination cursor value.
        required: false
        schema:
          type: string
      - name: include_deleted_data
        in: query
        description: Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
        required: false
        schema:
          type: boolean
      - name: include_remote_data
        in: query
        description: Whether to include the original data Merge fetched from the third-party to produce these models.
        required: false
        schema:
          type: boolean
      - name: include_shell_data
        in: query
        description: Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
        required: false
        schema:
          type: boolean
      - name: modified_after
        in: query
        description: If provided, only objects synced by Merge after this date time will be returned.
        required: false
        schema:
          type: string
          format: date-time
      - name: modified_before
        in: query
        description: If provided, only objects synced by Merge before this date time will be returned.
        required: false
        schema:
          type: string
          format: date-time
      - name: page_size
        in: query
        description: Number of results to return per page. The maximum limit is 100.
        required: false
        schema:
          type: integer
      - name: remote_id
        in: query
        description: The API provider's ID for the given object.
        required: false
        schema:
          type: string
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedAccountingAttachmentList'
    post:
      operationId: create
      summary: Create
      description: Creates an `AccountingAttachment` object with the given values.{/* BEGIN_ACCOUNTING_ATTACHMENT_CREATE_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="POST" data="H4sIAAAAAAAAA+VV72/aMBD9V5A/IkhGM0BFmiZ+bW0nzFbo1KqqrMM5gsGxU9uhLVP/9ykhbenG1mpjq6Z9w8fde3fv+ZwvhIPDSJsb0iLAuU6VEyoiFRLrECVpkfZ9sO0c8FmMypEKgURQiPFRFVvukQqxaZJo4zB8J1CG9sDglLSIH6OJsJoqMRUY+g9FvlAOIwNOaGX9++LqNK8mFSKFWmBYtPE03Dq9WkS+OVpfCpu1n4C1bmZ0Gs2O8TJF+wzkrDeJ2fwgqyE48DdQqmYNsy2WTRGiRIdhDxz00CHPxi0YZ84ltuX7M5SJl7N7IS59VD4YJ7hE69eD/b3mfr1aoOTsb1kk39TK88uJnjTLLOKSQVoejPk1HR9e0Xn0mnZfX9PVSZ2uFis6X7wqswjKg/GgPhyfBcNeuzbcksBGjdP9z51e54iW+aof0PnZFR3z2mDMF5PVYXD0nl8dHXy6pquzvUHvJKDjfv3ova4Nu8d20D3Wg7bnkQrZdJW0zr9sBoqLMxDcaKunrtS7URALbktBo17qpFYotLbUReUMyMdghzFEuCHa2i1IRDVJJ1JwzwYexLDSCq6sx3XsxxgK8O/J2B0ZCxp1dkfGCjLW1VIbtn/df9doNL0kX4VcdaHVvXGkRfr0oE27/d7ju9RegpAwkUhazqT43TKQ1jnhOk5A3ZAKmQqJTGViFL9Tk01rMNYOmQjJRXa4TIXB8CMYiNGheR7GhmIsyUrt1qDnDCgL+VAslzKjfTLT3SRILm4r21yl6EapcLgb2yg6m6Exe5mCwT9iyK/b8Jvi5yW5ltv/1jJEkzewXepPqeCLjtYLWxoqKdSONH+Ara5VZyfTvUanWfuv1N/9Zowgwo3XTeo0LD18XXfjXcbBOt02G62d+7A8XQaj+b/q3AuZdKgccO52aEmBeGfLcimobcK/astP36sCYEuCTZNQ8x+/Z6do9G40z5CKx+sFNA7BweMTS8DN/ooJG/f86UV4zrLkrVzcXtx+BQ+kvY4rDAAA" /></Footer>{/* END_ACCOUNTING_ATTACHMENT_CREATE_SUPPORTED_FIELDS */}
      tags:
      - subpackage_attachments
      parameters:
      - name: is_debug_mode
        in: query
        description: Whether to include debug fields (such as log file links) in the response.
        required: false
        schema:
          type: boolean
      - name: run_async
        in: query
        description: Whether or not third-party updates should be run asynchronously.
        required: false
        schema:
          type: boolean
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountingAttachmentResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountingAttachmentEndpointRequest'
  /accounting/v1/attachments/{id}:
    get:
      operationId: retrieve
      summary: Retrieve
      description: Returns an `AccountingAttachment` object with the given `id`.{/* BEGIN_ACCOUNTING_ATTACHMENT_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA9WU227aQBCGXwXtJcJ2gdAolqqKUw5UmARIlSiKVsN6MAvrXWcPQIny7pXBCtBGai+SSr3zjHb+mfnml58JA4uJ0j9ISIAx5aTlMiEVkqoYBQlJ8zXZtBbYLEVpSYVAxiNI8aiKLmukQozLMqUtxuccRWwuNU5JSIIUdYKek3zKMQ72RQGXFhMNlitpgtdib7qtJhUiuFxgXIzxZ7ndc6/I/BKaQHCTj5+BMXamlUtmQ3xyaP5COZ9NYL4/CC8GC8GBiqd3Mm/l8i1iFGgx7oCFDlpk+bpFx5m1mQmDYIYi87fd/RiXAcoAtOVMoAka9bPa6VnDK1S23b/SRHypludPEzU5LdOECQqu3B+zdTS+WkXz5CRqn6yjzW0j2iw20XzxqUwTKPfH/cZgfF8fdJrVwRsP6Ojz3dn3VqfVi8ps061H8/tVNGbV/pgtJpureu+CrXqXN+toc1/rd27r0bjb6F2o6qA9NP32UPWbvk8q5PCqJHx4PkwUxhloYAJL585wJUttoVxc6g6vj4uvUkjwANLuOpBxL3MTwZlv6j6ksFESVsZnKg1SjDkEO3G6E6dbcdodXlOPjp4caPSzrcu3QLmSrzchIelGl82o3e0c26S5BC5gIpCEVjv8zeckfCC4zlAazO895QKpzBctvp0WpEI0psoize93HNEM7Gyf4jF5zIMnxzXG16AhRYs67/L4UnmL5o3jbNFSamFKAym4xPfhuJf1zBYcvZ3WPrdOqx8C8J9TG0GCpZYzXKIxhQf3f7z3QZj3oK12s3Ae/ba8W9ZH8w8H+HHU7lCr92GTKxXG+u8M9fjyExV8kBo+BwAA" /></Footer>{/* END_ACCOUNTING_ATTACHMENT_FETCH_SUPPORTED_FIELDS */}
      tags:
      - subpackage_attachments
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: include_remote_data
        in: query
        description: Whether to include the original data Merge fetched from the third-party to produce these models.
        required: false
        schema:
          type: boolean
      - name: include_shell_data
        in: query
        description: Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
        required: false
        schema:
          type: boolean
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountingAttachment'
  /accounting/v1/attachments/meta/post:
    get:
      operationId: meta-post-retrieve
      summary: Meta Post Retrieve
      description: Returns metadata for `AccountingAttachment` POSTs.{/* BEGIN_ACCOUNTING_ATTACHMENT_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA9WU227aQBCGXwXtJcJ2gdAolqqKUw5UmARIlSiKVsN6MAvrXWcPQIny7pXBCtBGai+SSr3zjHb+mfnml58JA4uJ0j9ISIAx5aTlMiEVkqoYBQlJ8zXZtBbYLEVpSYVAxiNI8aiKLmukQozLMqUtxuccRWwuNU5JSIIUdYKek3zKMQ72RQGXFhMNlitpgtdib7qtJhUiuFxgXIzxZ7ndc6/I/BKaQHCTj5+BMXamlUtmQ3xyaP5COZ9NYL4/CC8GC8GBiqd3Mm/l8i1iFGgx7oCFDlpk+bpFx5m1mQmDYIYi87fd/RiXAcoAtOVMoAka9bPa6VnDK1S23b/SRHypludPEzU5LdOECQqu3B+zdTS+WkXz5CRqn6yjzW0j2iw20XzxqUwTKPfH/cZgfF8fdJrVwRsP6Ojz3dn3VqfVi8ps061H8/tVNGbV/pgtJpureu+CrXqXN+toc1/rd27r0bjb6F2o6qA9NP32UPWbvk8q5PCqJHx4PkwUxhloYAJL585wJUttoVxc6g6vj4uvUkjwANLuOpBxL3MTwZlv6j6ksFESVsZnKg1SjDkEO3G6E6dbcdodXlOPjp4caPSzrcu3QLmSrzchIelGl82o3e0c26S5BC5gIpCEVjv8zeckfCC4zlAazO895QKpzBctvp0WpEI0psoize93HNEM7Gyf4jF5zIMnxzXG16AhRYs67/L4UnmL5o3jbNFSamFKAym4xPfhuJf1zBYcvZ3WPrdOqx8C8J9TG0GCpZYzXKIxhQf3f7z3QZj3oK12s3Ae/ba8W9ZH8w8H+HHU7lCr92GTKxXG+u8M9fjyExV8kBo+BwAA" /></Footer>{/* END_ACCOUNTING_ATTACHMENT_FETCH_SUPPORTED_FIELDS */}
      tags:
      - subpackage_attachments
      parameters:
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaResponse'
  /ats/v1/attachments:
    get:
      operationId: list
      summary: List
      description: Returns a list of `Attachment` objects.{/* BEGIN_ATS_ATTACHMENT_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+WabW/aOhTHvwryy4qHtbTbinR1xWOBldABXddNk2WcQ2Jw7NRxoDDtu1+FhIfcO023qxm0vAOT/O38/D8+xw7fESUaHKnmqISIDlAWedIGjkqorDWhrgdCoywiPrOIB/FFeHqGsigIfV8qDXaDAbeDpoIRKqGCB8qBXCjYiIFdIDooMKHBUUQzKYLC+q7caHkbyiLOxATsMqUyFPoXOvF1ORJf+K+v0c9BNFKfBIF2lQwdtwcPIQS/koxGwyF6RsJzNtGksHV7TsX3/6wtGrcNHDTYNaJJDTTQ6AGTrlyt/aBUKLjA/fyy27wN0wKIAlGaUQ5B4aJ4efbu8iKXqCx7/xs7/K/Tk/HDUA7fnWCHckzCk86APlqD1swaO+dW9fzRWtxeWIvJwhpP3pxgh5x0Bp2L7uC+2K2VT7s/uQD3336+/FSpVdrWCV3Ui9b4fmYN6GlnQCfDRavYvqKzdvPjo7W4P+vUbovWoH7RvpKn3Wov6FR7slPO51EWbc8jKn39vt2QmKPs+5xRInRfEzpJ39PyiANbbOLZID7L+eGQM5oPinnikYUUZBbkqfQKHtiMFNKauP8QEgX4WjoSzyrN+0+96/zYd1bzwaRYTwYqobrVLFvVei1tjPKUME6GHFBJqxD+42VU+orI2v5Yz31AWUSJsJlNdPR5xDhgET108jlUHGWRAk9qwNFcpr9hn2gXfYvaHkKmwL4hinigQUWdffuR/SnNwB3ODUGMpFLsiuHHOzKd5X3xMtitm5j9dI5zb8hNgYy0ViSnw8nVaBTsBOJekVWIN5Sy2TMDbaW2bcB9BW2K3G+AUQALQ0EZax0ClF2vZJWQc1cqYYbbjZI+KD3Hp62NGF63nl2BAMXopqWYIF43nK8GtOfI/Q3/JQPP9ICqkOloWjNVLkPbDNthoo/VRh/TSB8HMcR+pea3JtM9J47dLX3V8qBvhmWklMq57XNr8iDre47yHaKTHoA2Ay/xN25RKXBX8PmhVCpPZqIEqEBLAZkB4SD0NROGSuMt7QPKIjv0lwIe92cii3CiR1J5iWiyvL2+Us7Of2KCMrPQatNIE7/tknvqjHYC7c9YqhEdHhBmqDJZqaWi8dU56koBCFeGgaFI3OgdQy3clB6o0JDh3FjsADz2bFc1eybr2GYPL9VepKOeQZFVW52+2bW+FUnuMj3+z137E0m05bDGpsQsi0T0UGrRZxilLYdTZqqWSsR2nvaMFaFPhmWqQtgYiYnVjnpun9ZJ+OHgTGUI3jVMQZmht5RKbanlvfN+Xrk7hqW9QwTRhJv1YSJ6AAWEYVrRkcFobhbWUpO9qpWtqwjlkGmEAZMik1sdKzLhmKzG4l7wRnzP5cQfNWJMODr7kWZoLqWOrbC9YcKXbPlnBBMRnai9NB8+EVoScKBGXM6MnsuCanA5S6XiN/5i3Gic7cSMe7Vev3yT6YeUQhA0CNVSBWZQpjVTLCv0s3Qab44hsPseUXrtKlNo06IptuP30+tR/e7FxPwz2EaZAhZmi6BY8/UVjAMgniaMS0N7lY3esaXqAfDoPdeqlgRDhww6ll29mYadvrI5NKSKjEZMG47kWBSPB3b74sv1HwzpJz797YerzI2SW5sTMyBuP1ytzmDOKg/2Y5cdg5fugFPpQUbLjHYh0w6Fww2/U026wFpi7QKOu3hx/7W5k2qy7N4Im5VaqhbpTjm3+OWLyQq/QdAmhk9hEtFjCNUv0l2vemYhfpGuXGXS15lHv/34B3jX2YDdMAAA" /></Footer>{/* END_ATS_ATTACHMENT_FETCH_SUPPORTED_FIELDS */}
      tags:
      - subpackage_attachments
      parameters:
      - name: candidate_id
        in: query
        description: If provided, will only return attachments for this candidate.
        required: false
        schema:
          type: string
      - name: created_after
        in: query
        description: If provided, will only return objects created after this datetime.
        required: false
        schema:
          type: string
          format: date-time
      - name: created_before
        in: query
        description: If provided, will only return objects created before this datetime.
        required: false
        schema:
          type: string
          format: date-time
      - name: cursor
        in: query
        description: The pagination cursor value.
        required: false
        schema:
          type: string
      - name: expand
        in: query
        description: Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
        required: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/AttachmentsGetParametersExpandSchemaItems'
      - name: include_deleted_data
        in: query
        description: Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
        required: false
        schema:
          type: boolean
      - name: include_remote_data
        in: query
        description: Whether to include the original data Merge fetched from the third-party to produce these models.
        required: false
        schema:
          type: boolean
      - name: include_shell_data
        in: query
        description: Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
        required: false
        schema:
          type: boolean
      - name: modified_after
        in: query
        description: If provided, only objects synced by Merge after this date time will be returned.
        required: false
        schema:
          type: string
          format: date-time
      - name: modified_before
        in: query
        description: If provided, only objects synced by Merge before this date time will be returned.
        required: false
        schema:
          type: string
          format: date-time
      - name: page_size
        in: query
        description: Number of results to return per page. The maximum limit is 100.
        required: false
        schema:
          type: integer
      - name: remote_fields
        in: query
        description: Deprecated. Use show_enum_origins.
        required: false
        schema:
          $ref: '#/components/schemas/AttachmentsGetParametersRemoteFields'
      - name: remote_id
        in: query
        description: The API provider's ID for the given object.
        required: false
        schema:
          type: string
      - name: show_enum_origins
        in: query
        description: A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
        required: false
        schema:
          $ref: '#/components/schemas/AttachmentsGetParametersShowEnumOrigins'
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedAttachmentList'
    post:
      operationId: create
      summary: Create
      description: Creates an `Attachment` object with the given values.{/* BEGIN_ATS_ATTACHMENT_CREATE_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="POST" data="H4sIAAAAAAAAA92Ya2/iOBSG/wryRwRkWtqdKdJqxaVl6JTQKXQ71aiKDs4hGJw4tR0ojPrfR4bQwpYiOjK97LfE2G/s57w+x+YXoaAxEHJCSgS0IjkSCh85KZGy1kD7IUaa5AjEzIUQ55280T7JEZXEsZAa/ROG3FdfJfZIiTghygDzScR6DH0HtHJYpDGQoJmIlPMwKt+bDSM5wlk0RL9MqUgivUFn3i8P847/eTU/KzPTGJTSfSmSoH+BtwmqTZJmNhzNGoHnfdDgLA3Py/n4dW1m3j5y1OjXQEMNNVKzwPRTfa1jVXKcPvK4MPtswceRg5EDUjPKUTmHxaP9z0eH+VRl9vV/vID/vZcd3HZF93PWCyj3IMk2O/TO7TTG7iA4cKsHd+708tCdDqfuYPgp6wWQbXaah63OdbFVK++11nTw2n/9OPq3Uquculk6PS66g+ux26F7zQ4ddqeN4mmdjk+/fr9zp9f7zdpl0e0cH57WxV6reqGa1QvRLBcKJEeW40hKP38tN6TmKKt+d7LatRFCgEtI5kGAmOXjpMsZLahiAUKYigjGqkBF6IToM3BmUl77NgGJ3pkIhFdMvl/BaFyIo2BBn4noAT0pkWP3a9mtHtdWbVAeAePQ5UhKWib4xLmk9JPAg9k9PYmR5AiFyGc+aPPcYxy9yCwxfU4kJzkiMRQaPeaTG/NymzCJ/jlICFGjnOk+UTEjb+5z6+FNwi63Rc9oLfCNusN6r6d2Qs4Op6XeS6v3YtNJrW0sxKD73pjpvod3GiNlFvIc2RHoRKIdtOccdE/IMBV9x1BfYr6KRJxa2rpzreW9WxjE72LPvgzV9l6kIowhmphorPeqUGz2bsL1TAASzvtCRpZMKkWMUk+8vcbSbB5a9+sYoWT0saWYRuuh4WAxoY9k8Cfx3sw6c4FUJkwbD2WqXCS+HfrdVN+Tj/oeNfqemmNuV2pxYzh641q2BeI/Kow7SOEn5pAHzNL2WKit5KgPfa7YMgipdKJQbshFdYkY9UWiLJXMR733WBRsAd+OLas2mm27J5GGkUwzy1u5eGN13Xb8emJnOEJph9hMauVSIa6DL5PK1U68uMNT3LZua0mgHDMnicmtmfyi4LEosFnv5l/xHsXf2IyvephIEXeAo7CDcyb1UTPlM5Ta5fNMO6EUlToBqoVUdlitaq5s7Qr9IYKTT+8FnnXjtUOQOt1zaI3nqugK0MGX0Vnv+Opj7+qXnVAHouvN0G3IsR2EUAPjwlKRetTbeQ54/f8ZOsi5uW0tLGbphKnnsosLF+IuK9DrU7v8Vs+cS7FUvu1gu/xWX9xI9yu3/l2LfajN/SdZeD3gKyGHs0VYwbpQW8merRHnLj96q3K0E1+ahfowsXuduZqL/i+deHN/c/8bakgbv3QbAAA=" /></Footer>{/* END_ATS_ATTACHMENT_CREATE_SUPPORTED_FIELDS */}
      tags:
      - subpackage_attachments
      parameters:
      - name: is_debug_mode
        in: query
        description: Whether to include debug fields (such as log file links) in the response.
        required: false
        schema:
          type: boolean
      - name: run_async
        in: query
        description: Whether or not third-party updates should be run asynchronously.
        required: false
        schema:
          type: boolean
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttachmentResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AttachmentEndpointRequest'
  /ats/v1/attachments/{id}:
    get:
      operationId: retrieve
      summary: Retrieve
      description: Returns an `Attachment` object with the given `id`.{/* BEGIN_ATS_ATTACHMENT_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+WabW/aOhTHvwryy4qHtbTbinR1xWOBldABXddNk2WcQ2Jw7NRxoDDtu1+FhIfcO023qxm0vAOT/O38/D8+xw7fESUaHKnmqISIDlAWedIGjkqorDWhrgdCoywiPrOIB/FFeHqGsigIfV8qDXaDAbeDpoIRKqGCB8qBXCjYiIFdIDooMKHBUUQzKYLC+q7caHkbyiLOxATsMqUyFPoXOvF1ORJf+K+v0c9BNFKfBIF2lQwdtwcPIQS/koxGwyF6RsJzNtGksHV7TsX3/6wtGrcNHDTYNaJJDTTQ6AGTrlyt/aBUKLjA/fyy27wN0wKIAlGaUQ5B4aJ4efbu8iKXqCx7/xs7/K/Tk/HDUA7fnWCHckzCk86APlqD1swaO+dW9fzRWtxeWIvJwhpP3pxgh5x0Bp2L7uC+2K2VT7s/uQD3336+/FSpVdrWCV3Ui9b4fmYN6GlnQCfDRavYvqKzdvPjo7W4P+vUbovWoH7RvpKn3Wov6FR7slPO51EWbc8jKn39vt2QmKPs+5xRInRfEzpJ39PyiANbbOLZID7L+eGQM5oPinnikYUUZBbkqfQKHtiMFNKauP8QEgX4WjoSzyrN+0+96/zYd1bzwaRYTwYqobrVLFvVei1tjPKUME6GHFBJqxD+42VU+orI2v5Yz31AWUSJsJlNdPR5xDhgET108jlUHGWRAk9qwNFcpr9hn2gXfYvaHkKmwL4hinigQUWdffuR/SnNwB3ODUGMpFLsiuHHOzKd5X3xMtitm5j9dI5zb8hNgYy0ViSnw8nVaBTsBOJekVWIN5Sy2TMDbaW2bcB9BW2K3G+AUQALQ0EZax0ClF2vZJWQc1cqYYbbjZI+KD3Hp62NGF63nl2BAMXopqWYIF43nK8GtOfI/Q3/JQPP9ICqkOloWjNVLkPbDNthoo/VRh/TSB8HMcR+pea3JtM9J47dLX3V8qBvhmWklMq57XNr8iDre47yHaKTHoA2Ay/xN25RKXBX8PmhVCpPZqIEqEBLAZkB4SD0NROGSuMt7QPKIjv0lwIe92cii3CiR1J5iWiyvL2+Us7Of2KCMrPQatNIE7/tknvqjHYC7c9YqhEdHhBmqDJZqaWi8dU56koBCFeGgaFI3OgdQy3clB6o0JDh3FjsADz2bFc1eybr2GYPL9VepKOeQZFVW52+2bW+FUnuMj3+z137E0m05bDGpsQsi0T0UGrRZxilLYdTZqqWSsR2nvaMFaFPhmWqQtgYiYnVjnpun9ZJ+OHgTGUI3jVMQZmht5RKbanlvfN+Xrk7hqW9QwTRhJv1YSJ6AAWEYVrRkcFobhbWUpO9qpWtqwjlkGmEAZMik1sdKzLhmKzG4l7wRnzP5cQfNWJMODr7kWZoLqWOrbC9YcKXbPlnBBMRnai9NB8+EVoScKBGXM6MnsuCanA5S6XiN/5i3Gic7cSMe7Vev3yT6YeUQhA0CNVSBWZQpjVTLCv0s3Qab44hsPseUXrtKlNo06IptuP30+tR/e7FxPwz2EaZAhZmi6BY8/UVjAMgniaMS0N7lY3esaXqAfDoPdeqlgRDhww6ll29mYadvrI5NKSKjEZMG47kWBSPB3b74sv1HwzpJz797YerzI2SW5sTMyBuP1ytzmDOKg/2Y5cdg5fugFPpQUbLjHYh0w6Fww2/U026wFpi7QKOu3hx/7W5k2qy7N4Im5VaqhbpTjm3+OWLyQq/QdAmhk9hEtFjCNUv0l2vemYhfpGuXGXS15lHv/34B3jX2YDdMAAA" /></Footer>{/* END_ATS_ATTACHMENT_FETCH_SUPPORTED_FIELDS */}
      tags:
      - subpackage_attachments
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: expand
        in: query
        description: Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
        required: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/AttachmentsIdGetParametersExpandSchemaItems'
      - name: include_remote_data
        in: query
        description: Whether to include the original data Merge fetched from the third-party to produce these models.
        required: false
        schema:
          type: boolean
      - name: include_shell_data
        in: query
        description: Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
        required: false
        schema:
          type: boolean
      - name: remote_fields
        in: query
        description: Deprecated. Use show_enum_origins.
        required: false
        schema:
          $ref: '#/components/schemas/AttachmentsIdGetParametersRemoteFields'
      - name: show_enum_origins
        in: query
        description: A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
        required: false
        schema:
          $ref: '#/components/schemas/AttachmentsIdGetParametersShowEnumOrigins'
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Attachment'
  /ats/v1/attachments/meta/post:
    get:
      operationId: meta-post-retrieve
      summary: Meta Post Retrieve
      description: Returns metadata for `Attachment` POSTs.{/* BEGIN_ATS_ATTACHMENT_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+WabW/aOhTHvwryy4qHtbTbinR1xWOBldABXddNk2WcQ2Jw7NRxoDDtu1+FhIfcO023qxm0vAOT/O38/D8+xw7fESUaHKnmqISIDlAWedIGjkqorDWhrgdCoywiPrOIB/FFeHqGsigIfV8qDXaDAbeDpoIRKqGCB8qBXCjYiIFdIDooMKHBUUQzKYLC+q7caHkbyiLOxATsMqUyFPoXOvF1ORJf+K+v0c9BNFKfBIF2lQwdtwcPIQS/koxGwyF6RsJzNtGksHV7TsX3/6wtGrcNHDTYNaJJDTTQ6AGTrlyt/aBUKLjA/fyy27wN0wKIAlGaUQ5B4aJ4efbu8iKXqCx7/xs7/K/Tk/HDUA7fnWCHckzCk86APlqD1swaO+dW9fzRWtxeWIvJwhpP3pxgh5x0Bp2L7uC+2K2VT7s/uQD3336+/FSpVdrWCV3Ui9b4fmYN6GlnQCfDRavYvqKzdvPjo7W4P+vUbovWoH7RvpKn3Wov6FR7slPO51EWbc8jKn39vt2QmKPs+5xRInRfEzpJ39PyiANbbOLZID7L+eGQM5oPinnikYUUZBbkqfQKHtiMFNKauP8QEgX4WjoSzyrN+0+96/zYd1bzwaRYTwYqobrVLFvVei1tjPKUME6GHFBJqxD+42VU+orI2v5Yz31AWUSJsJlNdPR5xDhgET108jlUHGWRAk9qwNFcpr9hn2gXfYvaHkKmwL4hinigQUWdffuR/SnNwB3ODUGMpFLsiuHHOzKd5X3xMtitm5j9dI5zb8hNgYy0ViSnw8nVaBTsBOJekVWIN5Sy2TMDbaW2bcB9BW2K3G+AUQALQ0EZax0ClF2vZJWQc1cqYYbbjZI+KD3Hp62NGF63nl2BAMXopqWYIF43nK8GtOfI/Q3/JQPP9ICqkOloWjNVLkPbDNthoo/VRh/TSB8HMcR+pea3JtM9J47dLX3V8qBvhmWklMq57XNr8iDre47yHaKTHoA2Ay/xN25RKXBX8PmhVCpPZqIEqEBLAZkB4SD0NROGSuMt7QPKIjv0lwIe92cii3CiR1J5iWiyvL2+Us7Of2KCMrPQatNIE7/tknvqjHYC7c9YqhEdHhBmqDJZqaWi8dU56koBCFeGgaFI3OgdQy3clB6o0JDh3FjsADz2bFc1eybr2GYPL9VepKOeQZFVW52+2bW+FUnuMj3+z137E0m05bDGpsQsi0T0UGrRZxilLYdTZqqWSsR2nvaMFaFPhmWqQtgYiYnVjnpun9ZJ+OHgTGUI3jVMQZmht5RKbanlvfN+Xrk7hqW9QwTRhJv1YSJ6AAWEYVrRkcFobhbWUpO9qpWtqwjlkGmEAZMik1sdKzLhmKzG4l7wRnzP5cQfNWJMODr7kWZoLqWOrbC9YcKXbPlnBBMRnai9NB8+EVoScKBGXM6MnsuCanA5S6XiN/5i3Gic7cSMe7Vev3yT6YeUQhA0CNVSBWZQpjVTLCv0s3Qab44hsPseUXrtKlNo06IptuP30+tR/e7FxPwz2EaZAhZmi6BY8/UVjAMgniaMS0N7lY3esaXqAfDoPdeqlgRDhww6ll29mYadvrI5NKSKjEZMG47kWBSPB3b74sv1HwzpJz797YerzI2SW5sTMyBuP1ytzmDOKg/2Y5cdg5fugFPpQUbLjHYh0w6Fww2/U026wFpi7QKOu3hx/7W5k2qy7N4Im5VaqhbpTjm3+OWLyQq/QdAmhk9hEtFjCNUv0l2vemYhfpGuXGXS15lHv/34B3jX2YDdMAAA" /></Footer>{/* END_ATS_ATTACHMENT_FETCH_SUPPORTED_FIELDS */}
      tags:
      - subpackage_attachments
      parameters:
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaResponse'
  /knowledgebase/v1/attachments:
    get:
      operationId: list
      summary: List
      description: Returns a list of `Attachment` objects.
      tags:
      - subpackage_attachments
      parameters:
      - name: created_after
        in: query
        description: If provided, will only return objects created after this datetime.
        required: false
        schema:
          type: string
          format: date-time
      - name: created_before
        in: query
        description: If provided, will only return objects created before this datetime.
        required: false
        schema:
          type: string
          format: date-time
      - name: cursor
        in: query
        description: The pagination cursor value.
        required: false
        schema:
          type: string
      - name: include_deleted_data
        in: query
        description: Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
        required: false
        schema:
          type: boolean
      - name: include_remote_data
        in: query
        description: Whether to include the original data Merge fetched from the third-party to produce these models.
        required: false
        schema:
          type: boolean
      - name: include_shell_data
        in: query
        description: Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
        required: false
        schema:
          type: boolean
      - name: modified_after
        in: query
        description: If provided, only objects synced by Merge after this date time will be returned.
        required: false
        schema:
          type: string
          format: date-time
      - name: modified_before
        in: query
        description: If provided, only objects synced by Merge before this date time will be returned.
        required: false
        schema:
          type: string
          format: date-time
      - name: page_size
        in: query
        description: Number of results to return per page. The maximum limit is 100.
        required: false
        schema:
          type: integer
      - name: remote_id
        in: query
        description: The API provider's ID for the given object.
        required: false
        schema:
          type: string
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedAttachmentList'
  /knowledgebase/v1/attachments/{id}:
    get:
      operationId: retrieve
      summary: Retrieve
      description: Returns an `Attachment` object with the given `id`.
      tags:
      - subpackage_attachments
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: include_remote_data
        in: query
        description: Whether to include the original data Merge fetched from the third-party to produce these models.
        required: false
        schema:
          type: boolean
      - name: include_shell_data
        in: query
        description: Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
        required: false
        schema:
          type: boolean
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Attachment_2'
  /ticketing/v1/attachments:
    get:
      operationId: list
      summary: List
      description: Returns a list of `Attachment` objects.{/* BEGIN_TICKETING_ATTACHMENT_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+2Z/2/iNhTA/xXmHxGQtVx3KtI0UdIvdCXttWnveqcqejiPxODEwXag5XT/++QQCt2q3W41a9fyG1jOJ/Enz+/ZzldCQWMk5B1pEc3oCDVLI1IjiQiRkxZpaw00TjDVpEYgYx4kuNo1mGyTGlF5lgmpMTxgyEN1JHFAWsRJUEZYz1M2YBg699c4LNUYSdBMpMq5v7Y+KC4mNcJZOsKwTanIU/1d2rx3Hebd//RXOZwp8+wZKKVjKfIoPsdxjur7YPNkHM3YgddD0OCsQOpyTnmszYwhRI4aQxc0uKiRmsGWN4y1zlTLcWLkWaO4eSP

# --- truncated at 32 KB (68 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/openapi/merge-subpackage-attachments-api-openapi.yml
Merge subpackage_attachments API

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification
