Docs / Get started

Quickstart

Provision an organization workspace, review the configurable defaults that are seeded for you, and take one applicant from intake to a live pipeline card.

4 min read·Last updated October 20, 2026

A new workspace is not an empty one. Provisioning seeds stages, document types, checklist items, the fee catalog and a set of automation rules so the first applicant you enter already has a pipeline to move through. Review these editable, organization-specific defaults against your own recruitment process and applicable requirements before using them.

Create the workspace#

Signing up creates the organization and its first OWNER user in one step. The owner is the only role with access to the subscription.

1. 1

   Provide the agency details

   Agency name, the owner name and email, and a password. The API validates the password against a policy and returns fieldErrors.password describing anything missing rather than a generic rejection.

2. 2

   Accept the terms

   acceptTerms must be literally true. The request is rejected outright otherwise — this is a consent record, not a checkbox.

3. 3

   Verify the owner email

   Request a six-digit code through /v1/auth/email-verification/request, verify it through /v1/auth/email-verification/verify, and include the returned verificationToken when creating the workspace. The proof is one-time and bound to the owner email.

4. 4

   Sign in on the staff surface

   Log in with surface: "STAFF". The same email address can exist independently on the applicant and employer surfaces, so the surface is part of the identity, not a preference.

curl -X POST "$API_URL/v1/auth/signup" \
  -H "Content-Type: application/json" \
  -d '{
    "agencyName": "Pacific Crest Manpower Services",
    "ownerName": "Ana Reyes",
    "ownerEmail": "ana@pacificcrest.ph",
    "contactPhone": "+63285551234",
    "password": "...",
    "confirmPassword": "...",
    "acceptTerms": true,
    "verificationToken": "<proof returned after verifying the email code>"
  }'

# 201 { "ok": true, "data": { "slug": "pacific-crest-manpower-services" } }

What gets seeded#

Provisioning runs seedOrganizationDefaults, which is idempotent — running it again will not duplicate rows. Every item below belongs to your organization alone.

Set the organization record#

Review the organization settings before your first intake, including scheduling, currency and presentation.

timezone

Defaults to Asia/Manila. Every scheduled sweep runs in this timezone, so a wrong value shifts your expiry scans and morning digest.

currency

Defaults to PHP. Worker charges are posted in it; employer-billable fee items are seeded in USD independently.

brandColor and careersIntro

Presentation for the published job board. They do not affect the pipeline.

Take one applicant through#

The fastest way to understand the model is to walk one person through the first few stages and watch the gate refuse you.

1. 1

   Create the applicant

   Applicants → Add applicant. First and last name plus either a mobile number or an email. Data privacy consent is recorded at creation and cannot be skipped. See Applicants.

2. 2

   Endorse them to a position

   An applicant on their own has no stage. Creating an application against a JobOrderPosition is what puts a card on the board at the LEAD stage. See Core concepts.

3. 3

   Try to move it to Screening

   Screening requires a contact number on file and a verified résumé. If the résumé is not uploaded and verified, the move is refused with 409 GATE_BLOCKED and the exact unmet requirements. That refusal is the product working.

4. 4

   Upload and verify the résumé

   Upload it on the applicant, then verify it in the Documents queue. A document only satisfies a requirement once its status is VERIFIED — and, if the type tracks expiry, only while it is unexpired.

5. 5

   Watch it advance

   When the last requirement on the immediate next stage is satisfied, the application advances on its own and the move is recorded as application.stage_advanced. See Stage gates.

Getting the rest of the team in#

Where to go next#