API Reference

Configuration

Manage client-specific settings including mandatory profile fields that determine what information is required before submitting applications.

Get Mandatory Fields

Retrieve your client's current mandatory field configuration. These fields must be present in a candidate profile before applications can be submitted.

GET/config/mandatory-fields
Response200 OK
{
  "clientId": "client_xyz789",
  "mandatoryFields": [
    "personalInformation.email",
    "personalInformation.phone",
    "workExperience",
    "resumeUrl"
  ],
  "updatedAt": "2024-01-10T08:00:00Z"
}

Update Mandatory Fields

Update which fields are required for complete candidate profiles. Applications will fail if a profile is missing any mandatory field.

Available fields: personalInformation.firstName, .lastName, .email, .countryCode, .phoneNumber, .gender, .address, .city, .state, .zipCode, .country, .citizenship, workExperience, education, skills, languages, certifications, achievements, miscellaneous, resumeUrl
PUT/config/mandatory-fields
curl -X PUT https://apply-api.boringproject.ai/api/v1/config/mandatory-fields \
  -H "Authorization: Bearer bp_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "mandatoryFields": [
      "personalInformation.email",
      "personalInformation.phone",
      "personalInformation.firstName",
      "personalInformation.lastName",
      "workExperience",
      "education",
      "resumeUrl"
    ]
  }'

Related docs

Continue reading

Candidate Profiles

Manage candidate profiles containing personal information, work experience, education, skills, languages, certifications, achievements, miscellaneous details, and resumes.

Users

Create, retrieve, update, and delete users who apply for jobs through your platform.

Error Handling

Understand the API error format, HTTP status codes, error code categories, and best practices for handling errors.