List All Applicants

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.

🚧

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.

Response Schema

  • additionalProperties: false
  • applicants
    • Required: yes
    • Type: array
    • Items
      • Required: no
      • additionalProperties: false
      • id
        • Required: yes
        • Type: string
        • Example: "6e6f5eee-abbe-4ccb-8f12-894842bbe252"
      • email
      • name
        • Required: yes
        • Type: string
        • Example: "Sammy Bailey"
      • first_name
        • Required: yes
        • Type: string
        • Example: "Sammy"
      • last_name
        • Required: yes
        • Type: string
        • Example: "Bailey"
      • phone_number
        • Required: yes
        • Type: string
        • Example: "2363835989"
      • normalized_phone_number
        • Required: yes
        • Type: string
        • Example: "+12363835989"
      • receive_automated_emails
        • Required: yes
        • Type: boolean
        • Example: true
      • is_duplicate
        • Required: no
        • Type: boolean
        • Example: true
      • data
        • Required: yes
        • additionalProperties: false
      • created_at
        • Required: yes
        • Type: string
        • Format: date-time
        • Example: "2015-06-05T05:53:42.752-07:00"
      • updated_at
        • Required: yes
        • Type: string
        • Format: date-time
        • Example: "2015-06-05T05:54:42.752-07:00"
      • last_transitioned_at
        • Required: yes
        • Type: string
        • Format: date-time
        • Example: "2015-06-05T05:53:42.752-07:00"
      • funnel
        • Required: yes
        • additionalProperties: false
        • id
          • Required: yes
          • Type: string
          • Example: "7f88228c-cba9-4827-b71d-e81244c05d37"
        • title
          • Required: yes
          • Type: string
          • Example: "Legacy Paradigm Executive"
        • custom_id
          • Required: yes
          • Type: string
          • Example: "3d67750a-dcf4-4ada-a3e4-ee44661949fc"
      • partner_data
        • Required: yes
        • Type: array
        • Items
          • Required: no
          • additionalProperties: false
          • description
            • Required: no
            • Type: string
            • Example: ""
          • type
            • Required: no
            • Type: string
            • Example: "object"
          • example
            • Required: no
            • Type: array
      • can_receive_sms
        • Required: yes
        • Type: boolean
        • Example: true
      • phone_platform
        • Required: yes
        • Type: string
        • Example: "sms"
      • stage
        • Required: yes
        • additionalProperties: false
        • id
          • Required: yes
          • Type: string
          • Example: "4d800504-f786-4f2f-92fe-a127d04d503c"
        • title
          • Required: yes
          • Type: string
          • Example: "Approved"
        • parent_id
          • Required: no
          • Type: null
          • Example: "4d800504-f786-4f2f-92fe-a127d04d503c"
      • background_checks
        • Required: yes
        • Type: array
        • Items
          • Required: no
          • additionalProperties: false
          • title
            • Required: yes
            • Type: string
            • Example: "Driver license check"
          • status
            • Required: yes
            • Type: string
            • Example: "pending"
          • vendor
            • Required: yes
            • Type: string
            • Example: "checkr"
          • candidate_id
            • Required: no
            • Type: string
            • Example: "e44aa283528e6fde7d542194"
          • report_id
            • Required: no
            • Type: string
            • Example: "4722c07dd9a10c3985ae432a"
          • applicant_id
            • Required: no
            • Type: string
            • Example: "989fd339-ce2c-4a38-a86e-ab513239c809"
          • check_id
            • Required: no
            • Type: string
            • Example: "e9837e56-e03f-47e1-9975-149729f0ac1e"
      • document_signatures
        • Required: yes
        • Type: array
        • Items
          • Required: no
          • additionalProperties: false
          • vendor
            • Required: yes
            • Type: string
            • Example: "hellosign"
          • signature_id
            Vendor-specific signature ID
            • Required: yes
            • Type: string
            • Example: "123dfdsf"
          • status
            Status of this request (opened, signed or admin_reviewed)
            • Required: yes
            • Type: string
            • Example: "signed"
      • labels
        • Required: yes
        • Type: array
        • Items
          • Required: no
          • additionalProperties: false
          • title
            • Required: yes
            • Type: string
            • Example: "Label-1"
          • completed
            • Required: yes
            • Type: boolean
            • Example: false
          • completed_at
            • Required: no
            • Type: string
            • Example: "2017-01-01T14:40:30.873-08:00"
      • file_upload_requests
        • Required: no
        • Type: array
        • Items
          Recollection Requests
          • Required: no
          • additionalProperties: false
          • id
            • Required: no
            • Type: string
            • Example: 55
          • created_at
            • Required: no
            • Type: string
            • Example: "2017-01-01T14:40:30.873-08:00"
          • recollection_reason
            • Required: no
            • Type: string
            • Example: "blurry"
          • document_name
            • Required: no
            • Type: string
            • Example: "driver_license"
      • addresses
        • Required: no
        • Type: array
        • Items
          Applicant Addresses
          • Required: no
          • additionalProperties: false
          • street_name
            • Required: no
            • Type: string
            • Example: "11718 Selkirk Drive"
          • address_2
            • Required: no
            • Type: string
            • Example: "Apartment 101"
          • city
            • Required: no
            • Type: string
            • Example: "Austin"
          • state
            • Required: no
            • Type: string
            • Example: "Texas"
          • zipcode
            • Required: no
            • Type: string
            • Example: 78756
          • country
            • Required: no
            • Type: string
            • Example: "US"
          • latitude
            • Required: no
            • Type: number
            • Example: 60
          • longitude
            • Required: no
            • Type: number
            • Example: 128
  • pagination
    • Required: yes
    • additionalProperties: false
    • 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: "cnNwcWJ4VWp1T0Y5eFZWSGIvUmZjdz09LS14Z1RZbGlCdmNRdHNJMEhocGl5aDF3PT0=--d9e7bac1b041fa318b452d0be88a4f04b1194052"
Language
Click Try It! to start a request and see the response here!