{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/applicants","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X GET -d 'api_token=secret-api-token&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/?api_token=secret-api-token","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      \"phone_number\": \"2363835989\",\n      \"data\": {},\n      \"created_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      \"stage\": {\n        \"id\": \"4d800504-f786-4f2f-92fe-a127d04d503c\",\n        \"title\": \"Approved\"\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        }\n      ],\n      \"document_signatures\": [\n        {\n          \"vendor\": \"hellosign\",\n          \"signature_id\": \"123dfdsf\",\n          \"status\": \"signed\",\n          \"file_url\": \"https://fountain-uploads.s3-us-west-1.amazonaws.com/uploads/embedded_signature_request/file/1829581/signature-5e8375d9c311149656e1a12bbb01ab54bbfc22a920191119-3-2miij8.pdf?X-Amz-Expires=172800&X-Amz-Date=20191119T184321Z&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJQOABKUE66R2SJPQ/20191119/us-west-1/s3/aws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=bce8cd4b381bd79000452b8eff2cbc2277c59136c7a6faa0b5f43aeda0\"\n        }\n      ],\n      \"labels\": [\n        {\n          \"title\": \"Label-1\",\n          \"completed\": false\n        }\n      ],\n      \"score_cards_results\": [\n        {\n          \"score\": \"\",\n          \"created_at\": \"\",\n          \"user\": {\n            \"id\": \"\",\n            \"name\": \"\",\n            \"email\": \"\"\n          },\n          \"template\": {\n            \"name\": \"\",\n            \"weighted\": \"\"\n          },\n          \"answers\": [\n            {\n              \"score\": \"\",\n              \"note\": \"\",\n              \"question\": {\n                \"text\": \"\",\n                \"weight\": \"\"\n              }\n            }\n          ]\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":"api_token","type":"string","default":"secret-api-token","desc":"API Token (not required if api_token is passed in header)","required":true,"in":"query","ref":"","_id":"56c66c6b916c9717008052b9"},{"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"}]},"next":{"description":"","pages":[]},"title":"List 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\n*   applicants\n    *   Required: no\n    *   Type: array\n    *   Items\n        *   Required: no\n        *   id\n            *   Required: no\n            *   Type: string\n            *   Example: \"6e6f5eee-abbe-4ccb-8f12-894842bbe252\"\n        *   email\n            *   Required: no\n            *   Type: string\n            *   Example: \"[email protected]\"\n        *   name\n            *   Required: no\n            *   Type: string\n            *   Example: \"Sammy Bailey\"\n        *   phone_number\n            *   Required: no\n            *   Type: string\n            *   Example: \"2363835989\"\n        *   data\n            *   Required: no\n        *   created_at\n            *   Required: no\n            *   Type: string\n            *   Format: date-time\n            *   Example: \"2015-06-05T05:53:42.752-07:00\"\n        *   funnel\n            *   Required: no\n            *   id\n                *   Required: no\n                *   Type: string\n                *   Example: \"7f88228c-cba9-4827-b71d-e81244c05d37\"\n            *   title\n                *   Required: no\n                *   Type: string\n                *   Example: \"Legacy Paradigm Executive\"\n        *   stage\n            *   Required: no\n            *   id\n                *   Required: no\n                *   Type: string\n                *   Example: \"4d800504-f786-4f2f-92fe-a127d04d503c\"\n            *   title\n                *   Required: no\n                *   Type: string\n                *   Example: \"Approved\"\n        *   background_checks\n            *   Required: no\n            *   Type: array\n            *   Items\n                *   Required: no\n                *   title\n                    *   Required: no\n                    *   Type: string\n                    *   Example: \"Driver license check\"\n                *   status\n                    *   Required: no\n                    *   Type: string\n                    *   Example: \"pending\"\n                *   vendor\n                    *   Required: no\n                    *   Type: string\n                    *   Example: \"checkr\"\n                *   candidate_id\n                    *   Required: no\n                    *   Type: string\n                    *   Example: \"e44aa283528e6fde7d542194\"\n                *   report_id\n                    *   Required: no\n                    *   Type: string\n                    *   Example: \"4722c07dd9a10c3985ae432a\"\n        *   document_signatures\n            *   Required: no\n            *   Type: array\n            *   Items\n                *   Required: no\n                *   vendor\n                    *   Required: no\n                    *   Type: string\n                    *   Example: \"hellosign\"\n                *   signature_id\n                    Vendor-specific signature ID\n                    *   Required: no\n                    *   Type: string\n                    *   Example: \"123dfdsf\"\n                *   status\n                    Status of this request (opened, signed or admin_reviewed)\n                    *   Required: no\n                    *   Type: string\n                    *   Example: \"signed\"\n        *   labels\n            *   Required: no\n            *   Type: array\n            *   Items\n                *   Required: no\n                *   title\n                    *   Required: no\n                    *   Type: string\n                    *   Example: \"Label-1\"\n                *   completed\n                    *   Required: no\n                    *   Type: boolean\n                    *   Example: false\n*   pagination\n    *   Required: no\n    *   first\n        *   Required: no\n        *   Type: integer\n        *   Example: 1\n    *   previous\n        *   Required: no\n        *   Type: null\n        *   Example: \"\"\n    *   current\n        *   Required: no\n        *   Type: integer\n        *   Example: 1\n    *   next\n        *   Required: no\n        *   Type: null\n        *   Example: \"\"\n    *   last\n        *   Required: no\n        *   Type: integer\n        *   Example: 1\n    *   current_cursor\n        *   Required: no\n        *   Type: string\n        *   Example: \"dEZTT29oa0VtbUtsYzIySy9aNGlEUT09LS1HbTR6di9vQ2swNE9jOVdxRENYSjJ3PT0=--900ac1352e2a3e86bda4387d9cb177563bf4c9da\"\n    *   next_cursor\n        *   Required: no\n        *   Type: string\n        *   Example: \"dEZTT29oa0VtbUtsYzIySy9aNGlEUT09LS1HbTR6di9vQ2swNE9jOVdxRENYSjJ3PT0=--900ac1352e2a3e86bda4387d9cb177563bf4c9da\"","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":29,"project":"59de6011debd1200240f68ec","createdAt":"2016-02-19T01:14:19.890Z","githubsync":""}

getList Applicants


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

api_token:
required
stringsecret-api-token
API Token (not required if api_token is passed in header)
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

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 * applicants * Required: no * Type: array * Items * Required: no * id * Required: no * Type: string * Example: "6e6f5eee-abbe-4ccb-8f12-894842bbe252" * email * Required: no * Type: string * Example: "[email protected]" * name * Required: no * Type: string * Example: "Sammy Bailey" * phone_number * Required: no * Type: string * Example: "2363835989" * data * Required: no * created_at * Required: no * Type: string * Format: date-time * Example: "2015-06-05T05:53:42.752-07:00" * funnel * Required: no * id * Required: no * Type: string * Example: "7f88228c-cba9-4827-b71d-e81244c05d37" * title * Required: no * Type: string * Example: "Legacy Paradigm Executive" * stage * Required: no * id * Required: no * Type: string * Example: "4d800504-f786-4f2f-92fe-a127d04d503c" * title * Required: no * Type: string * Example: "Approved" * background_checks * Required: no * Type: array * Items * Required: no * title * Required: no * Type: string * Example: "Driver license check" * status * Required: no * Type: string * Example: "pending" * vendor * Required: no * Type: string * Example: "checkr" * candidate_id * Required: no * Type: string * Example: "e44aa283528e6fde7d542194" * report_id * Required: no * Type: string * Example: "4722c07dd9a10c3985ae432a" * document_signatures * Required: no * Type: array * Items * Required: no * vendor * Required: no * Type: string * Example: "hellosign" * signature_id Vendor-specific signature ID * Required: no * Type: string * Example: "123dfdsf" * status Status of this request (opened, signed or admin_reviewed) * Required: no * Type: string * Example: "signed" * labels * Required: no * Type: array * Items * Required: no * title * Required: no * Type: string * Example: "Label-1" * completed * Required: no * Type: boolean * Example: false * pagination * Required: no * first * Required: no * Type: integer * Example: 1 * previous * Required: no * Type: null * Example: "" * current * Required: no * Type: integer * Example: 1 * next * Required: no * Type: null * Example: "" * last * Required: no * Type: integer * Example: 1 * current_cursor * Required: no * Type: string * Example: "dEZTT29oa0VtbUtsYzIySy9aNGlEUT09LS1HbTR6di9vQ2swNE9jOVdxRENYSjJ3PT0=--900ac1352e2a3e86bda4387d9cb177563bf4c9da" * next_cursor * Required: no * Type: string * Example: "dEZTT29oa0VtbUtsYzIySy9aNGlEUT09LS1HbTR6di9vQ2swNE9jOVdxRENYSjJ3PT0=--900ac1352e2a3e86bda4387d9cb177563bf4c9da"

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 }}