Organization

Returns data about the organization the API key belongs to. This is the only endpoint in API v1 that returns a single object instead of a list — the organization tied to a key always has exactly one record.

Scope

No scope is required — this endpoint is available to any valid organization key. See Scopes and permissions for which resources are open without a scope and why.

Request

curl -s https://smengo.com/api/v1/org \
  -H "Authorization: Bearer smg_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

There are no request parameters — no filters, no pagination: GET /org always returns the same object for a given key.

Response

A single object without meta (see Conventions → Response format):

{
  "data": {
    "name": "Coffee & Co",
    "slug": "coffee-co",
    "timezone": "Europe/Kyiv",
    "default_locale": "ru"
  }
}

Response fields

Field Type Description
name string The organization's name, as set in Smengo's settings.
slug string A short, unique identifier for the organization.
timezone string The organization's IANA timezone (e.g. Europe/Kyiv). This is the timezone used for date fields (from, to, entry_date, etc.) across the rest of the API — see Conventions → Dates and time.
default_locale string The organization's default locale: ru, uk, or en.

What's next

  • Departments — the organization's list of departments.
  • Employees — the organization's list of employees.
  • Conventions — response format and working with dates.
Was this article helpful?