Docs

Search the docs

Guides, sections and API endpoints

API reference

Organizations

The organization the API key belongs to.

Retrieve your organization

get/organizations/self

Any API key

The organization the API key belongs to. Any key may read it: a quick way to check a key works.

Returns 200

  • iduuid
  • namestring
  • slugstring
    Where its job board is: {jobs site}/{slug}.
  • websitestringnullable
  • timezonestring
    IANA name, e.g. Europe/Berlin.

Errors

  • 401The key is wrong, expired or revoked (api_key_required when missing) invalid_api_key
curl "https://api.hirehappy.io/v1/organizations/self" \
  -H "Authorization: Bearer $HIREHAPPY_API_KEY"
Response 200
{
  "id": "0b6f3c2e-8a41-4d7e-9c55-3e2f1a7b9d10",
  "name": "Acme",
  "slug": "acme",
  "website": "https://acme.com",
  "timezone": "Europe/Berlin"
}