İçeriğe geç

Şirket yapısı

Şirket yapısı uçları: parametreler, alanlar ve örnek yanıtlar.

Geliştirici belgesi

Şirketleri listeler

GET /api/v1/companies

Kapsam: org:read

Anahtarın kapsamındaki şirketler. Vergi numarası dönmez. Sıra kimliğe göredir ve kararlıdır; toplam sayı dönmez. Örnek kayıtlar listeye girmez.

Parametreler

companies.list: Parametreler
AlanTürAçıklama
cursor (sorgu)stringÖnceki yanıtın next_cursor değeri. Opaktır; aynı anahtarla ve aynı süzgeçle gönderilir.
limit (sorgu)integerSayfa boyutu; azamiyi aşan değer azamiye iner.

Yanıtlar

200 Başarılı

Liste yanıtı { data, next_cursor } zarfındadır.

companies.list: Listedeki her öğe (data[])
AlanTürAçıklama
idstring (uuid)zorunlu
namestringzorunluŞirketin unvanı.
citystringzorunlunull olabilir
is_demobooleanzorunluÖrnek veriyle gelen kayıt. Liste uçları örnek kayıtları döndürmez; tek kayıt okuması döndürür ve bu alan true olur.
created_atstring (date-time)zorunlu
updated_atstring (date-time)zorunluKaydın kendi alanlarının son değiştiği an (UTC).
Örnek yanıt
{
  "data": [
    {
      "id": "0b8f6c1e-5f0a-4c7e-9a43-2f6f3a1d9c10",
      "name": "Marmara Lojistik Ltd.",
      "city": "Bursa",
      "is_demo": false,
      "created_at": "2026-01-05T08:00:00.000Z",
      "updated_at": "2026-03-02T09:15:00.000Z"
    }
  ],
  "next_cursor": null
}

Hata kodları

  • 400: bad_request, validation_failed, key_in_query, cookie_with_key, idempotency_key_required, idempotency_key_invalid, cursor_invalid
  • 401: unauthorized
  • 403: insufficient_scope, forbidden, module_disabled, trial_ended, key_suspended
  • 404: not_found
  • 429: rate_limited
  • 500: internal_error
  • 503: timeout

Tek şirketi döndürür

GET /api/v1/companies/{id}

Kapsam: org:read

Vergi numarası dönmez. Anahtarın görmediği kayıt ile var olmayan kayıt aynı 404 yanıtını alır.

Parametreler

companies.get: Parametreler
AlanTürAçıklama
id (yol)string (uuid)zorunluŞirketin kimliği.

Yanıtlar

200 Başarılı

companies.get: Yanıtlar
AlanTürAçıklama
idstring (uuid)zorunlu
namestringzorunluŞirketin unvanı.
citystringzorunlunull olabilir
is_demobooleanzorunluÖrnek veriyle gelen kayıt. Liste uçları örnek kayıtları döndürmez; tek kayıt okuması döndürür ve bu alan true olur.
created_atstring (date-time)zorunlu
updated_atstring (date-time)zorunluKaydın kendi alanlarının son değiştiği an (UTC).
Örnek yanıt
{
  "id": "0b8f6c1e-5f0a-4c7e-9a43-2f6f3a1d9c10",
  "name": "Marmara Lojistik Ltd.",
  "city": "Bursa",
  "is_demo": false,
  "created_at": "2026-01-05T08:00:00.000Z",
  "updated_at": "2026-03-02T09:15:00.000Z"
}

Hata kodları

  • 400: bad_request, validation_failed, key_in_query, cookie_with_key, idempotency_key_required, idempotency_key_invalid, cursor_invalid
  • 401: unauthorized
  • 403: insufficient_scope, forbidden, module_disabled, trial_ended, key_suspended
  • 404: not_found
  • 429: rate_limited
  • 500: internal_error
  • 503: timeout

Unvanları listeler

GET /api/v1/job-titles

Kapsam: org:read

Unvanlar hesap düzeyindedir (şirketi yoktur): org:read kapsamı olan her anahtar, şirkete, şubeye ya da birime bağlı olsa da, bütün unvanları görür ve employees:write kapsamı olan her anahtar hesabın her unvanını atayabilir. Sıra kimliğe göredir ve kararlıdır; toplam sayı dönmez. Örnek kayıtlar listeye girmez.

Parametreler

job_titles.list: Parametreler
AlanTürAçıklama
cursor (sorgu)stringÖnceki yanıtın next_cursor değeri. Opaktır; aynı anahtarla ve aynı süzgeçle gönderilir.
limit (sorgu)integerSayfa boyutu; azamiyi aşan değer azamiye iner.

Yanıtlar

200 Başarılı

Liste yanıtı { data, next_cursor } zarfındadır.

job_titles.list: Listedeki her öğe (data[])
AlanTürAçıklama
idstring (uuid)zorunlu
titlestringzorunlu
is_demobooleanzorunluÖrnek veriyle gelen kayıt. Liste uçları örnek kayıtları döndürmez; tek kayıt okuması döndürür ve bu alan true olur.
created_atstring (date-time)zorunlu
updated_atstring (date-time)zorunluKaydın kendi alanlarının son değiştiği an (UTC).
Örnek yanıt
{
  "data": [
    {
      "id": "9e7d6c5b-4a39-4821-8f70-6e5d4c3b2a19",
      "title": "Vardiya Amiri",
      "is_demo": false,
      "created_at": "2026-01-05T08:12:00.000Z",
      "updated_at": "2026-01-05T08:12:00.000Z"
    }
  ],
  "next_cursor": null
}

Hata kodları

  • 400: bad_request, validation_failed, key_in_query, cookie_with_key, idempotency_key_required, idempotency_key_invalid, cursor_invalid
  • 401: unauthorized
  • 403: insufficient_scope, forbidden, module_disabled, trial_ended, key_suspended
  • 404: not_found
  • 429: rate_limited
  • 500: internal_error
  • 503: timeout

Tek unvanı döndürür

GET /api/v1/job-titles/{id}

Kapsam: org:read

Var olmayan kayıt 404 yanıtını alır.

Parametreler

job_titles.get: Parametreler
AlanTürAçıklama
id (yol)string (uuid)zorunluUnvanın kimliği.

Yanıtlar

200 Başarılı

job_titles.get: Yanıtlar
AlanTürAçıklama
idstring (uuid)zorunlu
titlestringzorunlu
is_demobooleanzorunluÖrnek veriyle gelen kayıt. Liste uçları örnek kayıtları döndürmez; tek kayıt okuması döndürür ve bu alan true olur.
created_atstring (date-time)zorunlu
updated_atstring (date-time)zorunluKaydın kendi alanlarının son değiştiği an (UTC).
Örnek yanıt
{
  "id": "9e7d6c5b-4a39-4821-8f70-6e5d4c3b2a19",
  "title": "Vardiya Amiri",
  "is_demo": false,
  "created_at": "2026-01-05T08:12:00.000Z",
  "updated_at": "2026-01-05T08:12:00.000Z"
}

Hata kodları

  • 400: bad_request, validation_failed, key_in_query, cookie_with_key, idempotency_key_required, idempotency_key_invalid, cursor_invalid
  • 401: unauthorized
  • 403: insufficient_scope, forbidden, module_disabled, trial_ended, key_suspended
  • 404: not_found
  • 429: rate_limited
  • 500: internal_error
  • 503: timeout

Şubeleri listeler

GET /api/v1/locations

Kapsam: org:read

Anahtarın kapsamındaki şubeler. Sıra kimliğe göredir ve kararlıdır; toplam sayı dönmez. Örnek kayıtlar listeye girmez.

Parametreler

locations.list: Parametreler
AlanTürAçıklama
company_id (sorgu)string (uuid)Yalnız bu şirketin şubeleri.
cursor (sorgu)stringÖnceki yanıtın next_cursor değeri. Opaktır; aynı anahtarla ve aynı süzgeçle gönderilir.
limit (sorgu)integerSayfa boyutu; azamiyi aşan değer azamiye iner.

Yanıtlar

200 Başarılı

Liste yanıtı { data, next_cursor } zarfındadır.

locations.list: Listedeki her öğe (data[])
AlanTürAçıklama
idstring (uuid)zorunlu
company_idstring (uuid)zorunlu
namestringzorunlu
citystringzorunlunull olabilir
created_atstring (date-time)zorunlu
updated_atstring (date-time)zorunluKaydın kendi alanlarının son değiştiği an (UTC).
Örnek yanıt
{
  "data": [
    {
      "id": "5d2f0a77-3c1b-4f58-8a0e-6b9d4c2e7f31",
      "company_id": "0b8f6c1e-5f0a-4c7e-9a43-2f6f3a1d9c10",
      "name": "Bursa Depo",
      "city": "Bursa",
      "created_at": "2026-01-05T08:05:00.000Z",
      "updated_at": "2026-01-05T08:05:00.000Z"
    }
  ],
  "next_cursor": null
}

Hata kodları

  • 400: bad_request, validation_failed, key_in_query, cookie_with_key, idempotency_key_required, idempotency_key_invalid, cursor_invalid
  • 401: unauthorized
  • 403: insufficient_scope, forbidden, module_disabled, trial_ended, key_suspended
  • 404: not_found
  • 429: rate_limited
  • 500: internal_error
  • 503: timeout

Tek şubeyi döndürür

GET /api/v1/locations/{id}

Kapsam: org:read

Anahtarın görmediği kayıt ile var olmayan kayıt aynı 404 yanıtını alır.

Parametreler

locations.get: Parametreler
AlanTürAçıklama
id (yol)string (uuid)zorunluŞubenin kimliği.

Yanıtlar

200 Başarılı

locations.get: Yanıtlar
AlanTürAçıklama
idstring (uuid)zorunlu
company_idstring (uuid)zorunlu
namestringzorunlu
citystringzorunlunull olabilir
created_atstring (date-time)zorunlu
updated_atstring (date-time)zorunluKaydın kendi alanlarının son değiştiği an (UTC).
Örnek yanıt
{
  "id": "5d2f0a77-3c1b-4f58-8a0e-6b9d4c2e7f31",
  "company_id": "0b8f6c1e-5f0a-4c7e-9a43-2f6f3a1d9c10",
  "name": "Bursa Depo",
  "city": "Bursa",
  "created_at": "2026-01-05T08:05:00.000Z",
  "updated_at": "2026-01-05T08:05:00.000Z"
}

Hata kodları

  • 400: bad_request, validation_failed, key_in_query, cookie_with_key, idempotency_key_required, idempotency_key_invalid, cursor_invalid
  • 401: unauthorized
  • 403: insufficient_scope, forbidden, module_disabled, trial_ended, key_suspended
  • 404: not_found
  • 429: rate_limited
  • 500: internal_error
  • 503: timeout

Birimleri listeler

GET /api/v1/org-units

Kapsam: org:read

Anahtarın kapsamındaki birimler; ağaç parent_id ile kurulur. Sıra kimliğe göredir ve kararlıdır; toplam sayı dönmez. Örnek kayıtlar listeye girmez.

Parametreler

org_units.list: Parametreler
AlanTürAçıklama
company_id (sorgu)string (uuid)Yalnız bu şirketin birimleri.
cursor (sorgu)stringÖnceki yanıtın next_cursor değeri. Opaktır; aynı anahtarla ve aynı süzgeçle gönderilir.
limit (sorgu)integerSayfa boyutu; azamiyi aşan değer azamiye iner.

Yanıtlar

200 Başarılı

Liste yanıtı { data, next_cursor } zarfındadır.

org_units.list: Listedeki her öğe (data[])
AlanTürAçıklama
idstring (uuid)zorunlu
company_idstring (uuid)zorunlu
parent_idstring (uuid)zorunlunull olabilirÜst birim; kökte null.
location_idstring (uuid)zorunlunull olabilirBirimin şubesi; yoksa null.
kindstringzorunlu Değerler: department, unit
namestringzorunlu
is_demobooleanzorunluÖrnek veriyle gelen kayıt. Liste uçları örnek kayıtları döndürmez; tek kayıt okuması döndürür ve bu alan true olur.
created_atstring (date-time)zorunlu
updated_atstring (date-time)zorunluKaydın kendi alanlarının son değiştiği an (UTC).
Örnek yanıt
{
  "data": [
    {
      "id": "c4a1e2b3-7d6f-4e5a-9b8c-1f2e3d4c5b6a",
      "company_id": "0b8f6c1e-5f0a-4c7e-9a43-2f6f3a1d9c10",
      "parent_id": null,
      "location_id": "5d2f0a77-3c1b-4f58-8a0e-6b9d4c2e7f31",
      "kind": "department",
      "name": "Operasyon",
      "is_demo": false,
      "created_at": "2026-01-05T08:10:00.000Z",
      "updated_at": "2026-02-11T13:40:00.000Z"
    }
  ],
  "next_cursor": null
}

Hata kodları

  • 400: bad_request, validation_failed, key_in_query, cookie_with_key, idempotency_key_required, idempotency_key_invalid, cursor_invalid
  • 401: unauthorized
  • 403: insufficient_scope, forbidden, module_disabled, trial_ended, key_suspended
  • 404: not_found
  • 429: rate_limited
  • 500: internal_error
  • 503: timeout

Tek birimi döndürür

GET /api/v1/org-units/{id}

Kapsam: org:read

Anahtarın görmediği kayıt ile var olmayan kayıt aynı 404 yanıtını alır.

Parametreler

org_units.get: Parametreler
AlanTürAçıklama
id (yol)string (uuid)zorunluBirimin kimliği.

Yanıtlar

200 Başarılı

org_units.get: Yanıtlar
AlanTürAçıklama
idstring (uuid)zorunlu
company_idstring (uuid)zorunlu
parent_idstring (uuid)zorunlunull olabilirÜst birim; kökte null.
location_idstring (uuid)zorunlunull olabilirBirimin şubesi; yoksa null.
kindstringzorunlu Değerler: department, unit
namestringzorunlu
is_demobooleanzorunluÖrnek veriyle gelen kayıt. Liste uçları örnek kayıtları döndürmez; tek kayıt okuması döndürür ve bu alan true olur.
created_atstring (date-time)zorunlu
updated_atstring (date-time)zorunluKaydın kendi alanlarının son değiştiği an (UTC).
Örnek yanıt
{
  "id": "c4a1e2b3-7d6f-4e5a-9b8c-1f2e3d4c5b6a",
  "company_id": "0b8f6c1e-5f0a-4c7e-9a43-2f6f3a1d9c10",
  "parent_id": null,
  "location_id": "5d2f0a77-3c1b-4f58-8a0e-6b9d4c2e7f31",
  "kind": "department",
  "name": "Operasyon",
  "is_demo": false,
  "created_at": "2026-01-05T08:10:00.000Z",
  "updated_at": "2026-02-11T13:40:00.000Z"
}

Hata kodları

  • 400: bad_request, validation_failed, key_in_query, cookie_with_key, idempotency_key_required, idempotency_key_invalid, cursor_invalid
  • 401: unauthorized
  • 403: insufficient_scope, forbidden, module_disabled, trial_ended, key_suspended
  • 404: not_found
  • 429: rate_limited
  • 500: internal_error
  • 503: timeout