{
  "opencollection": "1.0.0",
  "info": {
    "name": "Accounting subpackage_candidates API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_candidates",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.merge.dev/api/ats/v1/candidates",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Account-Token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "created_after",
                "value": "",
                "type": "query",
                "description": "If provided, will only return objects created after this datetime."
              },
              {
                "name": "created_before",
                "value": "",
                "type": "query",
                "description": "If provided, will only return objects created before this datetime."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "The pagination cursor value."
              },
              {
                "name": "email_addresses",
                "value": "",
                "type": "query",
                "description": "If provided, will only return candidates with these email addresses; multiple addresses can be separated by commas."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces."
              },
              {
                "name": "first_name",
                "value": "",
                "type": "query",
                "description": "If provided, will only return candidates with this first name."
              },
              {
                "name": "include_deleted_data",
                "value": "",
                "type": "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/)."
              },
              {
                "name": "include_remote_data",
                "value": "",
                "type": "query",
                "description": "Whether to include the original data Merge fetched from the third-party to produce these models."
              },
              {
                "name": "include_shell_data",
                "value": "",
                "type": "query",
                "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)."
              },
              {
                "name": "last_name",
                "value": "",
                "type": "query",
                "description": "If provided, will only return candidates with this last name."
              },
              {
                "name": "modified_after",
                "value": "",
                "type": "query",
                "description": "If provided, only objects synced by Merge after this date time will be returned."
              },
              {
                "name": "modified_before",
                "value": "",
                "type": "query",
                "description": "If provided, only objects synced by Merge before this date time will be returned."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page. The maximum limit is 100."
              },
              {
                "name": "remote_id",
                "value": "",
                "type": "query",
                "description": "The API provider's ID for the given object."
              },
              {
                "name": "tags",
                "value": "",
                "type": "query",
                "description": "If provided, will only return candidates with these tags; multiple tags can be separated by commas."
              }
            ]
          },
          "docs": "Returns a list of `Candidate` objects.{/* BEGIN_ATS_CANDIDATE_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType=\"GET\" data=\"H4sIAAAAAAAAA+1dbVPiOhv+K0w/OgirrrtnnXnmGd5UWEFXUY+7s9NJ0xuIpElNUxDOnP/+TGgr9Kz6UEihZc83GsuVkvvq/Z74l4GRhD4XE+PEQNIziobDbaDGiVFDzCY2kmAUDeSSDnIguMccHRpFw/NdlwsJ9ikBanvnAnrGiVF2QPRh32ekR8AuI+mVCZPQF0gSzrzyy7f2e7OvGUWDEjYEu4Ix95l8Bye4bx8FN/7jUv3Zk0bRcJHnyYHgfn9wDU8+eO9Bqqeh4ACTiO7bSKLywtf3RfD918bUc9tAQYJdRxLVQQJWPzCcaiCl652UywOgbmk2bcmGURl"
        },
        {
          "info": {
            "name": "Create",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.merge.dev/api/ats/v1/candidates",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Account-Token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "is_debug_mode",
                "value": "",
                "type": "query",
                "description": "Whether to include debug fields (such as log file links) in the response."
              },
              {
                "name": "run_async",
                "value": "",
                "type": "query",
                "description": "Whether or not third-party updates should be run asynchronously."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a `Candidate` object with the given values.{/* BEGIN_ATS_CANDIDATE_CREATE_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType=\"POST\" data=\"H4sIAAAAAAAAA+Vaa1PiOhj+K0w+OlxWWc+uzJw5w0URV4qruK5nZ6eTpi8QSZOapijs7H8/U1qEqoWCKeqebzS0T9PnSd5rfiGCFfSFHKMKwspDeeQIGxiqoDrmNrWxApRH2KUGdiC8xxztoTzyfNcVUoF9RIHZ3rGEHqqgkgOyDwWf0x4Fu4SVV6JcQV9iRQX3Sg9PFXrTx1AeMcqHYFcJET5XS3DC+wo4vPHRZfC3p1Aeudjz1EAKvz84h1sfvGWQwWwYOMAVZgUbK1xaeLwgw+efGwvmbQMDBXYDK9wABST4wOhVA6Vcr1IqDYC5xelr"
        },
        {
          "info": {
            "name": "Retrieve",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.merge.dev/api/ats/v1/candidates/:id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Account-Token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces."
              },
              {
                "name": "include_remote_data",
                "value": "",
                "type": "query",
                "description": "Whether to include the original data Merge fetched from the third-party to produce these models."
              },
              {
                "name": "include_shell_data",
                "value": "",
                "type": "query",
                "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)."
              }
            ]
          },
          "docs": "Returns a `Candidate` object with the given `id`.{/* BEGIN_ATS_CANDIDATE_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType=\"GET\" data=\"H4sIAAAAAAAAA+1dbVPiOhv+K0w/OgirrrtnnXnmGd5UWEFXUY+7s9NJ0xuIpElNUxDOnP/+TGgr9Kz6UEihZc83GsuVkvvq/Z74l4GRhD4XE+PEQNIziobDbaDGiVFDzCY2kmAUDeSSDnIguMccHRpFw/NdlwsJ9ikBanvnAnrGiVF2QPRh32ekR8AuI+mVCZPQF0gSzrzyy7f2e7OvGUWDEjYEu4Ix95l8Bye4bx8FN/7jUv3Zk0bRcJHnyYHgfn9wDU8+eO9Bqqeh4ACTiO7bSKLywtf3RfD918bUc9tAQYJdRxLVQQJWPzCcaiCl652UywOg"
        },
        {
          "info": {
            "name": "Partial Update",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.merge.dev/api/ats/v1/candidates/:id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Account-Token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "is_debug_mode",
                "value": "",
                "type": "query",
                "description": "Whether to include debug fields (such as log file links) in the response."
              },
              {
                "name": "run_async",
                "value": "",
                "type": "query",
                "description": "Whether or not third-party updates should be run asynchronously."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a `Candidate` object with the given `id`.{/* BEGIN_ATS_CANDIDATE_EDIT_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType=\"PATCH\" data=\"H4sIAAAAAAAAA82UUW/aMBSF/4sfESSjlLWNNE0UWAsqoYW0Haoq68a+BIMTp7YDLVX/+xRgLWyoHRLT9mY75x473z26z4SBxUjpJ+IRsIYUSaw4SuKROiRccLBIigRS4UOMSw2dHpAiMVmaKm2RfxMouTnXOCQecWPUEZayRAwFchescUViMdJghUqM+1pVGi7KSJFIkUyQ1xhTWWLf8VnqSrAU/rLNPxtLiiQFY+xIqywa9fAhQ/OeZf4aiTEmFmSJgwV3rbykl/XbzvJ3c5RokTfAQgMtsvwHV1eNrE2N57ojlKmzuNbhOHUxcUFbwSQat1o"
        },
        {
          "info": {
            "name": "Ignore Create",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.merge.dev/api/ats/v1/candidates/ignore/:model_id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Account-Token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "model_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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_ATS_CANDIDATE_CREATE_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType=\"POST\" data=\"H4sIAAAAAAAAA+Vaa1PiOhj+K0w+OlxWWc+uzJw5w0URV4qruK5nZ6eTpi8QSZOapijs7H8/U1qEqoWCKeqebzS0T9PnSd5rfiGCFfSFHKMKwspDeeQIGxiqoDrmNrWxApRH2"
        },
        {
          "info": {
            "name": "Meta Patch Retrieve",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.merge.dev/api/ats/v1/candidates/meta/patch/:id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Account-Token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Returns metadata for `Candidate` PATCHs.{/* BEGIN_ATS_CANDIDATE_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType=\"GET\" data=\"H4sIAAAAAAAAA+1dbVPiOhv+K0w/OgirrrtnnXnmGd5UWEFXUY+7s9NJ0xuIpElNUxDOnP/+TGgr9Kz6UEihZc83GsuVkvvq/Z74l4GRhD4XE+PEQNIziobDbaDGiVFDzCY2kmAUDeSSDnIguMccHRpFw/NdlwsJ9ikBanvnAnrGiVF2QPRh32ekR8AuI+mVCZPQF0gSzrzyy7f2e7OvGUWDEjYEu4Ix95l8Bye4bx8FN/7jUv3Zk0bRcJHnyYHgfn9wDU8+eO9Bqqeh4ACTiO7bSKLywtf3RfD918bUc9tAQYJdRxLVQQJWPzCcaiCl652UywOgbmk2bcmGU"
        },
        {
          "info": {
            "name": "Meta Post Retrieve",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.merge.dev/api/ats/v1/candidates/meta/post",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Account-Token",
                "value": ""
              }
            ]
          },
          "docs": "Returns metadata for `Candidate` POSTs.{/* BEGIN_ATS_CANDIDATE_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType=\"GET\" data=\"H4sIAAAAAAAAA+1dbVPiOhv+K0w/OgirrrtnnXnmGd5UWEFXUY+7s9NJ0xuIpElNUxDOnP/+TGgr9Kz6UEihZc83GsuVkvvq/Z74l4GRhD4XE+PEQNIziobDbaDGiVFDzCY2kmAUDeSSDnIguMccHRpFw/NdlwsJ9ikBanvnAnrGiVF2QPRh32ekR8AuI+mVCZPQF0gSzrzyy7f2e7OvGUWDEjYEu4Ix95l8Bye4bx8FN/7jUv3Zk0bRcJHnyYHgfn9wDU8+eO9Bqqeh4ACTiO7bSKLywtf3RfD918bUc9tAQYJdRxLVQQJWPzCcaiCl652UywOgbmk2bcmGUR"
        }
      ]
    }
  ],
  "bundled": true
}