Merge ATS API

openapi: 3.1.0
info:
  title: ATS
  version: 1.0.0
paths:
  /ats/v1/activities:
    get:
      operationId: list
      summary: List
      description: >-
        Returns a list of `Activity` objects.{/* BEGIN_ATS_ACTIVITY_FETCH_SUPPORTED_FIELDS
        */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET"
        data="H4sIAAAAAAAAA92YbW/iOBSF/0rljwjItJTtFmm14qWFMiW0QKfTHVXRjXNJTJw42A4URvPfV4HQkt1qtG1TmO43Yuzj5PHx8U2+EwoaXSEXpEZAK1IkgXCQkxqpU81mTC9IkUDETAhw3cWaHZEiUXEUCanROWfIHdWROCY1YgQoXSzFIRszdAzQymChRleCZiJUxuOo0ng1jBQJZ6GPTp1SEYf6JzrrfiVYd/zHZfK30qRIIlBKe1LErjfAaYzqZ5LJ3XAMMNTASw5oMLaGl+R6/HNtyX07yFGj0wINLdRIkwdMp/K0jlTNMDzkUXk1bdnBmYGhAVIzylEZ1crp0clptZSqrGb/03L5H4eFydQW9knBcim3IC70RvTBHF3MzYl7bDaPH8zlTdVc+ktz4n8qWC4UeqNetT+6q/Rb9cP+Mx2s4W9fT780Wo2uWaDLs4o5uZubI3rYG1HfXl5Uum0673auH8zl3VGvdVMxR2fVblsc9psD1WsORK9eLpMi2V5HUvv2fbshNUc9ijijEOqhBupnx1wE4OIWm/VqQMRKUWxzRsuqUoYAliKEuSpTERgBOgyMrKY1nMYg0boUrrDmjc7dl8FleRK5m/VgInxcDFIjZ2anbjbPWllj1GfAONgcSU3LGP/lZVL7RiA1v6UXEZIikRgIjRaVCBodC/RTW7J02SsrAu2t9og9QZp0jRVKcp90msZMonMFEgLUKJPJ7n8Un6WpPHuRE8REKsOuEl/fwmxejsL3Z2cLJ3kOCqHDHNCvxpk2MefVQBeBzfMimmhtkM5svz0eq33RfPxtjf084L7Nt42Yc0/I8GCAVMZMJ/l60OQidvJBb6f6lnzSt2iib6n1cgwbrejCn31Yc7+Nf7M+GuZDOlHKpEb32PSn4mwniZuC3TPMcw6aejIfnlcc9FjIIBW1/KDZ9C6m/9PYKJIZU8xmPKkhX4o9KeqAhflw36hte3kn0Pds3rZEDD0RK8yH45NehuQO0+A9Y/Ytfu2IAGWck129tdguY+GN5e3rwXVhuewM8uG21socWLfXtNfqOb/uK0J+m70r7CEVMqetvlErrUuqD1tKvXlnX+JspZAD05VUxp7izv190bjdS4L+eod+D0LQwPOttVLRvRg4Z8QvxDkEFw/yytZEzNoK14o9Pz7pfZgj6qXo6lcHw5hSVOocqBZS5UQxo5mJggb9KtzzT3supt7v48sIIdDAuMgpTJ/09lWL7vm8H0kYj5nONy1TUWsycrrVvy53sr9zPO9fiPDmc/vgSorNhyq2etgcaN58bm8+RR01ps5Dn70LyB280r/GmLdC+qs7z4XlbaqWCcv+jHOTn36oN8//vNvvf/wNPD9x3ZUbAAA="
        /></Footer>{/* END_ATS_ACTIVITY_FETCH_SUPPORTED_FIELDS */}
      tags:
        - subpackage_activities
      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: 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/ActivitiesGetParametersExpandSchemaItems'
        - 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/ActivitiesGetParametersRemoteFields'
        - 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/ActivitiesGetParametersShowEnumOrigins'
        - name: user_id
          in: query
          description: If provided, will only return activities done by this user.
          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/PaginatedActivityList'
    post:
      operationId: create
      summary: Create
      description: >-
        Creates an `Activity` object with the given values.{/* BEGIN_ATS_ACTIVITY_CREATE_SUPPORTED_FIELDS
        */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="POST"
        data="H4sIAAAAAAAAA82Wa2/aShCG/wraj8jYTShtg3R0xCUh0GJSLm2jKrLGu4NZWHvN7hoCVf57ZQMJtKTpOXXbfPR45p31M7Pj+UIoGAykWpEqAaOJRULJUJAqqVHDF9ysiEUg5i6EuHHxFqfEIjqJY6kMsguOgulLhWNSJU6IKsBSEvExR+aA0Q6PDAYKDJeRdu6jSuMsjFhE8GiGrEapTCLzA52NXwk2jt88pq+1IRaJQWszUTIJJn2cJ6h/JJmeRmCIkQFRYmDA2QsvqU38MVt6boYCDbImGGiiQZp+4DbVxJhYVx1ngiK2s7Q2w4WDkQPKcCpQO5Xy2enrs0ppq5Jl/9cLxD8nxencl/7rohdQ4UFS7A7prTtsL91p8NJtvLx116OKu56t3ensRdELoNgddiu94XW516yd9I44eINXn84+1Jv1jluk6/OyO71eukN60h3Smb9ulzstuuxcvr9119en3eao7A7PK52WPOk1+rrb6MtuzbaJRfbrSKqfv+wbts1R0xM/bZe9N+0QAtxDsikCxLwUJ77g1NZlG0JYywiW2qYydEJkHJxMyhvME1DovZOB9MrJ+4+wWNpxFOzocxndoydVcu5e1tzGefOwDWoL4AJ8gaRqVILfdS6pfiawbXXPrGIkFvElS7+DQsQ4A5OaFIbSoEcVgkHmgXmwcUYskmhU5Ca1zROukF2BghANqizBVnAPjBenDtq+z+FlaFKxmzvrON1V6Iu88KZaO74Lf9Yaj/VfQeuNZz9BVyf+FKl5kvPO7xGE9USIiVRRoY9UJdykV7/QEDJh+WD1t/qeetD3aKrv6Q3qQb0Zt2eLZ9jF6QQ6fPJiMJP/WYhvz/JwiEdK01KI0UQmGvMpxYPe/hSxp/Fz434Mq0UWXHOfi/T3mx/jdjTmETdYqCvQus+zHsyB9U531+RSvhrRTvkZNnk6XZ+Y0U9S7Ei/xlhWpRzYXQkwY6nCqfQhVd0y/JPscvi1PYLqHS7y4pRJHSwE8jp4s6p/fJ5X+pc2gYz6L+0Kg9pVYZBQilpfADVS6XyqcKh5UI46/SSDixd/uRx5XPDR21bhSsndkpDbmBy9be0m5Gl9zm57/Lfc8iNw/uO29VO77L7+JuDu5u4rFsLq0U8OAAA="
        /></Footer>{/* END_ATS_ACTIVITY_CREATE_SUPPORTED_FIELDS */}
      tags:
        - subpackage_activities
      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/ActivityResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActivityEndpointRequest'
  /ats/v1/activities/{id}:
    get:
      operationId: retrieve
      summary: Retrieve
      description: >-
        Returns an `Activity` object with the given `id`.{/* BEGIN_ATS_ACTIVITY_FETCH_SUPPORTED_FIELDS
        */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET"
        data="H4sIAAAAAAAAA92YbW/iOBSF/0rljwjItJTtFmm14qWFMiW0QKfTHVXRjXNJTJw42A4URvPfV4HQkt1qtG1TmO43Yuzj5PHx8U2+EwoaXSEXpEZAK1IkgXCQkxqpU81mTC9IkUDETAhw3cWaHZEiUXEUCanROWfIHdWROCY1YgQoXSzFIRszdAzQymChRleCZiJUxuOo0ng1jBQJZ6GPTp1SEYf6JzrrfiVYd/zHZfK30qRIIlBKe1LErjfAaYzqZ5LJ3XAMMNTASw5oMLaGl+R6/HNtyX07yFGj0wINLdRIkwdMp/K0jlTNMDzkUXk1bdnBmYGhAVIzylEZ1crp0clptZSqrGb/03L5H4eFydQW9knBcim3IC70RvTBHF3MzYl7bDaPH8zlTdVc+ktz4n8qWC4UeqNetT+6q/Rb9cP+Mx2s4W9fT780Wo2uWaDLs4o5uZubI3rYG1HfXl5Uum0673auH8zl3VGvdVMxR2fVblsc9psD1WsORK9eLpMi2V5HUvv2fbshNUc9ijijEOqhBupnx1wE4OIWm/VqQMRKUWxzRsuqUoYAliKEuSpTERgBOgyMrKY1nMYg0boUrrDmjc7dl8FleRK5m/VgInxcDFIjZ2anbjbPWllj1GfAONgcSU3LGP/lZVL7RiA1v6UXEZIikRgIjRaVCBodC/RTW7J02SsrAu2t9og9QZp0jRVKcp90msZMonMFEgLUKJPJ7n8Un6WpPHuRE8REKsOuEl/fwmxejsL3Z2cLJ3kOCqHDHNCvxpk2MefVQBeBzfMimmhtkM5svz0eq33RfPxtjf084L7Nt42Yc0/I8GCAVMZMJ/l60OQidvJBb6f6lnzSt2iib6n1cgwbrejCn31Yc7+Nf7M+GuZDOlHKpEb32PSn4mwniZuC3TPMcw6aejIfnlcc9FjIIBW1/KDZ9C6m/9PYKJIZU8xmPKkhX4o9KeqAhflw36hte3kn0Pds3rZEDD0RK8yH45NehuQO0+A9Y/Ytfu2IAGWck129tdguY+GN5e3rwXVhuewM8uG21socWLfXtNfqOb/uK0J+m70r7CEVMqetvlErrUuqD1tKvXlnX+JspZAD05VUxp7izv190bjdS4L+eod+D0LQwPOttVLRvRg4Z8QvxDkEFw/yytZEzNoK14o9Pz7pfZgj6qXo6lcHw5hSVOocqBZS5UQxo5mJggb9KtzzT3supt7v48sIIdDAuMgpTJ/09lWL7vm8H0kYj5nONy1TUWsycrrVvy53sr9zPO9fiPDmc/vgSorNhyq2etgcaN58bm8+RR01ps5Dn70LyB280r/GmLdC+qs7z4XlbaqWCcv+jHOTn36oN8//vNvvf/wNPD9x3ZUbAAA="
        /></Footer>{/* END_ATS_ACTIVITY_FETCH_SUPPORTED_FIELDS */}
      tags:
        - subpackage_activities
      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/ActivitiesIdGetParametersExpandSchemaItems'
        - 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/ActivitiesIdGetParametersRemoteFields'
        - 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/ActivitiesIdGetParametersShowEnumOrigins'
        - 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/Activity'
  /ats/v1/activities/meta/post:
    get:
      operationId: meta-post-retrieve
      summary: Meta Post Retrieve
      description: >-
        Returns metadata for `Activity` POSTs.{/* BEGIN_ATS_ACTIVITY_FETCH_SUPPORTED_FIELDS
        */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET"
        data="H4sIAAAAAAAAA92YbW/iOBSF/0rljwjItJTtFmm14qWFMiW0QKfTHVXRjXNJTJw42A4URvPfV4HQkt1qtG1TmO43Yuzj5PHx8U2+EwoaXSEXpEZAK1IkgXCQkxqpU81mTC9IkUDETAhw3cWaHZEiUXEUCanROWfIHdWROCY1YgQoXSzFIRszdAzQymChRleCZiJUxuOo0ng1jBQJZ6GPTp1SEYf6JzrrfiVYd/zHZfK30qRIIlBKe1LErjfAaYzqZ5LJ3XAMMNTASw5oMLaGl+R6/HNtyX07yFGj0wINLdRIkwdMp/K0jlTNMDzkUXk1bdnBmYGhAVIzylEZ1crp0clptZSqrGb/03L5H4eFydQW9knBcim3IC70RvTBHF3MzYl7bDaPH8zlTdVc+ktz4n8qWC4UeqNetT+6q/Rb9cP+Mx2s4W9fT780Wo2uWaDLs4o5uZubI3rYG1HfXl5Uum0673auH8zl3VGvdVMxR2fVblsc9psD1WsORK9eLpMi2V5HUvv2fbshNUc9ijijEOqhBupnx1wE4OIWm/VqQMRKUWxzRsuqUoYAliKEuSpTERgBOgyMrKY1nMYg0boUrrDmjc7dl8FleRK5m/VgInxcDFIjZ2anbjbPWllj1GfAONgcSU3LGP/lZVL7RiA1v6UXEZIikRgIjRaVCBodC/RTW7J02SsrAu2t9og9QZp0jRVKcp90msZMonMFEgLUKJPJ7n8Un6WpPHuRE8REKsOuEl/fwmxejsL3Z2cLJ3kOCqHDHNCvxpk2MefVQBeBzfMimmhtkM5svz0eq33RfPxtjf084L7Nt42Yc0/I8GCAVMZMJ/l60OQidvJBb6f6lnzSt2iib6n1cgwbrejCn31Yc7+Nf7M+GuZDOlHKpEb32PSn4mwniZuC3TPMcw6aejIfnlcc9FjIIBW1/KDZ9C6m/9PYKJIZU8xmPKkhX4o9KeqAhflw36hte3kn0Pds3rZEDD0RK8yH45NehuQO0+A9Y/Ytfu2IAGWck129tdguY+GN5e3rwXVhuewM8uG21socWLfXtNfqOb/uK0J+m70r7CEVMqetvlErrUuqD1tKvXlnX+JspZAD05VUxp7izv190bjdS4L+eod+D0LQwPOttVLRvRg4Z8QvxDkEFw/yytZEzNoK14o9Pz7pfZgj6qXo6lcHw5hSVOocqBZS5UQxo5mJggb9KtzzT3supt7v48sIIdDAuMgpTJ/09lWL7vm8H0kYj5nONy1TUWsycrrVvy53sr9zPO9fiPDmc/vgSorNhyq2etgcaN58bm8+RR01ps5Dn70LyB280r/GmLdC+qs7z4XlbaqWCcv+jHOTn36oN8//vNvvf/wNPD9x3ZUbAAA="
        /></Footer>{/* END_ATS_ACTIVITY_FETCH_SUPPORTED_FIELDS */}
      tags:
        - subpackage_activities
      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/applications:
    get:
      operationId: list
      summary: List
      description: >-
        Returns a list of `Application` objects.{/* BEGIN_ATS_APPLICATION_FETCH_SUPPORTED_FIELDS
        */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET"
        data="H4sIAAAAAAAAA+1caXPaOBj+K4w/ZjiakPTIzM4OVzgaTAokabrT8cjyixHYkiPLEOj0v+/IR4J3k7YQmUCbTxkb+bH96HlPyfmmYSTAZnyhnWpI+Fpec5kFjnaqVTzPIRgJwqiW15BHdORCNMqYHWl5zQ88j3EB1hkBx/JbHEbaqVZygdtQCCgZEbBKSPglQgXYPETyS/dXFUbhZVpecwidglXBmAVU/AAnGldA0cD/HMqffaHlNQ/5vhhzFtjjPtwG4P8IUj6NAy5QgZyChQQqrVxe4NH1j52Tz22BAwKsOhKoDgKwfMH4VmMhPP+0VBqD4xXD2xYtmJWAlhAXBDvgl07KH47efTgpxCjh3f82bOevw4PJrcnMdweGjR0DBQfdIb7Th+25PrGP9drxnb68PNGX06U+mb45MGx00B12T3rDm3KvXjnsPTLAGLz9/OGqWq929AO8bJT1yc1cH+LD7hBPzWW73Gnieaf16U5f3hx165dlfdg46TTZYa/W97u1PutWikUtr63Oo3b6z7fVE7E4YtFQMRAIT9PXtF1kwwo30WwgjxS8wHQILvrlInLRklE094uYuSUXLIJKaUxjcBsgDsY5s5kxr7ZurvrnxYlnJ/NBGL2fDO1Ua+itil5r1NPCqMwQcZDpgHYqeAD/07J2+o+GEbWIhQRoeQ1zsIgAyxBMHgWcAxWGL+QL5bUJM7W8xmECWBgckB9aDAeXCTDktKaPDA+JsbQfFnAM2lf5421AOFgXiCMXBHD5AF+/5x9l2B+bC0XESqgUn+Xg0zWazYseVc/nAHMASqj9SdoPYbRC/TnwIgr/aPmnB6Qc0VOjQqv88ZD0jPzCqGSmnhoaUHIbgEEsoEL6FPkWK09ryDniMwJzP/kBLANJJ5US16NyYqOR1MFjupLHCdBPVRafIpZUXPIeRsKWEbHvP0OOC9d0VOlRYiWCnJnT5mjkZ6LFp+ciC0NPTcFmLM+QCDioofnCQWLEuBuDZkLwz/W9BmtrklVFrslYq6+GrQRt1U9mEm9+Q/+4Kvw13d9L+7UqB1gqirMR1quAnhbQatD0MeOAEQ9Lg2c66p9lYBnoJnCcMeNUkavmzAMuFsZh+wHMuD971AQKnOCHM+XYS92fOE4eaMtxVIFRP4v/XB8wD4iQpV2u5rDAUjMjZoxv8Ad8A0t8w4+oH1TrXns62/2wuinFtcpwoIZMiZSqPzrH+vSWNTKJr9lpdV3+HLRQlZ0kuVyEmUjwTWtOT+rnLyLBtclgeDpnXFGv4B4u82j7pJwylw9zAYQaumInabQxo0aPOos/JErUGKfAfcEo5IbIASrOCVUlwQfslxPhyzHLwYkeQaV3i0Bj97ZnGl2TQKt4RSgmagmszySm8baHbrA92v3UZE3OGtRGNihLS+7h/gjBNTyHKSp0Q6j9JG1Tf3fmIIHHXK25xqDG1K3Vxu3bXbXXDRmTq3WIKKqQE7RUqM1Megr6+hmx2gRXrQab4Bp3syv88fBk91rwmSyObMa77CCNWeArSnke8H4xedQrw/ZVQ7WelffidmfGWoibLOA5ZelCYjExcFKEWzfN2vWX7q46743zhRZzgQeK3Pc4Atuuh8mcob7KjmOrb4Roe1ZMrskZqbW7iu2xLSGzzEbXWsTP3K+16YhQIiBX5cj3+yR8YQV0JriJX2Ps7SXulPcgv1+TwA5aLlX1ZSOsVG/7+hPu1rvW69rxI0t/+7Mu3GFmxbLC9XiFrmrCTCRRX6Z2VrGU+nz/1WFmncyQWmJj0F0kVFEavD7LA5nUK3JzMVphL3s+61M3I6pa2zHYdtoWG+063ILBq2oCPVg7oUmasrAOGyj4mHnitzX/eA4zVWEnhEolJ+zGfr+oXu95cvI79DTUpyw9jAOPeWqkE4Ptp8PfmEHqLEYLtb4qxCS/V+OjxxF2IHcW+ITRXCHZg0WorbIhEt3FeAD/HbLmzZiWexeYGlZDqO30mHby64g1J+CCUI8RqmgfToKWuZKVLGBtuWEfGzrwkcPmSvc9AT9z2DyVCL3xlpOzs6M/6YuyAbIhp6rxJcGMlc5X2Zwfv+vuav39yyrekNnKRW4QYAy+f4awYKHHUkFyCjOl3yr+zOyzN6+JfCZ1rvrkfOAiLu7dkSp9pEFTApm8n52PGtevn3g+/QXKr5WOKpspGQhL5nOwVFuzRJi7UfRtOQmJdwkvRkI9pRFu9kuU6sOiAl4BuQIRhylqbT3gvX5vt9UPNvekGTYERxpc0poARe18EcEmX4VB9nvVFceq7Rs+R6MRUe1NI1BjMrQ6J1+y/wAqi20IQ05M8JClmpkIdTeCd1ZdmcuPzdwFZyuNRzUsXn5sJutKR9Vb666XTeN2j/8FwHbWGdXHg2vGp+GsKNFJgpaquHozx9GdD3tekitXjLKUIiNVWEjxik8M+uo5nlt5Z7Vo+7Ke6Asb3wcutcKTyElm+pL7YZ8m5Ov3fwGkjUKdiVAAAA=="
        /></Footer>{/* END_ATS_APPLICATION_FETCH_SUPPORTED_FIELDS */}
      tags:
        - subpackage_applications
      parameters:
        - name: candidate_id
          in: query
          description: If provided, will only return applications 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: credited_to_id
          in: query
          description: If provided, will only return applications credited to this user.
          required: false
          schema:
            type: string
        - name: current_stage_id
          in: query
          description: If provided, will only return applications at this interview stage.
          required: false
          schema:
            type: string
        - 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/ApplicationsGetParametersExpandSchemaItems'
        - 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: job_id
          in: query
          description: If provided, will only return applications for this job.
          required: false
          schema:
            type: string
        - 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: reject_reason_id
          in: query
          description: If provided, will only return applications with this reject reason.
          required: false
          schema:
            type: string
        - name: remote_id
          in: query
          description: The API provider's ID for the given object.
          required: false
          schema:
            type: string
        - name: source
          in: query
          description: If provided, will only return applications with this source.
          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/PaginatedApplicationList'
    post:
      operationId: create
      summary: Create
      description: >-
        Creates an `Application` object with the given values.

        For certain integrations, but not all, our API detects duplicate candidates and will associate applications with
        existing records in the third-party. New candidates are created and automatically linked to the application.


        See our [Help Center article](https://help.merge.dev/en/articles/10012366-updates-to-post-applications-oct-2024)
        for detailed support per integration.

        {/* BEGIN_ATS_APPLICATION_CREATE_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget
        requestType="POST"
        data="H4sIAAAAAAAAA+WZbVPiOhTHvwqTlw4Pq+jdlZk7d3hahJWigst6HSeTpocSSJOapCDs7HffaQsqdxHdMaD33nc0Tf4pv/xPck77HVFiwJdqhkqIGI2yKJAecFRC5TDkjBLDpEBZRELmkADSXnhygLJIR2EolQHvMwPu6RMFA1RChQCUD7lIsAEDr0CMLjBhwFeJki7cj8oNkmEoizgTY/DKlMpImA06ab8cSTv+4zK+rQ3KopBobYZKRv7wAm4j0Jsk46fhEIAwhOc8Ykjh0fCcSseva4uf2wMOBrwaMaQGBmj8BxdTDY0JdalQGAIP88m0eQ8mBRAFogyjHHThqHh88PH4KLdQSWb/C/v8z/290a0r3Y972Kcck2iv3aN3Tq85dUb+oVM9vHPml0fOfDx3RuMPe9gne+1e+6jTuyp2auX9zpoOuPvHt+OvlVql5ezReb3ojK6mTo/ut3t07M6bxVaDTlsn53fO/OqgXbssOr36Uash9zvVC92uXsh2OZ9HWfR4HVHp+vvjhoU5ynrozla7NgPiwyMk6SKQkOXCyOWM5nUxTwIyl4JMdZ7KoBCAx0ghkcLd24gowKfSl7gYnffJZJoPhb+kz6S4R49KqO6clJ1qvbZqg/KEME5cDqhkVAS/OBeVrhGJ3Q4eJrGFKBEe84iB+LcCjxnwsJHxVaQUCIO1if9UFo2ki7JIQSANYObFUUEVgGDCx4lPmBSYCD0FFTtGy0hRQDfxkNuIKfDOiCIBmPh26Xpl4lj65kd2PeVZ4HJbmGOtJeeJO24MBnq3iNdAfIbTJjYTYiIFduCccWIGUgUL0a1g2UTitUapkMCV8uTCDo2l2uOgzI/CXQbj8+H34gh7ClnE+VAqYclASoagzAzvNx/E8H3rQQMEKEYfWooLtvcNh8sH2rr5bMJdr/YM8swFUBUxEx/HmSqXkWdnEdyFPlYP+pjG+lintLuVWtgcT/67iKtc0vFUqrEdovdyW98Ktrk7VmUAYOwQWVgXN6kUuCP4bMdZyjPGehGqRxhwGPfSaxvzIVFGgML3Y5MZnmKsBChtpIBMj3AQ5pQJWy580H67I+m3Q/gpUAr4L8vw2rxlIbrY5t7ekq+N2HrIpaXyIpHaJpht7lyNuMYYykhb8suD3gsDySn3ml/rOy+zRkANVkB08k4ivV6qWaofTohyZaQy5V7XbiwuhJcph3fVqPb/bv/rrMeqzbZlMs1YclehaDcF2wCqReZzW5VXqrXyMqR/Ttu1trfj+usdvgxpSbfseaDsenIkXRKr7syWK2S3UNe2pDthtvKLhdjKYbHrjez3DPTS3DbVxGYWPmO7U5jY8lwitRLc8sr/NKv0/xfB/QTfjiKUpzWDtIM5kdppwfrqs+YJNt3yWaYbUQpafybUyIS4BUKrmiuOrNBv0v/84T0ge43tNgR0NyDKLMp4sEZ0VXQF6ejT5HRQ7799VbbLsI6DEOZ2z+pU8z1+FnpxvbIlT/eABIYwLi2dVA967+8bwFuzvvzSyJwpuXyJzRI3WmB++aWxrBkPKrfeXYe9+dc5W1n9mvyLLB81Xl9l8PP5f1+qsUdmdreUfir6HqpRW7DXfy24+fETMUBJ3wMiAAA="
        /></Footer>{/* END_ATS_APPLICATION_CREATE_SUPPORTED_FIELDS */}
      tags:
        - subpackage_applications
      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/ApplicationResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationEndpointRequest'
  /ats/v1/applications/{id}:
    get:
      operationId: retrieve
      summary: Retrieve
      description: >-
        Returns an `Application` object with the given `id`.{/* BEGIN_ATS_APPLICATION_FETCH_SUPPORTED_FIELDS
        */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET"
        data="H4sIAAAAAAAAA+1caXPaOBj+K4w/ZjiakPTIzM4OVzgaTAokabrT8cjyixHYkiPLEOj0v+/IR4J3k7YQmUCbTxkb+bH96HlPyfmmYSTAZnyhnWpI+Fpec5kFjnaqVTzPIRgJwqiW15BHdORCNMqYHWl5zQ88j3EB1hkBx/JbHEbaqVZygdtQCCgZEbBKSPglQgXYPETyS/dXFUbhZVpecwidglXBmAVU/AAnGldA0cD/HMqffaHlNQ/5vhhzFtjjPtwG4P8IUj6NAy5QgZyChQQqrVxe4NH1j52Tz22BAwKsOhKoDgKwfMH4VmMhPP+0VBqD4xXD2xYtmJWAlhAXBDvgl07KH47efTgpxCjh3f82bOevw4PJrcnMdweGjR0DBQfdIb7Th+25PrGP9drxnb68PNGX06U+mb45MGx00B12T3rDm3KvXjnsPTLAGLz9/OGqWq929AO8bJT1yc1cH+LD7hBPzWW73Gnieaf16U5f3hx165dlfdg46TTZYa/W97u1PutWikUtr63Oo3b6z7fVE7E4YtFQMRAIT9PXtF1kwwo30WwgjxS8wHQILvrlInLRklE094uYuSUXLIJKaUxjcBsgDsY5s5kxr7ZurvrnxYlnJ/NBGL2fDO1Ua+itil5r1NPCqMwQcZDpgHYqeAD/07J2+o+GEbWIhQRoeQ1zsIgAyxBMHgWcAxWGL+QL5bUJM7W8xmECWBgckB9aDAeXCTDktKaPDA+JsbQfFnAM2lf5421AOFgXiCMXBHD5AF+/5x9l2B+bC0XESqgUn+Xg0zWazYseVc/nAHMASqj9SdoPYbRC/TnwIgr/aPmnB6Qc0VOjQqv88ZD0jPzCqGSmnhoaUHIbgEEsoEL6FPkWK09ryDniMwJzP/kBLANJJ5US16NyYqOR1MFjupLHCdBPVRafIpZUXPIeRsKWEbHvP0OOC9d0VOlRYiWCnJnT5mjkZ6LFp+ciC0NPTcFmLM+QCDioofnCQWLEuBuDZkLwz/W9BmtrklVFrslYq6+GrQRt1U9mEm9+Q/+4Kvw13d9L+7UqB1gqirMR1quAnhbQatD0MeOAEQ9Lg2c66p9lYBnoJnCcMeNUkavmzAMuFsZh+wHMuD971AQKnOCHM+XYS92fOE4eaMtxVIFRP4v/XB8wD4iQpV2u5rDAUjMjZoxv8Ad8A0t8w4+oH1TrXns62/2wuinFtcpwoIZMiZSqPzrH+vSWNTKJr9lpdV3+HLRQlZ0kuVyEmUjwTWtOT+rnLyLBtclgeDpnXFGv4B4u82j7pJwylw9zAYQaumInabQxo0aPOos/JErUGKfAfcEo5IbIASrOCVUlwQfslxPhyzHLwYkeQaV3i0Bj97ZnGl2TQKt4RSgmagmszySm8baHbrA92v3UZE3OGtRGNihLS+7h/gjBNTyHKSp0Q6j9JG1Tf3fmIIHHXK25xqDG1K3Vxu3bXbXXDRmTq3WIKKqQE7RUqM1Megr6+hmx2gRXrQab4Bp3syv88fBk91rwmSyObMa77CCNWeArSnke8H4xedQrw/ZVQ7WelffidmfGWoibLOA5ZelCYjExcFKEWzfN2vWX7q46743zhRZzgQeK3Pc4Atuuh8mcob7KjmOrb4Roe1ZMrskZqbW7iu2xLSGzzEbXWsTP3K+16YhQIiBX5cj3+yR8YQV0JriJX2Ps7SXulPcgv1+TwA5aLlX1ZSOsVG/7+hPu1rvW69rxI0t/+7Mu3GFmxbLC9XiFrmrCTCRRX6Z2VrGU+nz/1WFmncyQWmJj0F0kVFEavD7LA5nUK3JzMVphL3s+61M3I6pa2zHYdtoWG+063ILBq2oCPVg7oUmasrAOGyj4mHnitzX/eA4zVWEnhEolJ+zGfr+oXu95cvI79DTUpyw9jAOPeWqkE4Ptp8PfmEHqLEYLtb4qxCS/V+OjxxF2IHcW+ITRXCHZg0WorbIhEt3FeAD/HbLmzZiWexeYGlZDqO30mHby64g1J+CCUI8RqmgfToKWuZKVLGBtuWEfGzrwkcPmSvc9AT9z2DyVCL3xlpOzs6M/6YuyAbIhp6rxJcGMlc5X2Zwfv+vuav39yyrekNnKRW4QYAy+f4awYKHHUkFyCjOl3yr+zOyzN6+JfCZ1rvrkfOAiLu7dkSp9pEFTApm8n52PGtevn3g+/QXKr5WOKpspGQhL5nOwVFuzRJi7UfRtOQmJdwkvRkI9pRFu9kuU6sOiAl4BuQIRhylqbT3gvX5vt9UPNvekGTYERxpc0poARe18EcEmX4VB9nvVFceq7Rs+R6MRUe1NI1BjMrQ6J1+y/wAqi20IQ05M8JClmpkIdTeCd1ZdmcuPzdwFZyuNRzUsXn5sJutKR9Vb666XTeN2j/8FwHbWGdXHg2vGp+GsKNFJgpaquHozx9GdD3tekitXjLKUIiNVWEjxik8M+uo5nlt5Z7Vo+7Ke6Asb3wcutcKTyElm+pL7YZ8m5Ov3fwGkjUKdiVAAAA=="
        /></Footer>{/* END_ATS_APPLICATION_FETCH_SUPPORTED_FIELDS */}
      tags:
        - subpackage_applications
      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/ApplicationsIdGetParametersExpandSchemaItems'
        - 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/Application'
  /ats/v1/applications/{id}/change-stage:
    post:
      operationId: change-stage-create
      summary: Change Stage Create
      description: >-
        Updates the `current_stage` field of an `Application` object{/* BEGIN_ATS_APPLICATION_CREATE_SUPPORTED_FIELDS
        */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="POST"
        data="H4sIAAAAAAAAA+WZbVPiOhTHvwqTlw4Pq+jdlZk7d3hahJWigst6HSeTpocSSJOapCDs7HffaQsqdxHdMaD33nc0Tf4pv/xPck77HVFiwJdqhkqIGI2yKJAecFRC5TDkjBLDpEBZRELmkADSXnhygLJIR2EolQHvMwPu6RMFA1RChQCUD7lIsAEDr0CMLjBhwFeJki7cj8oNkmEoizgTY/DKlMpImA06ab8cSTv+4zK+rQ3KopBobYZKRv7wAm4j0Jsk46fhEIAwhOc8Ykjh0fCcSseva4uf2wMOBrwaMaQGBmj8BxdTDY0JdalQGAIP88m0eQ8mBRAFogyjHHThqHh88PH4KLdQSWb/C/v8z/290a0r3Y972Kcck2iv3aN3Tq85dUb+oVM9vHPml0fOfDx3RuMPe9gne+1e+6jTuyp2auX9zpoOuPvHt+OvlVql5ezReb3ojK6mTo/ut3t07M6bxVaDTlsn53fO/OqgXbssOr36Uash9zvVC92uXsh2OZ9HWfR4HVHp+vvjhoU5ynrozla7NgPiwyMk6SKQkOXCyOWM5nUxTwIyl4JMdZ7KoBCAx0ghkcLd24gowKfSl7gYnffJZJoPhb+kz6S4R49KqO6clJ1qvbZqg/KEME5cDqhkVAS/OBeVrhGJ3Q4eJrGFKBEe84iB+LcCjxnwsJHxVaQUCIO1if9UFo2ki7JIQSANYObFUUEVgGDCx4lPmBSYCD0FFTtGy0hRQDfxkNuIKfDOiCIBmPh26Xpl4lj65kd2PeVZ4HJbmGOtJeeJO24MBnq3iNdAfIbTJjYTYiIFduCccWIGUgUL0a1g2UTitUapkMCV8uTCDo2l2uOgzI/CXQbj8+H34gh7ClnE+VAqYclASoagzAzvNx/E8H3rQQMEKEYfWooLtvcNh8sH2rr5bMJdr/YM8swFUBUxEx/HmSqXkWdnEdyFPlYP+pjG+lintLuVWtgcT/67iKtc0vFUqrEdovdyW98Ktrk7VmUAYOwQWVgXN6kUuCP4bMdZyjPGehGqRxhwGPfSaxvzIVFGgML3Y5MZnmKsBChtpIBMj3AQ5pQJWy580H67I+m3Q/gpUAr4L8vw2rxlIbr

# --- truncated at 32 KB (392 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/openapi/merge-ats-api-openapi.yaml