Applicants

List of valid attributes:

Attribute	Description	Specifics
application_stage_id	ID of the application stage the applicant belongs to	Cannot be set
created_at	Timestamp when the applicant was created	Cannot be set
email	Email address of the applicant	Must be set
name	Name of the applicant	Must be set

The following relationships can be included in requests:

Relationship	Type
job_posting	belongs_to

List

Example response:

{
  "data": [
    {
      "id": "1e9f83a6-51a7-445a-bd6e-5e0350f24c93",
      "type": "applicant",
      "attributes": {
        "application_stage_id": "459e0b1e-caa0-4960-be61-dad0dbcd969e",
        "created_at": "2023-10-15T10:30:00Z",
        "email": "[email protected]",
        "name": "John Doe"
      }
    }
    // ...
  ]
}

This endpoint returns all applicants for the current account.

HTTP Request

GET /api/v1/applicants

Create applicant (public endpoint)

Example request:

{
  "data": {
    "type": "applicant",
    "attributes": {
      "name": "John Doe",
      "email": "[email protected]",
      "job_posting_id": "1e9f83a6-51a7-445a-bd6e-5e0350f24c93"
    }
  }
}

Example response:

{
  "data": {
    "id": "1e9f83a6-51a7-445a-bd6e-5e0350f24c93",
    "type": "applicant",
    "meta": {}
  }
}

This endpoint creates an applicant for a published job posting. The applicant will be automatically assigned to the first application stage of the job posting’s account.

HTTP Request

POST /public/v1/applicants

Request Parameters

Parameter	Description	Required
name	Full name of the applicant	Yes
email	Email address of the applicant	Yes
job_posting_id	The id of the job posting to apply to	Yes

Notes

• The job posting must be active
• Each email can only apply once per job posting
• The applicant will be assigned to the first application stage automatically
• If any validation fails, an empty 422 response will be returned