v1

latestOpenAPI 3.0.12026-07-245752052.0 MB

Applicants

exposeAsMcpTool

List All Applicants

Get all applicants

get/v2/applicants

Query parameters

funnel_idstring

location_idstring

stage_idstring

stagestring

labelsstring

cursorstring

created_atstring

last_transitioned_atstring

updated_atstring

phonestring

Filter applicants by phone number

exclude_temporaryboolean

per_pageinteger

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_subaccountsboolean

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

Response

Example response

{
  "applicants": [
    {
      "id": "6e6f5eee-abbe-4ccb-8f12-894842bbe252",
      "email": "example@applicant.com",
      "key": "341347c8230aaa9c",
      "name": "Michael Jordan",
      "first_name": "Michael",
      "last_name": "Jordan",
      "phone_number": "214-609-0494",
      "normalized_phone_number": "+12146090494",
      "phone_number_country_code": "+1",
      "created_at": "2024-01-10T05:19:37.788-08:00",
      "updated_at": "2024-01-10T05:19:37.293-08:00",
      "receive_automated_emails": true,
      "referral_id": "1234",
      "wx_external_id": "7763842e-a7e1-41c5-9f04-0f8d17de3810",
      "labels": [
        {
          "title": "Completed Survey",
          "completed": true,
          "completed_at": "2023-09-21T17:00:00.000-07:00"
        }
      ],
      "duplicate_id": "da7a7590-e643-013d-667b-72996a94b79d",
      "file_upload_requests": [
        {
          "id": 1,
          "created_at": "2024-01-10T05:19:37.788-08:00",
          "document_name": "Drivers License."
        }
      ],
      "i9_status": {
        "last_form_update": "2024-01-10T05:19:37.788-08:00",
        "landed_at": "2024-01-10T05:19:37.788-08:00"
      },
      "last_transitioned_at": "2024-01-10T05:19:37.788-08:00",
      "timezone": "America/Chicago",
      "document_signatures": [
        {
          "signature_id": "91990715d51488bdd1e184b83828db8a"
        }
      ],
      "funnel": {
        "opening_pay_rate": {
          "compensation": "20.0"
        }
      },
      "stage": {
        "id": "ad1465d6-35b1-4e86-934e-a31af0d14020",
        "title": "Data Collection Stage"
      },
      "assessments": [
        {
          "id": "ad1465d6-35b1-4e86-934e-a31af0d14020",
          "completed_at": "2024-09-17T07:08:18.996-07:00",
          "score": 2,
          "status": "complete",
          "system_type": "boolean",
          "title": "An assessment"
        }
      ]
    }
  ]
}