Merge subpackage_users API

openapi: 3.1.0
info:
  title: Accounting subpackage_users 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_users
paths:
  /ats/v1/users:
    get:
      operationId: list
      summary: List
      description: Returns a list of `RemoteUser` objects.{/* BEGIN_ATS_REMOTEUSER_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+1ba3OiSBT9KxYfUz6SGHcmVm1t+YiviZpRk0xmaoq6wgVbG5o0jUan5r9vIaghk82MSYOa2m+RwAHOuX0fB/ihaCDQZHyuFBUQrpJWLKYjVYpKDy0m8NpFrqQVcEgHLAx2UqenSlpxPcdhXKBeI0h1t8HRUIpKzkJuYsaziUFQz4Fwc8QWaHIQhNlubn1UxlgepqQVSuwJ6iVNY54tXsAJ9stAsOOTn/6/XaGkFQdcV4w488xRD+89dF+C9K+GooW2AJrRQUDu0eEZHhz/3Db/unWkKFCvgoAqCtT8GwxPNRLCcYu53Aipk12eNqvjNId2DrggGkU3V8ifn344L2RClOXZ/1FN+vfJ0fh+yIYfjlRToyp4R+2B9tAZNGedsXnWqZw9dBbXhc5isuiMJ8dHqglH7UG70B3c5bvV0kn3mR3U/l9fzm/K1XKrc6QtLvKd8d2sM9BO2gNtMlw08626Nms1Pj90Fnen7ep1vjO4KLTq7KRb6bntSo+1S9msklYe66gUv/14vCEMjpLjUKKBLfoCtEn0mKYFJj7iJlADHJJxvCElWtbNZ8GCBbNh5mY1ZuUs1Ankophq/94DjuolM5k6KzfubnqX2bFjrvQgzF6LoRSVi06j1KlcVKOBUZoCoTCkqBQF9/CXWFaK3xTQBJkSQdCXGoJrCG49rRiEu0K1/XtOKxQ2f/PlmlF9LaO/VAfESPnub7v3CEf9CjhYKJD7J/v+M/0sm+5oOJdEog8V4S7vfb6F6Szr2DFzpxPX311X0gpaQOhT/kaEE9tULbDBRK4ajKtjNnR/YVbjHhHRHX5D93oT8U/uuchVn0o+JThztxdjbg2pLDV8rJUc0+GkbhhuTEpo6LoqZ9Qn8aWYfpM2S5Y1jiBQV0FsJ822QkxBeBzlKHFFQRiMWyFoLBrIifYtWSqDNWSs0ZND0wrtcQaJJes+G4VbZNg3xFWZIy4kpdsAK3a2nizh12fadVpErroa46gB13e7zMsepSPGbUnrnDMHuZirJ80NmLreelpHGznRNlvyoXbrDWerC4olR+wy7sP7SvWCpON3w6kKZZ4uh/phiK/yDb6q+fiqG3DcL1ed5mQafyvyByy/rcvYkvpKadCXQ7KPFGnvWmedyT27iL813mFPty3bFOayCuKqbwgwV4F83JjZherlTjPEa3hh2mTGuKR5bQ0Xf/mLNLe/q35/GnkJ1bcK4zZyVzAbUwOgaItLYsuSYIO9Dx1bsqucIwUheTwIQcN1vtP1nVB46tkbYmtELo3VqY+p/tWFO8003lsjVaMgtBGXS1kIqk6sSmXUvN+LHinJOKz55i4QSWPACi2SFfeB0h2bWzWO7kggWJJoXsGFPMdC8Xb1PsmYraMlNwnU0VIfpjfap5NCPNEqy0fYsx6rzhHtEfNcSe3ABi/h3vYl4zZm14dxE2yyiKaXeNR9cxpr9GQaF42eukSLXev9zWSk0mz35eaypg+ZeCO9l4ZECxYLWYZEgBWxgG4/a+1qW086PR12yWixYUnXl+88SAz6MRuCjxpn3D+RROLTvX0QpUqmIFeTEDR5LfY33bfYsO/3AZJSUoiWSS7oXzPIxsPjlMjyoEKw2EfWA6qbTJYfsMkFxF6Z+HP95AK8T7Fy/N+0vobKLem7xKms+raEijQd7M78OC/fvvOZyDB8hg9rOGqDDQKo3IUTgr43K7dr07kxl0vVEpMkUAV3yRsHjWKq5rmE2anM6pUCYpsyB/PgLOoGPNa2+p16Y6FU/qNHJkeWJVTCxtgbNDjIJH5FbIcRW0hKTSHaAdoxCa2SMMcgNyibySF9DVmjbBbpnY6dxbhWO03iVcHDafb7YGJKlkvmg6mPbLL8cHb2oX1IdSM2mktXqb63zK010ARbZkYZjEcwI+Fe1r4ws3ac9KiQ1Gyw84e6fQu4WGcbWXpGQSOCjj9OL42L2wRa3P175pWIon6HhQu5Y0mAuQea7c72DF+/mxtCPrUB7p4Y/smUkuC2e4iGvLkiwPvfA92QjGAJIJRJcvI2eLt8tUHGOBdjYCP1I3HlaqAkg18EsKvvIzDW10zfND4fdvHkYBhEdooPQNXxQG8Vvl7upozGGPGcDNEBXTZpAeoef20ZJ6nXn+qpK84emaNy6L3+VF89wzot3+sP3bjMZukJe+c2zy3jk+VtSxFihRYZjrpTSjv0/IAqasLLwmdNB8kPXULQJByeZ5ne5sPaRKrgVzZaZx5FKtU+8qqHibODifD7Uoy+GILff/4L3pWgH/tGAAA=" /></Footer>{/* END_ATS_REMOTEUSER_FETCH_SUPPORTED_FIELDS */}
      tags:
      - subpackage_users
      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: email
        in: query
        description: If provided, will only return remote users with the given email address
        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_fields
        in: query
        description: Deprecated. Use show_enum_origins.
        required: false
        schema:
          $ref: '#/components/schemas/UsersGetParametersRemoteFields'
      - 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/UsersGetParametersShowEnumOrigins'
      - 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/PaginatedRemoteUserList'
  /ats/v1/users/{id}:
    get:
      operationId: retrieve
      summary: Retrieve
      description: Returns a `RemoteUser` object with the given `id`.{/* BEGIN_ATS_REMOTEUSER_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+1ba3OiSBT9KxYfUz6SGHcmVm1t+YiviZpRk0xmaoq6wgVbG5o0jUan5r9vIaghk82MSYOa2m+RwAHOuX0fB/ihaCDQZHyuFBUQrpJWLKYjVYpKDy0m8NpFrqQVcEgHLAx2UqenSlpxPcdhXKBeI0h1t8HRUIpKzkJuYsaziUFQz4Fwc8QWaHIQhNlubn1UxlgepqQVSuwJ6iVNY54tXsAJ9stAsOOTn/6/XaGkFQdcV4w488xRD+89dF+C9K+GooW2AJrRQUDu0eEZHhz/3Db/unWkKFCvgoAqCtT8GwxPNRLCcYu53Aipk12eNqvjNId2DrggGkU3V8ifn344L2RClOXZ/1FN+vfJ0fh+yIYfjlRToyp4R+2B9tAZNGedsXnWqZw9dBbXhc5isuiMJ8dHqglH7UG70B3c5bvV0kn3mR3U/l9fzm/K1XKrc6QtLvKd8d2sM9BO2gNtMlw08626Nms1Pj90Fnen7ep1vjO4KLTq7KRb6bntSo+1S9msklYe66gUv/14vCEMjpLjUKKBLfoCtEn0mKYFJj7iJlADHJJxvCElWtbNZ8GCBbNh5mY1ZuUs1Ankophq/94DjuolM5k6KzfubnqX2bFjrvQgzF6LoRSVi06j1KlcVKOBUZoCoTCkqBQF9/CXWFaK3xTQBJkSQdCXGoJrCG49rRiEu0K1/XtOKxQ2f/PlmlF9LaO/VAfESPnub7v3CEf9CjhYKJD7J/v+M/0sm+5oOJdEog8V4S7vfb6F6Szr2DFzpxPX311X0gpaQOhT/kaEE9tULbDBRK4ajKtjNnR/YVbjHhHRHX5D93oT8U/uuchVn0o+JThztxdjbg2pLDV8rJUc0+GkbhhuTEpo6LoqZ9Qn8aWYfpM2S5Y1jiBQV0FsJ822QkxBeBzlKHFFQRiMWyFoLBrIifYtWSqDNWSs0ZND0wrtcQaJJes+G4VbZNg3xFWZIy4kpdsAK3a2nizh12fadVpErroa46gB13e7zMsepSPGbUnrnDMHuZirJ80NmLreelpHGznRNlvyoXbrDWerC4olR+wy7sP7SvWCpON3w6kKZZ4uh/phiK/yDb6q+fiqG3DcL1ed5mQafyvyByy/rcvYkvpKadCXQ7KPFGnvWmedyT27iL813mFPty3bFOayCuKqbwgwV4F83JjZherlTjPEa3hh2mTGuKR5bQ0Xf/mLNLe/q35/GnkJ1bcK4zZyVzAbUwOgaItLYsuSYIO9Dx1bsqucIwUheTwIQcN1vtP1nVB46tkbYmtELo3VqY+p/tWFO8003lsjVaMgtBGXS1kIqk6sSmXUvN+LHinJOKz55i4QSWPACi2SFfeB0h2bWzWO7kggWJJoXsGFPMdC8Xb1PsmYraMlNwnU0VIfpjfap5NCPNEqy0fYsx6rzhHtEfNcSe3ABi/h3vYl4zZm14dxE2yyiKaXeNR9cxpr9GQaF42eukSLXev9zWSk0mz35eaypg+ZeCO9l4ZECxYLWYZEgBWxgG4/a+1qW086PR12yWixYUnXl+88SAz6MRuCjxpn3D+RROLTvX0QpUqmIFeTEDR5LfY33bfYsO/3AZJSUoiWSS7oXzPIxsPjlMjyoEKw2EfWA6qbTJYfsMkFxF6Z+HP95AK8T7Fy/N+0vobKLem7xKms+raEijQd7M78OC/fvvOZyDB8hg9rOGqDDQKo3IUTgr43K7dr07kxl0vVEpMkUAV3yRsHjWKq5rmE2anM6pUCYpsyB/PgLOoGPNa2+p16Y6FU/qNHJkeWJVTCxtgbNDjIJH5FbIcRW0hKTSHaAdoxCa2SMMcgNyibySF9DVmjbBbpnY6dxbhWO03iVcHDafb7YGJKlkvmg6mPbLL8cHb2oX1IdSM2mktXqb63zK010ARbZkYZjEcwI+Fe1r4ws3ac9KiQ1Gyw84e6fQu4WGcbWXpGQSOCjj9OL42L2wRa3P175pWIon6HhQu5Y0mAuQea7c72DF+/mxtCPrUB7p4Y/smUkuC2e4iGvLkiwPvfA92QjGAJIJRJcvI2eLt8tUHGOBdjYCP1I3HlaqAkg18EsKvvIzDW10zfND4fdvHkYBhEdooPQNXxQG8Vvl7upozGGPGcDNEBXTZpAeoef20ZJ6nXn+qpK84emaNy6L3+VF89wzot3+sP3bjMZukJe+c2zy3jk+VtSxFihRYZjrpTSjv0/IAqasLLwmdNB8kPXULQJByeZ5ne5sPaRKrgVzZaZx5FKtU+8qqHibODifD7Uoy+GILff/4L3pWgH/tGAAA=" /></Footer>{/* END_ATS_REMOTEUSER_FETCH_SUPPORTED_FIELDS */}
      tags:
      - subpackage_users
      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: remote_fields
        in: query
        description: Deprecated. Use show_enum_origins.
        required: false
        schema:
          $ref: '#/components/schemas/UsersIdGetParametersRemoteFields'
      - 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/UsersIdGetParametersShowEnumOrigins'
      - 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/RemoteUser'
  /users:
    get:
      operationId: list
      summary: List
      description: Returns a list of `User` objects.{/* BEGIN_CHAT_USER_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA31T70/bMBD9VyZ/rPJjpXSISNNU2g6oFJdBOg1VKLrY19StHae2QyGI/31KWqBsiI/37t27O7/zE2HgMNfmkUSELcERjyjNUZKIzCwa4hEoBQWF+3x6f0Q8Yquy1MYh/ylQcnthcEEiEio0OfpVIRYCedjQQ1E4zA04oQsbvpb5i7aOeESKYo18wJiuCveZ0I7ow475T2hDKWwzewnWuqXRVb68xk2F9lPNZh6JCgsH0ufgIDyo981O4COsmZyjRId8BA5G6JA1K+57LZ0rbRSGS5Rl0PYNON6HWIRgnGASbdjvnR6dnPb9vUrb/Ueay+/dzmqT6eykk+ZMplB14oQ90ORyS1f5MR0eP9B61qf1uqar9ddOmkMnTuL+NLntTUeD7vQDQnrz7c/p77PR2YR2WD3u0dXtliasGydsndWXvck5204ufj3Q+vYoHs16NBn3J+e6Ox1e23h4reNBEBCPHDpJovnTIbA/kFgwo61euC8Jgmoe6YBzqSDHg8fZ+QGl8Msqk4IFtheAgloXsLUB0ypUyAWEr6JpK5rebCowGJRF/mKC0MWrAyQiY3oxoMPx6P05DO5BSMgkksiZCv+7YRLNCRe2lPCYFs06HlkIY91LkBtdle1KNs10c2sS3rIKVYamSRtU2mHKDIJDnrY/ao81Hr+P0hLc8g0SnHiksmha1bsG31TCIL8CAwpd0yGa3z3fPf8Fvm5f1bgDAAA=" /></Footer>{/* END_CHAT_USER_FETCH_SUPPORTED_FIELDS */}
      tags:
      - subpackage_users
      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/UsersGetParametersExpandSchemaItems'
      - 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/PaginatedUserList'
  /users/{id}:
    get:
      operationId: retrieve
      summary: Retrieve
      description: Returns a `User` object with the given `id`.{/* BEGIN_CHAT_USER_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA31T70/bMBD9VyZ/rPJjpXSISNNU2g6oFJdBOg1VKLrY19StHae2QyGI/31KWqBsiI/37t27O7/zE2HgMNfmkUSELcERjyjNUZKIzCwa4hEoBQWF+3x6f0Q8Yquy1MYh/ylQcnthcEEiEio0OfpVIRYCedjQQ1E4zA04oQsbvpb5i7aOeESKYo18wJiuCveZ0I7ow475T2hDKWwzewnWuqXRVb68xk2F9lPNZh6JCgsH0ufgIDyo981O4COsmZyjRId8BA5G6JA1K+57LZ0rbRSGS5Rl0PYNON6HWIRgnGASbdjvnR6dnPb9vUrb/Ueay+/dzmqT6eykk+ZMplB14oQ90ORyS1f5MR0eP9B61qf1uqar9ddOmkMnTuL+NLntTUeD7vQDQnrz7c/p77PR2YR2WD3u0dXtliasGydsndWXvck5204ufj3Q+vYoHs16NBn3J+e6Ox1e23h4reNBEBCPHDpJovnTIbA/kFgwo61euC8Jgmoe6YBzqSDHg8fZ+QGl8Msqk4IFtheAgloXsLUB0ypUyAWEr6JpK5rebCowGJRF/mKC0MWrAyQiY3oxoMPx6P05DO5BSMgkksiZCv+7YRLNCRe2lPCYFs06HlkIY91LkBtdle1KNs10c2sS3rIKVYamSRtU2mHKDIJDnrY/ao81Hr+P0hLc8g0SnHiksmha1bsG31TCIL8CAwpd0yGa3z3fPf8Fvm5f1bgDAAA=" /></Footer>{/* END_CHAT_USER_FETCH_SUPPORTED_FIELDS */}
      tags:
      - subpackage_users
      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/UsersIdGetParametersExpandSchemaItems'
      - 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/User'
  /crm/v1/users:
    get:
      operationId: list
      summary: List
      description: Returns a list of `User` objects.{/* BEGIN_CRM_USER_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+2Yb3PiNhDGvwqjl4zBTThyF2Y6HQ7oQTp2UnDS5m4ynkVejECWHEmGhJv77h2bPyFpJm0ag2l7rxgJ6bH47cPuWl8JBYOhVPekQaiKiEUiGSAnDXKpURGLQMxciHD5tT87JhbRSRxLZTD4mSEPdFfhiDSIHaEKsZIINmIY2FRFNhMGQwWGSaHtza7KKNtGLMKZmGLQpFQmwrygs1xXgeXCJ0Ntc6YNsUgMWpuxkkk47uNtgvolyfQ0HCMUBnglAAP21vaKWu5/bi49d4AcDQZtMNBGgzT9gatHjY2JdcO2x8jjavbYaoAzG4UNyjDKUdv12unx+9N6ZaWSPf0nP+Q/HpUnt0M5fF/2Q8p9SMqOR+9crzd3J+E7t/Xuzl1c1t3FdOFOpj+U/RDKjufUz73r2nm7eXT+zAJ/cPL76dXH9sczt0wXnZo7uZ67Hj1yPDodLnq1s090ftb99c5dXB877cua63XqZ5/k0Xmrr51WXzrNapVYZDuOpPHl6/bEyhxNSpHLx2t7EYS4xWQZBYhZJU6GnNGqrlUhgoUUMNdVKiM7woCBfcHBjKSKINP09W0CCquxCNfomRQb7qRBOm636bY67cceaM6AcRhyJA2jEvyTbUnjC1lbiFgEI2A8/RQhhJkx0lmmfaCGzTB1K0LmWpH+YosIaTAdykw1EcywbKwwkgb9NKqPR34MZvwwxQJiEQN6qslNOnmbMIXBBSiI0KBKz3fzzXqedXqiFkQxsFDkw/yx5pr5JC6A+YrvG7i+kmcLYp1wzNe8K9HibVu4XVtc6rzhppI7ceeLliyQoYzjrBznCTHTLPQ/XhzQbjIcxNLkQ7SbDHUszV9nTbfp9a46b+JJpTBAiylZm8btzfh7QrNwbPh9PgHYyH1vFp6S/gUhzjdvTBHiXXJe2/qFIrb7/OAwqqSWI1Nq3wuIGNWl2km9NACeHSBHnGv92kk9U9+ThYvMI1thsUiiUfmJ4q+NkJsYPUbO84nGWu1g+rX9l8QLFmOglofI0d8b2V13GgdaGf+5w1NynInc+r613J6L5G4TySuZZil2xEHl7PIH3WIa6oPIIEsIUtGdwE11/8tVMb/uepCEoFp9J98o6FQ1vQT+fiH3hLeHEKVmyCtTP+j9j9uRFMJcqmkpdyOvlf1W3yn0pvMgb5evDAvzvmqaZZr7eGn824D313J8RhGgnpYGub2srLGulP0Pc3Pseb8VnywOxsSf5VjmnzgWciz3VwDpv+gN/ebbH/V0NbtKHgAA" /></Footer>{/* END_CRM_USER_FETCH_SUPPORTED_FIELDS */}
      tags:
      - subpackage_users
      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: email
        in: query
        description: If provided, will only return users with this email.
        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_remote_fields
        in: query
        description: Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
        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/PaginatedUserList'
  /crm/v1/users/{id}:
    get:
      operationId: retrieve
      summary: Retrieve
      description: Returns a `User` object with the given `id`.{/* BEGIN_CRM_USER_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+2Yb3PiNhDGvwqjl4zBTThyF2Y6HQ7oQTp2UnDS5m4ynkVejECWHEmGhJv77h2bPyFpJm0ag2l7rxgJ6bH47cPuWl8JBYOhVPekQaiKiEUiGSAnDXKpURGLQMxciHD5tT87JhbRSRxLZTD4mSEPdFfhiDSIHaEKsZIINmIY2FRFNhMGQwWGSaHtza7KKNtGLMKZmGLQpFQmwrygs1xXgeXCJ0Ntc6YNsUgMWpuxkkk47uNtgvolyfQ0HCMUBnglAAP21vaKWu5/bi49d4AcDQZtMNBGgzT9gatHjY2JdcO2x8jjavbYaoAzG4UNyjDKUdv12unx+9N6ZaWSPf0nP+Q/HpUnt0M5fF/2Q8p9SMqOR+9crzd3J+E7t/Xuzl1c1t3FdOFOpj+U/RDKjufUz73r2nm7eXT+zAJ/cPL76dXH9sczt0wXnZo7uZ67Hj1yPDodLnq1s090ftb99c5dXB877cua63XqZ5/k0Xmrr51WXzrNapVYZDuOpPHl6/bEyhxNSpHLx2t7EYS4xWQZBYhZJU6GnNGqrlUhgoUUMNdVKiM7woCBfcHBjKSKINP09W0CCquxCNfomRQb7qRBOm636bY67cceaM6AcRhyJA2jEvyTbUnjC1lbiFgEI2A8/RQhhJkx0lmmfaCGzTB1K0LmWpH+YosIaTAdykw1EcywbKwwkgb9NKqPR34MZvwwxQJiEQN6qslNOnmbMIXBBSiI0KBKz3fzzXqedXqiFkQxsFDkw/yx5pr5JC6A+YrvG7i+kmcLYp1wzNe8K9HibVu4XVtc6rzhppI7ceeLliyQoYzjrBznCTHTLPQ/XhzQbjIcxNLkQ7SbDHUszV9nTbfp9a46b+JJpTBAiylZm8btzfh7QrNwbPh9PgHYyH1vFp6S/gUhzjdvTBHiXXJe2/qFIrb7/OAwqqSWI1Nq3wuIGNWl2km9NACeHSBHnGv92kk9U9+ThYvMI1thsUiiUfmJ4q+NkJsYPUbO84nGWu1g+rX9l8QLFmOglofI0d8b2V13GgdaGf+5w1NynInc+r613J6L5G4TySuZZil2xEHl7PIH3WIa6oPIIEsIUtGdwE11/8tVMb/uepCEoFp9J98o6FQ1vQT+fiH3hLeHEKVmyCtTP+j9j9uRFMJcqmkpdyOvlf1W3yn0pvMgb5evDAvzvmqaZZr7eGn824D313J8RhGgnpYGub2srLGulP0Pc3Pseb8VnywOxsSf5VjmnzgWciz3VwDpv+gN/ebbH/V0NbtKHgAA" /></Footer>{/* END_CRM_USER_FETCH_SUPPORTED_FIELDS */}
      tags:
      - subpackage_users
      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_remote_fields
        in: query
        description: Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
        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/User_2'
  /crm/v1/users/ignore/{model_id}:
    post:
      operationId: ignore-create
      summary: Ignore Create
      description: Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.{/* BEGIN_CRM_USER_CREATE_SUPPORTED_FIELDS */}{/* END_CRM_USER_CREATE_SUPPORTED_FIELDS */}
      tags:
      - subpackage_users
      parameters:
      - name: model_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - 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: No response body
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/users_ignoreCreate_Response_200'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IgnoreCommonModelRequest'
  /crm/v1/users/remote-field-classes:
    get:
      operationId: remote-field-classes-list
      summary: Remote Field Classes List
      description: Returns a list of `RemoteFieldClass` objects.{/* BEGIN_CRM_USER_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+2Yb3PiNhDGvwqjl4zBTThyF2Y6HQ7oQTp2UnDS5m4ynkVejECWHEmGhJv77h2bPyFpJm0ag2l7rxgJ6bH47cPuWl8JBYOhVPekQaiKiEUiGSAnDXKpURGLQMxciHD5tT87JhbRSRxLZTD4mSEPdFfhiDSIHaEKsZIINmIY2FRFNhMGQwWGSaHtza7KKNtGLMKZmGLQpFQmwrygs1xXgeXCJ0Ntc6YNsUgMWpuxkkk47uNtgvolyfQ0HCMUBnglAAP21vaKWu5/bi49d4AcDQZtMNBGgzT9gatHjY2JdcO2x8jjavbYaoAzG4UNyjDKUdv12unx+9N6ZaWSPf0nP+Q/HpUnt0M5fF/2Q8p9SMqOR+9crzd3J+E7t/Xuzl1c1t3FdOFOpj+U/RDKjufUz73r2nm7eXT+zAJ/cPL76dXH9sczt0wXnZo7uZ67Hj1yPDodLnq1s090ftb99c5dXB877cua63XqZ5/k0Xmrr51WXzrNapVYZDuOpPHl6/bEyhxNSpHLx2t7EYS4xWQZBYhZJU6GnNGqrlUhgoUUMNdVKiM7woCBfcHBjKSKINP09W0CCquxCNfomRQb7qRBOm636bY67cceaM6AcRhyJA2jEvyTbUnjC1lbiFgEI2A8/RQhhJkx0lmmfaCGzTB1K0LmWpH+YosIaTAdykw1EcywbKwwkgb9NKqPR34MZvwwxQJiEQN6qslNOnmbMIXBBSiI0KBKz3fzzXqedXqiFkQxsFDkw/yx5pr5JC6A+YrvG7i+kmcLYp1wzNe8K9HibVu4XVtc6rzhppI7ceeLliyQoYzjrBznCTHTLPQ/XhzQbjIcxNLkQ7SbDHUszV9nTbfp9a46b+JJpTBAiylZm8btzfh7QrNwbPh9PgHYyH1vFp6S/gUhzjdvTBHiXXJe2/qFIrb7/OAwqqSWI1Nq3wuIGNWl2km9NACeHSBHnGv92kk9U9+ThYvMI1thsUiiUfmJ4q+NkJsYPUbO84nGWu1g+rX9l8QLFmOglofI0d8b2V13GgdaGf+5w1NynInc+r613J6L5G4TySuZZil2xEHl7PIH3WIa6oPIIEsIUtGdwE11/8tVMb/uepCEoFp9J98o6FQ1vQT+fiH3hLeHEKVmyCtTP+j9j9uRFMJcqmkpdyOvlf1W3yn0pvMgb5evDAvzvmqaZZr7eGn824D313J8RhGgnpYGub2srLGulP0Pc3Pseb8VnywOxsSf5VjmnzgWciz3VwDpv+gN/ebbH/V0NbtKHgAA" /></Footer>{/* END_CRM_USER_FETCH_SUPPORTED_FIELDS */}
      tags:
      - subpackage_users
      parameters:
      - 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_remote_fields
        in: query
        description: Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
        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: is_common_model_field
        in: query
        description: If provided, will only return remote field classes with this is_common_model_field value
        required: false
        schema:
          type: boolean
      - name: is_custom
        in: query
        description: If provided, will only return remote fields classes with this is_custom value
        required: false
        schema:
          type: boolean
      - name: page_size
        in: query
        description: Number of results to return per page. The maximum limit is 100.
        required: false
        schema:
          type: integer
      - 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/PaginatedRemoteFieldClassList'
  /filestorage/v1/users:
    get:
      operationId: list
      summary: List
      description: Returns a list of `User` objects.{/* BEGIN_FILESTORAGE_USER_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+WTYW/aMBCG/8rkjygko4xVjTRNQFgLGqYrabWuqqIjPoLBsYPtAKXqf58SaAtbpfUD2jT1W+50957vuTf3JAaLidJ3xCdjLtBYpSFB4pBUMRTEJ5cGNXEIZJxCivtl0eKIOMTkWaa0RfaFo2DmTOOY+MRLUSdYzSUfc2TeTpfHpcVEg+VKGu+puzou24lDBJczZM04Vrm0r9Db1Fdh0/BLaDzBjSUOycAYO9EqTyYXOM/RvEa6eJ3AFKUFUWVgwduRqeqNzku5Yg+GAi2yACwEaDEuFt6OnFibGd/zJigytxzvMlx4KD3QlscCjdeonxwdnzSqW5Vy+ucoEZ9qlel8pEbHlSiJRQR5pR/GKxp2l3SafKDtDyu6vmzQ9WxNp7P3lSiBSj/sNwbhdX0QNGuDFwqi4cfvJ1etoNWjlXjdqdPp9ZKGca0fxrPRulvvncbL3tm3FV1fH/WDyzoNO43eqaoN2hem375Q/abrEofs3pX4N/e7ia15Wmq1X9hNC7s9A9mcAjJezfKR4LFr6i6ksFYSlsaNVeqlyDh45wLsWOm0pVaRmeegMZpSvfxxLN1MJo/wuZJP5IlPOvSsSdudYN8NzQVwASOBxLc6x98MTfwbgilwEQFjGk1x2h2PZKhTbky5tEMSrfKs+OAmSov/SBaLO2S/SmOqLEbFSfejKAM7eU5xRm6LYJ5zjewcNKRoURdPun1wXgIcaJWNDg15K/oIOv0qryby7q+A/tc8T5VKBL4LNF/gYaBuFKNSMRqWRN+2ZQcSD4j30bMDiaxEvDHtmzDrcAIazxWX9rAsh4VuVuj+mSZtht2rzn/F8vbhJ7/9+x4ICQAA" 

# --- truncated at 32 KB (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/openapi/merge-subpackage-users-api-openapi.yml