| Time | Status | User Agent |  |
| :-- | :-- | :-- | :-- |
| Make a request to see history. |

#### URL Expired

The URL for this request expired after 30 days.

# 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  
Together with `updated_at`, you can also use `created_at` or `last_transitioned_at`, or any combination of those. When using multiple conditions, an “OR” filter is used and applicants must match all date parameters to be returned. Dates need to be in ISO8601 format, and the timezone is UTC. For example: `?created_at=2016-12-23&last_transitioned_at=2017-01-06`, or using ranges: `?created_at[gt]=2017-04-14T10:00:00&created_at[lt]=2017-04-17T14:00:00`.

## Phone number  
You can filter applicants by phone number using the `phone` parameter. The search supports various phone number formats and performs partial matching, allowing you to search for applicants using:

- Full phone numbers: `?phone=+15551234567`
- Phone numbers without country code: `?phone=5551234567`
- Formatted phone numbers: `?phone=(555) 123-4567`
- Partial phone numbers: `?phone=555123`

## 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.

> 🚧
> ### Labels must be URL encoded  
> 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`.

funnel_id

string

location_id

string

stage_id

string

stage

string

labels

string

cursor

string

created_at

string

last_transitioned_at

string

updated_at

string

phone

string

Filter applicants by phone number

exclude_temporary

boolean

truefalse

per_page

integer

Number of results per page

custom_data_field[key]

string

The key of the custom data field to filter by. Used with `custom_data_field[value]`. Must also use one of created_at, last_transitioned_at, updated_at, stage_id, or funnel_id. Does not support secure fields or standard questions.

custom_data_field[value]

string

The value of the custom data field to filter by. Used with `custom_data_field[key]`.

include_subaccounts

boolean

Whether to include applicants from sub-accounts (defaults to false)

truefalse

# ``200      OK

# ``401      Unauthorized

Updated3 months ago

* * *

ShellNodeRubyPHPPython

```

xxxxxxxxxx

curl --request GET \

--url https://api.fountain.com/v2/applicants \

--header 'accept: application/json'
```

Click `Try It!` to start a request and see the response here! Or choose an example:

application/json

``200``401

Updated3 months ago

* * *