Ekip API

Ekip rehberi ve personel dosyaları — işe alım, oryantasyon ve ayrılış.

Modül kodu employees · 4 işlem · 1 veri modeli · 4 olay. Bir anahtar ya da token, arkasındaki kişinin bu modülde yapabildiğinden fazlasını asla yapamaz; satır düzeyindeki güvenlik uygulamadakiyle birebir aynıdır. Yetki kapsamları: employees (hepsi), employees:read (yalnız okuma) ya da employees:<yetenek>.

Kaynaklar

Listeler limit (en çok 200), cursor, order (ör. -created_at), fields ve q alır; diğer her sorgu parametresi bir sütun süzgecidir: ?status=paid, ?total[gte]=100, ?id[in]=a,b, ?x=null.

İşlemler

employees.activate

Oryantasyonu bitir — Oryantasyondaki bir çalışanı aktif yapar.

Gereken izin employees:manage · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/employees.activate

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: employees.activated

Neye yazar: employment (update) — Sets the status to active

curl -X POST https://app.getera.io/api/v1/employments/actions/activate \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"userId":"APP_USER_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "employees.activated"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.employments.activate({
  userId: "APP_USER_ID"
})

era employments activate \
  --user-id "APP_USER_ID"

{
  "name": "era__employees__activate",
  "arguments": {
    "userId": "APP_USER_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde employees:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_employed, not_onboarding · 429 çok sık istek

employees.end_employment

İşten ayrılışı kaydet — Son günü ve nedeni kaydeder; devredilebilmesi için hâlâ üzerinde olan her şeyi listeler.

Gereken izin employees:manage · dışarıya ulaşır (gönderir, yayımlar ya da ücret alır) · Era çalıştırırken bir kişiye onaylatır

• Asıl adres: POST /api/v1/actions/employees.end_employment

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: employees.employment_ended

Neye yazar: employment (update) — Closes the personnel file

curl -X POST https://app.getera.io/api/v1/employments/actions/end_employment \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"userId":"APP_USER_ID","endDate":"2026-11-02","reason":"resigned"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "employees.employment_ended"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.employments.endEmployment({
  userId: "APP_USER_ID",
  endDate: "2026-11-02",
  reason: "resigned"
})

era employments end_employment \
  --user-id "APP_USER_ID" \
  --end-date "2026-11-02" \
  --reason "resigned"

{
  "name": "era__employees__end_employment",
  "arguments": {
    "userId": "APP_USER_ID",
    "endDate": "2026-11-02",
    "reason": "resigned"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde employees:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 cannot_end_self, not_employed, already_ended, end_before_hire · 429 çok sık istek

employees.hire

İşe al — Bir çalışma alanı üyesi için özlük dosyası açar — önce oryantasyon ya da doğrudan aktif.

Gereken izin employees:manage · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/employees.hire

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: employees.hired

Neye yazar: employment (upsert) — Opens (or re-opens) the personnel file

curl -X POST https://app.getera.io/api/v1/employments/actions/hire \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"userId":"APP_USER_ID","hireDate":"2026-11-02"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "employees.hired"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.employments.hire({
  userId: "APP_USER_ID",
  hireDate: "2026-11-02"
})

era employments hire \
  --user-id "APP_USER_ID" \
  --hire-date "2026-11-02"

{
  "name": "era__employees__hire",
  "arguments": {
    "userId": "APP_USER_ID",
    "hireDate": "2026-11-02"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde employees:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_a_member, already_employed · 429 çok sık istek

employees.update

İstihdam bilgilerini düzenle — İşe giriş tarihi, çalışma türü ve iş iletişim bilgisi.

Gereken izin employees:manage · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/employees.update

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: employees.updated

Neye yazar: employment (update) — Rewrites the given fields

curl -X POST https://app.getera.io/api/v1/employments/actions/update \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"userId":"APP_USER_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "employees.updated"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.employments.update({
  userId: "APP_USER_ID"
})

era employments update \
  --user-id "APP_USER_ID"

{
  "name": "era__employees__update",
  "arguments": {
    "userId": "APP_USER_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde employees:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_employed · 429 çok sık istek

Veri modelleri

Employment

Tablo employment · Kaynak employments

• GET /api/v1/employments
• GET /api/v1/employments/{id}

Birincil anahtar: workspace_id, user_id

Denetimler:

• CHECK (((end_date IS NULL) OR (end_date >= hire_date)))
• CHECK (((status = 'terminated'::text) = ((end_date IS NOT NULL) AND (end_reason IS NOT NULL))))
• CHECK (((end_reason IS NULL) OR (end_reason = ANY (ARRAY['resigned'::text, 'terminated'::text, 'retired'::text, 'contract_ended'::text, 'other'::text]))))

Olaylar

İş akışları ve webhook'lar bu olaylara tepki verir.