Connecting a Custom Form

Several clients host their hiring page on their primary website and forward applicants into the Fountain Hire portal. Use Create an Applicant to make a POST request. The response identifies the applicant in its id field. Keep this API call server-side so Fountain credentials are never exposed through browser code.

Obtain ACCESS_TOKEN through the Fountain One OAuth flow with the employer scope. Replace the example funnel_id with the opening's UUID.

POST Create an Applicant Request

curl -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer ACCESS_TOKEN' -d '{"funnel_id":"de79f80f-43da-4e4c-87d6-9bf714753535","name":"John","email":"[email protected]","phone_number":"5034834844","data":{"city":"San Francisco","transportation":"Bicycle"}}' 'https://services.fountain.com/api/servicehire/v2/applicants'

After processing the POST request, Fountain returns your new applicant's data. This example shows selected response fields.

Response

{
  "id": "e8e4edc5-096c-47ea-b682-f77c6c4462dd",
  "email": "[email protected]",
  "name": "John",
  "phone_number": "5034834844",
  "data": {
    "city": "San Francisco",
    "transportation": "Bicycle"
  },
  "created_at": "2015-06-05T05:53:46.749-07:00",
  "funnel": {
    "id": "de79f80f-43da-4e4c-87d6-9bf714753535",
    "title": "San Francisco Bicycles"
  },
  "stage": {
    "id": "4d09fca4-6599-4418-b385-6cf173e01b66",
    "title": "Phone Screen"
  },
  "background_checks": [],
  "document_signatures": [],
  "labels": [],
  "portal_url": "https://fountain.com/apply/example/e8e4edc5-096c-47ea-b682-f77c6c4462dd"
}

The portal_url response field contains the URL to continue the application. Redirect the applicant to that URL. The applicant's workflow and eligibility filters determine the next steps and messaging.

📘

Note: UTM Tracking

Pass the desired UTM fields, such as utm_source, along with the rest of the applicant's data.