Skip to content

Architecture

JSON Data

Embedded demo collections and reset behavior.

Buyer documentation is provided in English.

Collections

  • organizations
  • users
  • jobs
  • candidates
  • resumes
  • screenings
  • candidate_analyses
  • plans
  • subscriptions
  • usage_records
  • api_keys

Document fields

Fixture documents use the same snake_case fields consumed by the portal. Handlers hide internal hashes and map fixture _id values to API id values.

FieldTypeDescription
created_atRFC3339 stringWhen the document was created
created_bystring idWho created it
updated_atRFC3339 stringLast modification
updated_bystring idWho last modified it
deleted_atstring, optionalSet when removed during the current process
deleted_bystring, optionalWho removed it

Reset behavior

bash
# Restart the API to restore the embedded fixture state
cd portal-api/lite
make run
Use FIXTURES_PATH only for private local overrides. That directory is gitignored and must never contain customer or production exports in the distributed package.