Create Application
curl --request POST \
--url https://api.example.com/external/v1/application/create/import requests
url = "https://api.example.com/external/v1/application/create/"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/external/v1/application/create/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/external/v1/application/create/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/external/v1/application/create/"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/external/v1/application/create/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/external/v1/application/create/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyCreate Application
Create a new application for a candidate in a hiring flow
POST
/
external
/
v1
/
application
/
create
/
Create Application
curl --request POST \
--url https://api.example.com/external/v1/application/create/import requests
url = "https://api.example.com/external/v1/application/create/"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/external/v1/application/create/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/external/v1/application/create/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/external/v1/application/create/"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/external/v1/application/create/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/external/v1/application/create/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyCreate Application
Sign up a candidate for an application by providing their email, phone number, name, and hiring flow ID.Endpoint
POST /external/v1/application/create/
Authentication
[!NOTE] Requires a valid company API key in theAuthorizationheader (format:Api-Key <key>).
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
email | string | Yes | The email address of the user |
hiring_flow_id | string (UUID) | Yes | The ID of the hiring flow |
phone_number | string | Yes | The phone number of the user |
name | string | No | Full name of the user (optional if first_name and last_name are provided) |
first_name | string | No | First name of the user (optional if name is provided) |
last_name | string | No | Last name of the user (optional if name is provided) |
Example Request
curl -X POST "https://api.firstwork.com/external/v1/application/create/" \
-H "Authorization: Api-Key YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"hiring_flow_id": "550e8400-e29b-41d4-a716-446655440000",
"email": "john.doe@example.com",
"phone_number": "+1234567890",
"first_name": "John",
"last_name": "Doe"
}'
Responses
201: Created
Successfully signed up for the application. Returns the application object.400: Bad Request
Invalid request body, missing required fields, or invalid hiring flow ID.Notes
- If the candidate email already exists in the system, the application is linked to the existing user
- If the candidate is new, a user account is automatically created
- The application starts at the first stage of the hiring flow
- Any configured automations for the first stage will trigger