SmengoAPI

API overview

The Smengo API gives programmatic access to your organization's data — employees, departments, the schedule, and other platform resources. It's meant for integrations, BI exports, and automated syncing with external systems, without manually exporting from the UI.

How the API works

The API runs over HTTPS and is versioned in the path: the base URL is https://smengo.com/api/v1. Breaking changes will ship as /api/v2, not as changes to the current version — so existing integrations won't break silently.

Responses are always JSON, including errors. The response format and pagination are described in Conventions.

The API is strictly read-only right now — GET requests only. Write endpoints (creating shifts, check-ins, and so on) are out of scope for v1 and will ship as a separate stage on request.

What's available now

v1 exposes three resources:

  • GET /org — organization details (name, timezone, locale).
  • GET /departments — the list of departments.
  • GET /employees — the list of employees.

Coming next: the schedule, check-ins, timesheets, and demand data. The full resource list lives in the endpoint reference.

The API key is a server secret

Every request is authenticated with an organization API key (see Authentication). Do not use the key in code that runs in a user's browser — CORS is disabled for /api/v1 on purpose, so cross-origin requests won't succeed. Keep the key on your server — in your integration's backend, a script, or a serverless function — and never embed it in client-side JavaScript.

What's next

Was this article helpful?