{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/applicants","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X GET -H 'X-ACCESS-TOKEN: secret-api-token' -d 'funnel_id=11111111-0000-0000-0000-000000000000&stage_id=22222222-0000-0000-0000-000000000000' 'https://api.fountain.com/v2/applicants'","name":null},{"code":"https://www.onboardiq.com/api/v2/applicants/","language":"text"}]},"method":"get","results":{"codes":[{"name":"","code":"{\n  \"applicants\": [\n    {\n      \"id\": \"6e6f5eee-abbe-4ccb-8f12-894842bbe252\",\n      \"email\": \"tremayne:::at:::larkin.net\",\n      \"name\": \"Sammy Bailey\",\n      \"first_name\": \"Sammy\",\n      \"last_name\": \"Bailey\",\n      \"phone_number\": \"2363835989\",\n      \"normalized_phone_number\": \"+12363835989\",\n      \"receive_automated_emails\": true,\n      \"is_duplicate\": true,\n      \"data\": {},\n      \"created_at\": \"2015-06-05T05:53:42.752-07:00\",\n      \"updated_at\": \"2015-06-05T05:54:42.752-07:00\",\n      \"last_transitioned_at\": \"2015-06-05T05:53:42.752-07:00\",\n      \"funnel\": {\n        \"id\": \"7f88228c-cba9-4827-b71d-e81244c05d37\",\n        \"title\": \"Legacy Paradigm Executive\",\n        \"custom_id\": \"3d67750a-dcf4-4ada-a3e4-ee44661949fc\"\n      },\n      \"partner_data\": [\n        {\n          \"description\": \"\",\n          \"type\": \"object\",\n          \"example\": []\n        }\n      ],\n      \"can_receive_sms\": true,\n      \"phone_platform\": \"sms\",\n      \"stage\": {\n        \"id\": \"4d800504-f786-4f2f-92fe-a127d04d503c\",\n        \"title\": \"Approved\",\n        \"parent_id\": \"4d800504-f786-4f2f-92fe-a127d04d503c\"\n      },\n      \"background_checks\": [\n        {\n          \"title\": \"Driver license check\",\n          \"status\": \"pending\",\n          \"vendor\": \"checkr\",\n          \"candidate_id\": \"e44aa283528e6fde7d542194\",\n          \"report_id\": \"4722c07dd9a10c3985ae432a\",\n          \"applicant_id\": \"989fd339-ce2c-4a38-a86e-ab513239c809\",\n          \"check_id\": \"e9837e56-e03f-47e1-9975-149729f0ac1e\"\n        }\n      ],\n      \"document_signatures\": [\n        {\n          \"vendor\": \"hellosign\",\n          \"signature_id\": \"123dfdsf\",\n          \"status\": \"signed\"\n        }\n      ],\n      \"labels\": [\n        {\n          \"title\": \"Label-1\",\n          \"completed\": true,\n          \"completed_at\": \"2017-01-01T14:40:30.873-08:00\"\n        }\n      ],\n      \"file_upload_requests\": [\n        {\n          \"id\": 55,\n          \"created_at\": \"2017-01-01T14:40:30.873-08:00\",\n          \"recollection_reason\": \"blurry\",\n          \"document_name\": \"driver_license\"\n        }\n      ],\n      \"addresses\": [\n        {\n          \"street_name\": \"11718 Selkirk Drive\",\n          \"address_2\": \"Apartment 101\",\n          \"city\": \"Austin\",\n          \"state\": \"Texas\",\n          \"zipcode\": 78756,\n          \"country\": \"US\",\n          \"latitude\": 60,\n          \"longitude\": 128\n        }\n      ]\n    }\n  ],\n  \"pagination\": {\n    \"first\": 1,\n    \"previous\": \"\",\n    \"current\": 1,\n    \"next\": \"\",\n    \"last\": 1,\n    \"current_cursor\": \"dEZTT29oa0VtbUtsYzIySy9aNGlEUT09LS1HbTR6di9vQ2swNE9jOVdxRENYSjJ3PT0=--900ac1352e2a3e86bda4387d9cb177563bf4c9da\",\n    \"next_cursor\": \"cnNwcWJ4VWp1T0Y5eFZWSGIvUmZjdz09LS14Z1RZbGlCdmNRdHNJMEhocGl5aDF3PT0=--d9e7bac1b041fa318b452d0be88a4f04b1194052\"\n  }\n}","language":"json","status":200},{"code":"{\n  \"message\": \"Authentication is required\"\n}","language":"json","status":401,"name":""}]},"settings":"","params":[{"name":"funnel_id","type":"string","default":"11111111-0000-0000-0000-000000000000","desc":"Filter by Opening ID","required":false,"in":"query","ref":"","_id":"56c66c6b916c9717008052b8"},{"name":"stage_id","type":"string","default":"22222222-0000-0000-0000-000000000000","desc":"Filter by Stage ID","required":false,"in":"query","ref":"","_id":"56c66c6b916c9717008052b7"},{"name":"stage","type":"string","default":"rejected","desc":"Filter by Stage type","required":false,"in":"query","ref":"","_id":"56c66c6b916c9717008052b6"},{"name":"labels","type":"string","default":"Contacted,Bank Account,-Not Interested","desc":"Filter by label (must be URL-encoded)","required":false,"in":"query","ref":"","_id":"56c66c6b916c9717008052b5"},{"name":"cursor","type":"string","default":"","desc":"Cursor parameter for cursor-based pagination","required":false,"in":"query","ref":"","_id":"59e53c1589107b0010c2edee"},{"name":"created_at","type":"string","default":"","desc":"Can filter by a specific day by passing a date in the form created_at='YYYY-MM-DD' or a specific range by created_at[gt]='2017-04-14T10:00:00' and created_at[lt]='2017-04-17T14:00:00'","required":false,"in":"query","ref":"","_id":"5f6a1b650b3806004a5b5aba"},{"name":"last_transitioned_at","type":"string","default":"","desc":"Can filter by a specific day by passing a date in the form last_transitioned_at='YYYY-MM-DD' or a specific range by last_transitioned_at[gt]='2017-04-14T10:00:00' and last_transitioned_at[lt]='2017-04-17T14:00:00'","required":false,"in":"query","ref":"","_id":"5f6a1b650b3806004a5b5ab9"},{"name":"updated_at","type":"string","default":"","desc":"Can filter by a specific day by passing a date in the form updated_at='YYYY-MM-DD' or a specific range by updated_at[gt]='2017-04-14T10:00:00' and updated_at[lt]='2017-04-17T14:00:00'","required":false,"in":"query","ref":"","_id":"5f6a1b650b3806004a5b5ab8"},{"name":"X-ACCESS-TOKEN","type":"string","default":"secret-api-token","desc":"Access Token","required":true,"in":"header","ref":"","_id":"60d4ffb65268f4005085e819"}]},"next":{"description":"","pages":[]},"title":"List All Applicants","type":"endpoint","slug":"get-apiv2applicants-list-applicants","excerpt":"","body":"# List Applicants\n\nList all applicants within your account. Pagination is available.\n\nYou can get all of the information about an applicant — including their scorecard results, background check information, and labels.\n\nUse the `page` parameter to indicate the page for pagination, e.g. `&page=2` to get to the 2nd page of the listing.\n\nHowever, the page parameter value has a limit due to performance reasons. If you need to access very old pages, please use cursor-based pagination. Every API response contains pagination.next_cursor property, which you can use as a `?cursor=<cursor_string>` in the next request. The parameter will look like this: `?cursor=cnNwcWJ4VWp1T0Y5eFZWSGIvUmZjdz09LS14Z1RZbGlCdmNRdHNJMEho...`.\n\n# Filtering\n\nWe support optional filters for selecting only applicants that you care about. You can also list all applicants in your account, without filtering.\n\n## Opening or Stage ID\nYou can filter the applicants by an Opening (funnel) and/or Stage, using the `funnel_id` or `stage_id` parameters. You must use the unique ID of the Stage or Opening, not the title. To look up the ID of an Opening (funnel) or Stage, use the `List All Positions` or `List All Stages` endpoints.\n\n## Stage type\nFilter applicants by the type of their current stage, which can be one of the following: `hired`, `rejected`, `archived`, `background_check`, `interview`, `signature`. Please note, `applicants?stage=hired` will return hired applicants from all funnels in your account.\n\n## Date created or last transition date\nYou can also filter applicants by date created or last transition date. For example, `applicants?created_at=2016-12-23` or `applicants?last_transitioned_at=2017-01-06` or using a range `created_at[gt]=2017-04-14T10:00:00&created_at[lt]=2017-04-17T14:00:00`. We accept dates and times in ISO8601 format, and the timezone is UTC.\n\n## Label\nTo filter by label, you can provide a comma-separated list of labels in the `labels` parameter. To get applicants which don’t have a certain label, prepend the label name with `-`.\n\nFor example: `applicants?labels=Contacted,-Banned` will return applicants who have a `Contacted` label and also do _not_ have a `Banned` label.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Labels must be URL encoded\",\n  \"body\": \"If you pass the labels in the URL query string, their names must be URL-encoded, e.g. `/api/v2/applicants?labels=Contacted,Other%20Label,-Not%20Interested`.\"\n}\n[/block]\n## Response Schema\n[block:html]\n{\n  \"html\": \"<div class=\\\"schema\\\"><ul><li>additionalProperties: false</li><li>    <span id=\\\"applicants-0-3341201679070177618\\\">\\n      <a href=\\\"#applicants-0-3341201679070177618\\\" class=\\\"anchor\\\">\\n        <tt>applicants</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: array</li><li>Items<div class=\\\"schema\\\"><ul><li>Required: no</li><li>additionalProperties: false</li><li>    <span id=\\\"id-2--567263231004598591\\\">\\n      <a href=\\\"#id-2--567263231004598591\\\" class=\\\"anchor\\\">\\n        <tt>id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;6e6f5eee-abbe-4ccb-8f12-894842bbe252&quot;</tt></li></ul></div></li><li>    <span id=\\\"email-2--416104501903741859\\\">\\n      <a href=\\\"#email-2--416104501903741859\\\" class=\\\"anchor\\\">\\n        <tt>email</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;[email protected]&quot;</tt></li></ul></div></li><li>    <span id=\\\"name-2-2797728404326897034\\\">\\n      <a href=\\\"#name-2-2797728404326897034\\\" class=\\\"anchor\\\">\\n        <tt>name</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;Sammy Bailey&quot;</tt></li></ul></div></li><li>    <span id=\\\"first_name-2-4455355522592130336\\\">\\n      <a href=\\\"#first_name-2-4455355522592130336\\\" class=\\\"anchor\\\">\\n        <tt>first_name</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;Sammy&quot;</tt></li></ul></div></li><li>    <span id=\\\"last_name-2--4172194588889423664\\\">\\n      <a href=\\\"#last_name-2--4172194588889423664\\\" class=\\\"anchor\\\">\\n        <tt>last_name</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;Bailey&quot;</tt></li></ul></div></li><li>    <span id=\\\"phone_number-2--1393233283469606888\\\">\\n      <a href=\\\"#phone_number-2--1393233283469606888\\\" class=\\\"anchor\\\">\\n        <tt>phone_number</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;2363835989&quot;</tt></li></ul></div></li><li>    <span id=\\\"normalized_phone_number-2-1833775094342495715\\\">\\n      <a href=\\\"#normalized_phone_number-2-1833775094342495715\\\" class=\\\"anchor\\\">\\n        <tt>normalized_phone_number</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;+12363835989&quot;</tt></li></ul></div></li><li>    <span id=\\\"receive_automated_emails-2--4176832304891926828\\\">\\n      <a href=\\\"#receive_automated_emails-2--4176832304891926828\\\" class=\\\"anchor\\\">\\n        <tt>receive_automated_emails</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: boolean</li><li>Example: <tt>true</tt></li></ul></div></li><li>    <span id=\\\"is_duplicate-2--1951414614342927166\\\">\\n      <a href=\\\"#is_duplicate-2--1951414614342927166\\\" class=\\\"anchor\\\">\\n        <tt>is_duplicate</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: boolean</li><li>Example: <tt>true</tt></li></ul></div></li><li>    <span id=\\\"data-2-3399301848986046703\\\">\\n      <a href=\\\"#data-2-3399301848986046703\\\" class=\\\"anchor\\\">\\n        <tt>data</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>additionalProperties: false</li></ul></div></li><li>    <span id=\\\"created_at-2--1325872048428172897\\\">\\n      <a href=\\\"#created_at-2--1325872048428172897\\\" class=\\\"anchor\\\">\\n        <tt>created_at</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Format: date-time</li><li>Example: <tt>&quot;2015-06-05T05:53:42.752-07:00&quot;</tt></li></ul></div></li><li>    <span id=\\\"updated_at-2-1663458663414710774\\\">\\n      <a href=\\\"#updated_at-2-1663458663414710774\\\" class=\\\"anchor\\\">\\n        <tt>updated_at</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Format: date-time</li><li>Example: <tt>&quot;2015-06-05T05:54:42.752-07:00&quot;</tt></li></ul></div></li><li>    <span id=\\\"last_transitioned_at-2--829579012148987699\\\">\\n      <a href=\\\"#last_transitioned_at-2--829579012148987699\\\" class=\\\"anchor\\\">\\n        <tt>last_transitioned_at</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Format: date-time</li><li>Example: <tt>&quot;2015-06-05T05:53:42.752-07:00&quot;</tt></li></ul></div></li><li>    <span id=\\\"funnel-2-4137958799661994875\\\">\\n      <a href=\\\"#funnel-2-4137958799661994875\\\" class=\\\"anchor\\\">\\n        <tt>funnel</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>additionalProperties: false</li><li>    <span id=\\\"id-3--4230936251174999449\\\">\\n      <a href=\\\"#id-3--4230936251174999449\\\" class=\\\"anchor\\\">\\n        <tt>id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;7f88228c-cba9-4827-b71d-e81244c05d37&quot;</tt></li></ul></div></li><li>    <span id=\\\"title-3-2263411278986264746\\\">\\n      <a href=\\\"#title-3-2263411278986264746\\\" class=\\\"anchor\\\">\\n        <tt>title</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;Legacy Paradigm Executive&quot;</tt></li></ul></div></li><li>    <span id=\\\"custom_id-3-2099753569639815224\\\">\\n      <a href=\\\"#custom_id-3-2099753569639815224\\\" class=\\\"anchor\\\">\\n        <tt>custom_id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;3d67750a-dcf4-4ada-a3e4-ee44661949fc&quot;</tt></li></ul></div></li></ul></div></li><li>    <span id=\\\"partner_data-2-2475741669081426983\\\">\\n      <a href=\\\"#partner_data-2-2475741669081426983\\\" class=\\\"anchor\\\">\\n        <tt>partner_data</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: array</li><li>Items<div class=\\\"schema\\\"><ul><li>Required: no</li><li>additionalProperties: false</li><li>    <span id=\\\"description-4--370048440908750890\\\">\\n      <a href=\\\"#description-4--370048440908750890\\\" class=\\\"anchor\\\">\\n        <tt>description</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;&quot;</tt></li></ul></div></li><li>    <span id=\\\"type-4-3295150059601225184\\\">\\n      <a href=\\\"#type-4-3295150059601225184\\\" class=\\\"anchor\\\">\\n        <tt>type</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;object&quot;</tt></li></ul></div></li><li>    <span id=\\\"example-4-1333678427311406631\\\">\\n      <a href=\\\"#example-4-1333678427311406631\\\" class=\\\"anchor\\\">\\n        <tt>example</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: array</li></ul></div></li></ul></div></li></ul></div></li><li>    <span id=\\\"can_receive_sms-2-2150401359249774573\\\">\\n      <a href=\\\"#can_receive_sms-2-2150401359249774573\\\" class=\\\"anchor\\\">\\n        <tt>can_receive_sms</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: boolean</li><li>Example: <tt>true</tt></li></ul></div></li><li>    <span id=\\\"phone_platform-2-4517043044236504764\\\">\\n      <a href=\\\"#phone_platform-2-4517043044236504764\\\" class=\\\"anchor\\\">\\n        <tt>phone_platform</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;sms&quot;</tt></li></ul></div></li><li>    <span id=\\\"stage-2--3851817367689253080\\\">\\n      <a href=\\\"#stage-2--3851817367689253080\\\" class=\\\"anchor\\\">\\n        <tt>stage</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>additionalProperties: false</li><li>    <span id=\\\"id-3--2968721907276373455\\\">\\n      <a href=\\\"#id-3--2968721907276373455\\\" class=\\\"anchor\\\">\\n        <tt>id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;4d800504-f786-4f2f-92fe-a127d04d503c&quot;</tt></li></ul></div></li><li>    <span id=\\\"title-3-3835121282188741077\\\">\\n      <a href=\\\"#title-3-3835121282188741077\\\" class=\\\"anchor\\\">\\n        <tt>title</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;Approved&quot;</tt></li></ul></div></li><li>    <span id=\\\"parent_id-3--1245221587039019340\\\">\\n      <a href=\\\"#parent_id-3--1245221587039019340\\\" class=\\\"anchor\\\">\\n        <tt>parent_id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: null</li><li>Example: <tt>&quot;4d800504-f786-4f2f-92fe-a127d04d503c&quot;</tt></li></ul></div></li></ul></div></li><li>    <span id=\\\"background_checks-2-1714160780411725645\\\">\\n      <a href=\\\"#background_checks-2-1714160780411725645\\\" class=\\\"anchor\\\">\\n        <tt>background_checks</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: array</li><li>Items<div class=\\\"schema\\\"><ul><li>Required: no</li><li>additionalProperties: false</li><li>    <span id=\\\"title-4--3916024436433106671\\\">\\n      <a href=\\\"#title-4--3916024436433106671\\\" class=\\\"anchor\\\">\\n        <tt>title</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;Driver license check&quot;</tt></li></ul></div></li><li>    <span id=\\\"status-4--2030617626797436455\\\">\\n      <a href=\\\"#status-4--2030617626797436455\\\" class=\\\"anchor\\\">\\n        <tt>status</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;pending&quot;</tt></li></ul></div></li><li>    <span id=\\\"vendor-4-2595644624217468281\\\">\\n      <a href=\\\"#vendor-4-2595644624217468281\\\" class=\\\"anchor\\\">\\n        <tt>vendor</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;checkr&quot;</tt></li></ul></div></li><li>    <span id=\\\"candidate_id-4-267150060153265828\\\">\\n      <a href=\\\"#candidate_id-4-267150060153265828\\\" class=\\\"anchor\\\">\\n        <tt>candidate_id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;e44aa283528e6fde7d542194&quot;</tt></li></ul></div></li><li>    <span id=\\\"report_id-4--143498542645933493\\\">\\n      <a href=\\\"#report_id-4--143498542645933493\\\" class=\\\"anchor\\\">\\n        <tt>report_id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;4722c07dd9a10c3985ae432a&quot;</tt></li></ul></div></li><li>    <span id=\\\"applicant_id-4--1831679193835239968\\\">\\n      <a href=\\\"#applicant_id-4--1831679193835239968\\\" class=\\\"anchor\\\">\\n        <tt>applicant_id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;989fd339-ce2c-4a38-a86e-ab513239c809&quot;</tt></li></ul></div></li><li>    <span id=\\\"check_id-4-1801195825004314402\\\">\\n      <a href=\\\"#check_id-4-1801195825004314402\\\" class=\\\"anchor\\\">\\n        <tt>check_id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;e9837e56-e03f-47e1-9975-149729f0ac1e&quot;</tt></li></ul></div></li></ul></div></li></ul></div></li><li>    <span id=\\\"document_signatures-2-348480225719268001\\\">\\n      <a href=\\\"#document_signatures-2-348480225719268001\\\" class=\\\"anchor\\\">\\n        <tt>document_signatures</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: array</li><li>Items<div class=\\\"schema\\\"><ul><li>Required: no</li><li>additionalProperties: false</li><li>    <span id=\\\"vendor-4-1908910426744758219\\\">\\n      <a href=\\\"#vendor-4-1908910426744758219\\\" class=\\\"anchor\\\">\\n        <tt>vendor</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;hellosign&quot;</tt></li></ul></div></li><li>    <span id=\\\"signature_id-4--4432508896015772867\\\">\\n      <a href=\\\"#signature_id-4--4432508896015772867\\\" class=\\\"anchor\\\">\\n        <tt>signature_id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\">Vendor-specific signature ID<ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;123dfdsf&quot;</tt></li></ul></div></li><li>    <span id=\\\"status-4-1646879607601482080\\\">\\n      <a href=\\\"#status-4-1646879607601482080\\\" class=\\\"anchor\\\">\\n        <tt>status</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\">Status of this request (opened, signed or admin_reviewed)<ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;signed&quot;</tt></li></ul></div></li></ul></div></li></ul></div></li><li>    <span id=\\\"labels-2-4351254104005212615\\\">\\n      <a href=\\\"#labels-2-4351254104005212615\\\" class=\\\"anchor\\\">\\n        <tt>labels</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: array</li><li>Items<div class=\\\"schema\\\"><ul><li>Required: no</li><li>additionalProperties: false</li><li>    <span id=\\\"title-4-547342498908383467\\\">\\n      <a href=\\\"#title-4-547342498908383467\\\" class=\\\"anchor\\\">\\n        <tt>title</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;Label-1&quot;</tt></li></ul></div></li><li>    <span id=\\\"completed-4-1878003622276566714\\\">\\n      <a href=\\\"#completed-4-1878003622276566714\\\" class=\\\"anchor\\\">\\n        <tt>completed</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: boolean</li><li>Example: <tt>false</tt></li></ul></div></li><li>    <span id=\\\"completed_at-4--4382553547684367493\\\">\\n      <a href=\\\"#completed_at-4--4382553547684367493\\\" class=\\\"anchor\\\">\\n        <tt>completed_at</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;2017-01-01T14:40:30.873-08:00&quot;</tt></li></ul></div></li></ul></div></li></ul></div></li><li>    <span id=\\\"file_upload_requests-2--3829455117098023280\\\">\\n      <a href=\\\"#file_upload_requests-2--3829455117098023280\\\" class=\\\"anchor\\\">\\n        <tt>file_upload_requests</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: array</li><li>Items<div class=\\\"schema\\\">Recollection Requests<ul><li>Required: no</li><li>additionalProperties: false</li><li>    <span id=\\\"id-4--1999380117934272024\\\">\\n      <a href=\\\"#id-4--1999380117934272024\\\" class=\\\"anchor\\\">\\n        <tt>id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>55</tt></li></ul></div></li><li>    <span id=\\\"created_at-4-4058606685901728974\\\">\\n      <a href=\\\"#created_at-4-4058606685901728974\\\" class=\\\"anchor\\\">\\n        <tt>created_at</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;2017-01-01T14:40:30.873-08:00&quot;</tt></li></ul></div></li><li>    <span id=\\\"recollection_reason-4-2254135842697829218\\\">\\n      <a href=\\\"#recollection_reason-4-2254135842697829218\\\" class=\\\"anchor\\\">\\n        <tt>recollection_reason</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;blurry&quot;</tt></li></ul></div></li><li>    <span id=\\\"document_name-4--320640853011432200\\\">\\n      <a href=\\\"#document_name-4--320640853011432200\\\" class=\\\"anchor\\\">\\n        <tt>document_name</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;driver_license&quot;</tt></li></ul></div></li></ul></div></li></ul></div></li><li>    <span id=\\\"addresses-2-2857022521695061189\\\">\\n      <a href=\\\"#addresses-2-2857022521695061189\\\" class=\\\"anchor\\\">\\n        <tt>addresses</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: array</li><li>Items<div class=\\\"schema\\\">Applicant Addresses<ul><li>Required: no</li><li>additionalProperties: false</li><li>    <span id=\\\"street_name-4--3975396091286181444\\\">\\n      <a href=\\\"#street_name-4--3975396091286181444\\\" class=\\\"anchor\\\">\\n        <tt>street_name</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;11718 Selkirk Drive&quot;</tt></li></ul></div></li><li>    <span id=\\\"address_2-4--2052756538671985203\\\">\\n      <a href=\\\"#address_2-4--2052756538671985203\\\" class=\\\"anchor\\\">\\n        <tt>address_2</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;Apartment 101&quot;</tt></li></ul></div></li><li>    <span id=\\\"city-4--660438396307906583\\\">\\n      <a href=\\\"#city-4--660438396307906583\\\" class=\\\"anchor\\\">\\n        <tt>city</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;Austin&quot;</tt></li></ul></div></li><li>    <span id=\\\"state-4-426270196406270049\\\">\\n      <a href=\\\"#state-4-426270196406270049\\\" class=\\\"anchor\\\">\\n        <tt>state</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;Texas&quot;</tt></li></ul></div></li><li>    <span id=\\\"zipcode-4--2815293401253663496\\\">\\n      <a href=\\\"#zipcode-4--2815293401253663496\\\" class=\\\"anchor\\\">\\n        <tt>zipcode</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>78756</tt></li></ul></div></li><li>    <span id=\\\"country-4-620378981484023606\\\">\\n      <a href=\\\"#country-4-620378981484023606\\\" class=\\\"anchor\\\">\\n        <tt>country</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;US&quot;</tt></li></ul></div></li><li>    <span id=\\\"latitude-4--4065652295766585071\\\">\\n      <a href=\\\"#latitude-4--4065652295766585071\\\" class=\\\"anchor\\\">\\n        <tt>latitude</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: number</li><li>Example: <tt>60</tt></li></ul></div></li><li>    <span id=\\\"longitude-4-3909648517730512847\\\">\\n      <a href=\\\"#longitude-4-3909648517730512847\\\" class=\\\"anchor\\\">\\n        <tt>longitude</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: number</li><li>Example: <tt>128</tt></li></ul></div></li></ul></div></li></ul></div></li></ul></div></li></ul></div></li><li>    <span id=\\\"pagination-0--3081964322725990309\\\">\\n      <a href=\\\"#pagination-0--3081964322725990309\\\" class=\\\"anchor\\\">\\n        <tt>pagination</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>additionalProperties: false</li><li>    <span id=\\\"first-1-1339174693238793858\\\">\\n      <a href=\\\"#first-1-1339174693238793858\\\" class=\\\"anchor\\\">\\n        <tt>first</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: integer</li><li>Example: <tt>1</tt></li></ul></div></li><li>    <span id=\\\"previous-1--2213323195423858537\\\">\\n      <a href=\\\"#previous-1--2213323195423858537\\\" class=\\\"anchor\\\">\\n        <tt>previous</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: null</li><li>Example: <tt>&quot;&quot;</tt></li></ul></div></li><li>    <span id=\\\"current-1--3582970624478534904\\\">\\n      <a href=\\\"#current-1--3582970624478534904\\\" class=\\\"anchor\\\">\\n        <tt>current</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: integer</li><li>Example: <tt>1</tt></li></ul></div></li><li>    <span id=\\\"next-1--1585241688227279447\\\">\\n      <a href=\\\"#next-1--1585241688227279447\\\" class=\\\"anchor\\\">\\n        <tt>next</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: null</li><li>Example: <tt>&quot;&quot;</tt></li></ul></div></li><li>    <span id=\\\"last-1--3350574067278197775\\\">\\n      <a href=\\\"#last-1--3350574067278197775\\\" class=\\\"anchor\\\">\\n        <tt>last</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: integer</li><li>Example: <tt>1</tt></li></ul></div></li><li>    <span id=\\\"current_cursor-1-2823477291932688059\\\">\\n      <a href=\\\"#current_cursor-1-2823477291932688059\\\" class=\\\"anchor\\\">\\n        <tt>current_cursor</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;dEZTT29oa0VtbUtsYzIySy9aNGlEUT09LS1HbTR6di9vQ2swNE9jOVdxRENYSjJ3PT0=--900ac1352e2a3e86bda4387d9cb177563bf4c9da&quot;</tt></li></ul></div></li><li>    <span id=\\\"next_cursor-1-3935109769947710395\\\">\\n      <a href=\\\"#next_cursor-1-3935109769947710395\\\" class=\\\"anchor\\\">\\n        <tt>next_cursor</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;cnNwcWJ4VWp1T0Y5eFZWSGIvUmZjdz09LS14Z1RZbGlCdmNRdHNJMEhocGl5aDF3PT0=--d9e7bac1b041fa318b452d0be88a4f04b1194052&quot;</tt></li></ul></div></li></ul></div></li></ul></div>\"\n}\n[/block]","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"59de6011debd1200240f6916","parentDoc":null,"user":"547504ed59fade080004cb8b","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Applicant Management","slug":"endpoints","order":2,"from_sync":false,"reference":false,"_id":"59de6011debd1200240f68fa","project":"59de6011debd1200240f68ec","version":"59de6011debd1200240f68ee","__v":0,"createdAt":"2016-02-19T01:01:16.044Z"},"version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["59de6011debd1200240f68fb","59de6011debd1200240f68fa","59de6011debd1200240f68fc","59de6011debd1200240f68f8","59de6011debd1200240f68f7","59de6011debd1200240f68f9","59de6011debd1200240f68fd","59de6011debd1200240f68fe","59de6011debd1200240f68ff","5a8bfb99f4146e00449cec47","5a8bfcf2e86f530012159bb2","5cd4c29c6ea1040056ec0f55"],"_id":"59de6011debd1200240f68ee","__v":3,"project":"59de6011debd1200240f68ec","createdAt":"2016-06-20T18:15:42.514Z","releaseDate":"2016-06-20T18:15:42.514Z"},"__v":53,"project":"59de6011debd1200240f68ec","createdAt":"2016-02-19T01:14:19.890Z","githubsync":""}

getList All Applicants


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

funnel_id:
string11111111-0000-0000-0000-000000000000
Filter by Opening ID
stage_id:
string22222222-0000-0000-0000-000000000000
Filter by Stage ID
stage:
stringrejected
Filter by Stage type
labels:
stringContacted,Bank Account,-Not Interested
Filter by label (must be URL-encoded)
cursor:
string
Cursor parameter for cursor-based pagination
created_at:
string
Can filter by a specific day by passing a date in the form created_at='YYYY-MM-DD' or a specific range by created_at[gt]='2017-04-14T10:00:00' and created_at[lt]='2017-04-17T14:00:00'
last_transitioned_at:
string
Can filter by a specific day by passing a date in the form last_transitioned_at='YYYY-MM-DD' or a specific range by last_transitioned_at[gt]='2017-04-14T10:00:00' and last_transitioned_at[lt]='2017-04-17T14:00:00'
updated_at:
string
Can filter by a specific day by passing a date in the form updated_at='YYYY-MM-DD' or a specific range by updated_at[gt]='2017-04-14T10:00:00' and updated_at[lt]='2017-04-17T14:00:00'

Headers

X-ACCESS-TOKEN:
required
stringsecret-api-token
Access Token

Examples


Result Format


Documentation

# List Applicants List all applicants within your account. Pagination is available. You can get all of the information about an applicant — including their scorecard results, background check information, and labels. Use the `page` parameter to indicate the page for pagination, e.g. `&page=2` to get to the 2nd page of the listing. However, the page parameter value has a limit due to performance reasons. If you need to access very old pages, please use cursor-based pagination. Every API response contains pagination.next_cursor property, which you can use as a `?cursor=<cursor_string>` in the next request. The parameter will look like this: `?cursor=cnNwcWJ4VWp1T0Y5eFZWSGIvUmZjdz09LS14Z1RZbGlCdmNRdHNJMEho...`. # Filtering We support optional filters for selecting only applicants that you care about. You can also list all applicants in your account, without filtering. ## Opening or Stage ID You can filter the applicants by an Opening (funnel) and/or Stage, using the `funnel_id` or `stage_id` parameters. You must use the unique ID of the Stage or Opening, not the title. To look up the ID of an Opening (funnel) or Stage, use the `List All Positions` or `List All Stages` endpoints. ## Stage type Filter applicants by the type of their current stage, which can be one of the following: `hired`, `rejected`, `archived`, `background_check`, `interview`, `signature`. Please note, `applicants?stage=hired` will return hired applicants from all funnels in your account. ## Date created or last transition date You can also filter applicants by date created or last transition date. For example, `applicants?created_at=2016-12-23` or `applicants?last_transitioned_at=2017-01-06` or using a range `created_at[gt]=2017-04-14T10:00:00&created_at[lt]=2017-04-17T14:00:00`. We accept dates and times in ISO8601 format, and the timezone is UTC. ## Label To filter by label, you can provide a comma-separated list of labels in the `labels` parameter. To get applicants which don’t have a certain label, prepend the label name with `-`. For example: `applicants?labels=Contacted,-Banned` will return applicants who have a `Contacted` label and also do _not_ have a `Banned` label. [block:callout] { "type": "warning", "title": "Labels must be URL encoded", "body": "If you pass the labels in the URL query string, their names must be URL-encoded, e.g. `/api/v2/applicants?labels=Contacted,Other%20Label,-Not%20Interested`." } [/block] ## Response Schema [block:html] { "html": "<div class=\"schema\"><ul><li>additionalProperties: false</li><li> <span id=\"applicants-0-3341201679070177618\">\n <a href=\"#applicants-0-3341201679070177618\" class=\"anchor\">\n <tt>applicants</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: array</li><li>Items<div class=\"schema\"><ul><li>Required: no</li><li>additionalProperties: false</li><li> <span id=\"id-2--567263231004598591\">\n <a href=\"#id-2--567263231004598591\" class=\"anchor\">\n <tt>id</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;6e6f5eee-abbe-4ccb-8f12-894842bbe252&quot;</tt></li></ul></div></li><li> <span id=\"email-2--416104501903741859\">\n <a href=\"#email-2--416104501903741859\" class=\"anchor\">\n <tt>email</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;[email protected]&quot;</tt></li></ul></div></li><li> <span id=\"name-2-2797728404326897034\">\n <a href=\"#name-2-2797728404326897034\" class=\"anchor\">\n <tt>name</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;Sammy Bailey&quot;</tt></li></ul></div></li><li> <span id=\"first_name-2-4455355522592130336\">\n <a href=\"#first_name-2-4455355522592130336\" class=\"anchor\">\n <tt>first_name</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;Sammy&quot;</tt></li></ul></div></li><li> <span id=\"last_name-2--4172194588889423664\">\n <a href=\"#last_name-2--4172194588889423664\" class=\"anchor\">\n <tt>last_name</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;Bailey&quot;</tt></li></ul></div></li><li> <span id=\"phone_number-2--1393233283469606888\">\n <a href=\"#phone_number-2--1393233283469606888\" class=\"anchor\">\n <tt>phone_number</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;2363835989&quot;</tt></li></ul></div></li><li> <span id=\"normalized_phone_number-2-1833775094342495715\">\n <a href=\"#normalized_phone_number-2-1833775094342495715\" class=\"anchor\">\n <tt>normalized_phone_number</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;+12363835989&quot;</tt></li></ul></div></li><li> <span id=\"receive_automated_emails-2--4176832304891926828\">\n <a href=\"#receive_automated_emails-2--4176832304891926828\" class=\"anchor\">\n <tt>receive_automated_emails</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: boolean</li><li>Example: <tt>true</tt></li></ul></div></li><li> <span id=\"is_duplicate-2--1951414614342927166\">\n <a href=\"#is_duplicate-2--1951414614342927166\" class=\"anchor\">\n <tt>is_duplicate</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: boolean</li><li>Example: <tt>true</tt></li></ul></div></li><li> <span id=\"data-2-3399301848986046703\">\n <a href=\"#data-2-3399301848986046703\" class=\"anchor\">\n <tt>data</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>additionalProperties: false</li></ul></div></li><li> <span id=\"created_at-2--1325872048428172897\">\n <a href=\"#created_at-2--1325872048428172897\" class=\"anchor\">\n <tt>created_at</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Format: date-time</li><li>Example: <tt>&quot;2015-06-05T05:53:42.752-07:00&quot;</tt></li></ul></div></li><li> <span id=\"updated_at-2-1663458663414710774\">\n <a href=\"#updated_at-2-1663458663414710774\" class=\"anchor\">\n <tt>updated_at</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Format: date-time</li><li>Example: <tt>&quot;2015-06-05T05:54:42.752-07:00&quot;</tt></li></ul></div></li><li> <span id=\"last_transitioned_at-2--829579012148987699\">\n <a href=\"#last_transitioned_at-2--829579012148987699\" class=\"anchor\">\n <tt>last_transitioned_at</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Format: date-time</li><li>Example: <tt>&quot;2015-06-05T05:53:42.752-07:00&quot;</tt></li></ul></div></li><li> <span id=\"funnel-2-4137958799661994875\">\n <a href=\"#funnel-2-4137958799661994875\" class=\"anchor\">\n <tt>funnel</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>additionalProperties: false</li><li> <span id=\"id-3--4230936251174999449\">\n <a href=\"#id-3--4230936251174999449\" class=\"anchor\">\n <tt>id</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;7f88228c-cba9-4827-b71d-e81244c05d37&quot;</tt></li></ul></div></li><li> <span id=\"title-3-2263411278986264746\">\n <a href=\"#title-3-2263411278986264746\" class=\"anchor\">\n <tt>title</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;Legacy Paradigm Executive&quot;</tt></li></ul></div></li><li> <span id=\"custom_id-3-2099753569639815224\">\n <a href=\"#custom_id-3-2099753569639815224\" class=\"anchor\">\n <tt>custom_id</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;3d67750a-dcf4-4ada-a3e4-ee44661949fc&quot;</tt></li></ul></div></li></ul></div></li><li> <span id=\"partner_data-2-2475741669081426983\">\n <a href=\"#partner_data-2-2475741669081426983\" class=\"anchor\">\n <tt>partner_data</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: array</li><li>Items<div class=\"schema\"><ul><li>Required: no</li><li>additionalProperties: false</li><li> <span id=\"description-4--370048440908750890\">\n <a href=\"#description-4--370048440908750890\" class=\"anchor\">\n <tt>description</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;&quot;</tt></li></ul></div></li><li> <span id=\"type-4-3295150059601225184\">\n <a href=\"#type-4-3295150059601225184\" class=\"anchor\">\n <tt>type</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;object&quot;</tt></li></ul></div></li><li> <span id=\"example-4-1333678427311406631\">\n <a href=\"#example-4-1333678427311406631\" class=\"anchor\">\n <tt>example</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: array</li></ul></div></li></ul></div></li></ul></div></li><li> <span id=\"can_receive_sms-2-2150401359249774573\">\n <a href=\"#can_receive_sms-2-2150401359249774573\" class=\"anchor\">\n <tt>can_receive_sms</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: boolean</li><li>Example: <tt>true</tt></li></ul></div></li><li> <span id=\"phone_platform-2-4517043044236504764\">\n <a href=\"#phone_platform-2-4517043044236504764\" class=\"anchor\">\n <tt>phone_platform</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;sms&quot;</tt></li></ul></div></li><li> <span id=\"stage-2--3851817367689253080\">\n <a href=\"#stage-2--3851817367689253080\" class=\"anchor\">\n <tt>stage</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>additionalProperties: false</li><li> <span id=\"id-3--2968721907276373455\">\n <a href=\"#id-3--2968721907276373455\" class=\"anchor\">\n <tt>id</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;4d800504-f786-4f2f-92fe-a127d04d503c&quot;</tt></li></ul></div></li><li> <span id=\"title-3-3835121282188741077\">\n <a href=\"#title-3-3835121282188741077\" class=\"anchor\">\n <tt>title</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;Approved&quot;</tt></li></ul></div></li><li> <span id=\"parent_id-3--1245221587039019340\">\n <a href=\"#parent_id-3--1245221587039019340\" class=\"anchor\">\n <tt>parent_id</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: null</li><li>Example: <tt>&quot;4d800504-f786-4f2f-92fe-a127d04d503c&quot;</tt></li></ul></div></li></ul></div></li><li> <span id=\"background_checks-2-1714160780411725645\">\n <a href=\"#background_checks-2-1714160780411725645\" class=\"anchor\">\n <tt>background_checks</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: array</li><li>Items<div class=\"schema\"><ul><li>Required: no</li><li>additionalProperties: false</li><li> <span id=\"title-4--3916024436433106671\">\n <a href=\"#title-4--3916024436433106671\" class=\"anchor\">\n <tt>title</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;Driver license check&quot;</tt></li></ul></div></li><li> <span id=\"status-4--2030617626797436455\">\n <a href=\"#status-4--2030617626797436455\" class=\"anchor\">\n <tt>status</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;pending&quot;</tt></li></ul></div></li><li> <span id=\"vendor-4-2595644624217468281\">\n <a href=\"#vendor-4-2595644624217468281\" class=\"anchor\">\n <tt>vendor</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;checkr&quot;</tt></li></ul></div></li><li> <span id=\"candidate_id-4-267150060153265828\">\n <a href=\"#candidate_id-4-267150060153265828\" class=\"anchor\">\n <tt>candidate_id</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;e44aa283528e6fde7d542194&quot;</tt></li></ul></div></li><li> <span id=\"report_id-4--143498542645933493\">\n <a href=\"#report_id-4--143498542645933493\" class=\"anchor\">\n <tt>report_id</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;4722c07dd9a10c3985ae432a&quot;</tt></li></ul></div></li><li> <span id=\"applicant_id-4--1831679193835239968\">\n <a href=\"#applicant_id-4--1831679193835239968\" class=\"anchor\">\n <tt>applicant_id</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;989fd339-ce2c-4a38-a86e-ab513239c809&quot;</tt></li></ul></div></li><li> <span id=\"check_id-4-1801195825004314402\">\n <a href=\"#check_id-4-1801195825004314402\" class=\"anchor\">\n <tt>check_id</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;e9837e56-e03f-47e1-9975-149729f0ac1e&quot;</tt></li></ul></div></li></ul></div></li></ul></div></li><li> <span id=\"document_signatures-2-348480225719268001\">\n <a href=\"#document_signatures-2-348480225719268001\" class=\"anchor\">\n <tt>document_signatures</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: array</li><li>Items<div class=\"schema\"><ul><li>Required: no</li><li>additionalProperties: false</li><li> <span id=\"vendor-4-1908910426744758219\">\n <a href=\"#vendor-4-1908910426744758219\" class=\"anchor\">\n <tt>vendor</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;hellosign&quot;</tt></li></ul></div></li><li> <span id=\"signature_id-4--4432508896015772867\">\n <a href=\"#signature_id-4--4432508896015772867\" class=\"anchor\">\n <tt>signature_id</tt>\n </a>\n </span>\n<div class=\"schema\">Vendor-specific signature ID<ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;123dfdsf&quot;</tt></li></ul></div></li><li> <span id=\"status-4-1646879607601482080\">\n <a href=\"#status-4-1646879607601482080\" class=\"anchor\">\n <tt>status</tt>\n </a>\n </span>\n<div class=\"schema\">Status of this request (opened, signed or admin_reviewed)<ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;signed&quot;</tt></li></ul></div></li></ul></div></li></ul></div></li><li> <span id=\"labels-2-4351254104005212615\">\n <a href=\"#labels-2-4351254104005212615\" class=\"anchor\">\n <tt>labels</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: array</li><li>Items<div class=\"schema\"><ul><li>Required: no</li><li>additionalProperties: false</li><li> <span id=\"title-4-547342498908383467\">\n <a href=\"#title-4-547342498908383467\" class=\"anchor\">\n <tt>title</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>&quot;Label-1&quot;</tt></li></ul></div></li><li> <span id=\"completed-4-1878003622276566714\">\n <a href=\"#completed-4-1878003622276566714\" class=\"anchor\">\n <tt>completed</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: boolean</li><li>Example: <tt>false</tt></li></ul></div></li><li> <span id=\"completed_at-4--4382553547684367493\">\n <a href=\"#completed_at-4--4382553547684367493\" class=\"anchor\">\n <tt>completed_at</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;2017-01-01T14:40:30.873-08:00&quot;</tt></li></ul></div></li></ul></div></li></ul></div></li><li> <span id=\"file_upload_requests-2--3829455117098023280\">\n <a href=\"#file_upload_requests-2--3829455117098023280\" class=\"anchor\">\n <tt>file_upload_requests</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: array</li><li>Items<div class=\"schema\">Recollection Requests<ul><li>Required: no</li><li>additionalProperties: false</li><li> <span id=\"id-4--1999380117934272024\">\n <a href=\"#id-4--1999380117934272024\" class=\"anchor\">\n <tt>id</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>55</tt></li></ul></div></li><li> <span id=\"created_at-4-4058606685901728974\">\n <a href=\"#created_at-4-4058606685901728974\" class=\"anchor\">\n <tt>created_at</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;2017-01-01T14:40:30.873-08:00&quot;</tt></li></ul></div></li><li> <span id=\"recollection_reason-4-2254135842697829218\">\n <a href=\"#recollection_reason-4-2254135842697829218\" class=\"anchor\">\n <tt>recollection_reason</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;blurry&quot;</tt></li></ul></div></li><li> <span id=\"document_name-4--320640853011432200\">\n <a href=\"#document_name-4--320640853011432200\" class=\"anchor\">\n <tt>document_name</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;driver_license&quot;</tt></li></ul></div></li></ul></div></li></ul></div></li><li> <span id=\"addresses-2-2857022521695061189\">\n <a href=\"#addresses-2-2857022521695061189\" class=\"anchor\">\n <tt>addresses</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: array</li><li>Items<div class=\"schema\">Applicant Addresses<ul><li>Required: no</li><li>additionalProperties: false</li><li> <span id=\"street_name-4--3975396091286181444\">\n <a href=\"#street_name-4--3975396091286181444\" class=\"anchor\">\n <tt>street_name</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;11718 Selkirk Drive&quot;</tt></li></ul></div></li><li> <span id=\"address_2-4--2052756538671985203\">\n <a href=\"#address_2-4--2052756538671985203\" class=\"anchor\">\n <tt>address_2</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;Apartment 101&quot;</tt></li></ul></div></li><li> <span id=\"city-4--660438396307906583\">\n <a href=\"#city-4--660438396307906583\" class=\"anchor\">\n <tt>city</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;Austin&quot;</tt></li></ul></div></li><li> <span id=\"state-4-426270196406270049\">\n <a href=\"#state-4-426270196406270049\" class=\"anchor\">\n <tt>state</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;Texas&quot;</tt></li></ul></div></li><li> <span id=\"zipcode-4--2815293401253663496\">\n <a href=\"#zipcode-4--2815293401253663496\" class=\"anchor\">\n <tt>zipcode</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>78756</tt></li></ul></div></li><li> <span id=\"country-4-620378981484023606\">\n <a href=\"#country-4-620378981484023606\" class=\"anchor\">\n <tt>country</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;US&quot;</tt></li></ul></div></li><li> <span id=\"latitude-4--4065652295766585071\">\n <a href=\"#latitude-4--4065652295766585071\" class=\"anchor\">\n <tt>latitude</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: number</li><li>Example: <tt>60</tt></li></ul></div></li><li> <span id=\"longitude-4-3909648517730512847\">\n <a href=\"#longitude-4-3909648517730512847\" class=\"anchor\">\n <tt>longitude</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: number</li><li>Example: <tt>128</tt></li></ul></div></li></ul></div></li></ul></div></li></ul></div></li></ul></div></li><li> <span id=\"pagination-0--3081964322725990309\">\n <a href=\"#pagination-0--3081964322725990309\" class=\"anchor\">\n <tt>pagination</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>additionalProperties: false</li><li> <span id=\"first-1-1339174693238793858\">\n <a href=\"#first-1-1339174693238793858\" class=\"anchor\">\n <tt>first</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: integer</li><li>Example: <tt>1</tt></li></ul></div></li><li> <span id=\"previous-1--2213323195423858537\">\n <a href=\"#previous-1--2213323195423858537\" class=\"anchor\">\n <tt>previous</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: null</li><li>Example: <tt>&quot;&quot;</tt></li></ul></div></li><li> <span id=\"current-1--3582970624478534904\">\n <a href=\"#current-1--3582970624478534904\" class=\"anchor\">\n <tt>current</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: integer</li><li>Example: <tt>1</tt></li></ul></div></li><li> <span id=\"next-1--1585241688227279447\">\n <a href=\"#next-1--1585241688227279447\" class=\"anchor\">\n <tt>next</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: null</li><li>Example: <tt>&quot;&quot;</tt></li></ul></div></li><li> <span id=\"last-1--3350574067278197775\">\n <a href=\"#last-1--3350574067278197775\" class=\"anchor\">\n <tt>last</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: integer</li><li>Example: <tt>1</tt></li></ul></div></li><li> <span id=\"current_cursor-1-2823477291932688059\">\n <a href=\"#current_cursor-1-2823477291932688059\" class=\"anchor\">\n <tt>current_cursor</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;dEZTT29oa0VtbUtsYzIySy9aNGlEUT09LS1HbTR6di9vQ2swNE9jOVdxRENYSjJ3PT0=--900ac1352e2a3e86bda4387d9cb177563bf4c9da&quot;</tt></li></ul></div></li><li> <span id=\"next_cursor-1-3935109769947710395\">\n <a href=\"#next_cursor-1-3935109769947710395\" class=\"anchor\">\n <tt>next_cursor</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>&quot;cnNwcWJ4VWp1T0Y5eFZWSGIvUmZjdz09LS14Z1RZbGlCdmNRdHNJMEhocGl5aDF3PT0=--d9e7bac1b041fa318b452d0be88a4f04b1194052&quot;</tt></li></ul></div></li></ul></div></li></ul></div>" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}