Developer Portal

Quickstart

Trigger your first website audit in three steps.

  1. 1

    Create an API key

    Head to your dashboard and generate an efk_ key. Keys are shown once — save it as an environment variable.

    Create API key
  2. 2

    Set your environment variable

    export EMPLOYEEFORGE_API_KEY="efk_your_key_here"
  3. 3

    Queue your first audit

    curl -X POST "https://employeeforge.com/api/public/v1/audits" \
  -H "Authorization: Bearer $EMPLOYEEFORGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","label":"Marketing site"}'
Next steps