Skip to main content
POST
/
external
/
v1
/
application
/
create
Create Application
curl --request POST \
  --url https://api.example.com/external/v1/application/create/

Create Application

Create a new application by submitting candidate information to a hiring flow.

Endpoint

POST /external/v1/application/create/

Authentication

Requires API key authentication via Bearer token.

Request Body

FieldTypeRequiredDescription
hiring_flow_idstring (UUID)YesID of the hiring flow to apply to
emailstringYesCandidate’s email address
first_namestringYesCandidate’s first name
last_namestringYesCandidate’s last name
phonestringNoCandidate’s phone number
sourcestringNoApplication source (e.g., “website”, “linkedin”)
custom_fieldsobjectNoAdditional field values keyed by form element ID

Example Request

curl -X POST "https://your-instance.firstwork.com/external/v1/application/create/" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "hiring_flow_id": "550e8400-e29b-41d4-a716-446655440000",
    "email": "john.doe@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "phone": "+1234567890",
    "source": "linkedin",
    "custom_fields": {
      "years_of_experience": "5",
      "preferred_location": "San Francisco"
    }
  }'

Example Response

{
  "status": "success",
  "data": {
    "application_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "candidate_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "hiring_flow_id": "550e8400-e29b-41d4-a716-446655440000",
    "stage": "Application Received",
    "status": "NEW",
    "created_at": "2025-01-15T10:30:00Z"
  }
}

Error Responses

CodeDescription
400Invalid request body or missing required fields
401Invalid API key
404Hiring flow not found
409Duplicate application (candidate already applied)

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