Dokümanlar/API ve Webhook'lar/Ekipler

Ekipler

Ekipler, raporlama, uyumluluk özetleri ve ekip kapsamlı atamalar için kullanıcıları gruplandırır. Tüm uç noktalar /api/public/v1/teams altındadır. Bir kullanıcı aynı anda sıfır veya bir ekipte olabilir.

Uç noktalar

MethodPathKapsamAmaç
GET/teamsteams:readEkipleri üye sayılarıyla listeler.
GET/teams/{'{'}id{'}'}teams:readÜye listesiyle tek bir ekip.
POST/teamsteams:writeBir ekip oluşturur.
PATCH/teams/{'{'}id{'}'}teams:writeBir ekibi yeniden adlandırır.
DELETE/teams/{'{'}id{'}'}teams:writeBir ekibi siler. Üyeler ekipten ayrılır, deaktive edilmez.
POST/teams/{'{'}teamId{'}'}/members/{'{'}userId{'}'}teams:writeBir kullanıcıyı ekibe ekler.
DELETE/teams/{'{'}teamId{'}'}/members/{'{'}userId{'}'}teams:writeBir kullanıcıyı ekipten çıkarır.

Ekipleri listele

Kurumdaki her ekibi döner. Üye sayısı denormalize edilmiştir — gerçek kadro için GET /teams/{id}'i çağırın.

GET /api/public/v1/teams
Authorization: Bearer scs_live_…

Yanıt

[
  {
    "id": "4f8d3e2a-71cb-4d09-9ad7-5b8c7e1f0a32",
    "name": "Payments",
    "memberCount": 12,
    "createdAt": "2025-11-03T14:20:00Z"
  },
  {
    "id": "a52e1f9b-8c44-4a31-9c0d-3b62e0a17c84",
    "name": "Platform",
    "memberCount": 8,
    "createdAt": "2025-11-03T14:21:42Z"
  }
]

Örnek

curl -sS -H "Authorization: Bearer $SCH_API_KEY" \
  https://api.limeplate.com/api/public/v1/teams

Ekibi al

Ekibi ve üye kadrosunu, ilerleme dizileri hariç GET /users/{id} ile aynı yapıda döner.

GET /api/public/v1/teams/{teamId}
Authorization: Bearer scs_live_…

Yanıt

{
  "id": "4f8d3e2a-71cb-4d09-9ad7-5b8c7e1f0a32",
  "name": "Payments",
  "createdAt": "2025-11-03T14:20:00Z",
  "members": [
    {
      "id": "b1a4d7c2-9e58-4f3a-83cd-2c6f1a90e7b4",
      "name": "Jane Smith",
      "email": "jane.smith@acme.com",
      "role": "member",
      "teamId": "4f8d3e2a-71cb-4d09-9ad7-5b8c7e1f0a32",
      "teamName": "Payments",
      "isActive": true,
      "lastLoginAt": "2026-05-27T16:42:11Z",
      "createdAt": "2026-02-04T11:08:00Z"
    }
  ]
}

Örnek

curl -sS -H "Authorization: Bearer $SCH_API_KEY" \
  https://api.limeplate.com/api/public/v1/teams/4f8d3e2a-71cb-4d09-9ad7-5b8c7e1f0a32

Ekip oluştur

Ekip adları kurum içinde benzersiz olmalıdır. Yanıt, üye sayısı sıfır olan yeni ekibi döner.

POST /api/public/v1/teams
Authorization: Bearer scs_live_…
Content-Type: application/json

İstek gövdesi

AlanTürZorunluAnlam
namestringevetEkip görünen adı. Kurum içinde benzersiz olmalıdır.

Yanıt

{
  "id": "4f8d3e2a-71cb-4d09-9ad7-5b8c7e1f0a32",
  "name": "Payments",
  "memberCount": 0,
  "createdAt": "2026-05-29T09:30:12Z"
}

Örnek

curl -sS -X POST \
  -H "Authorization: Bearer $SCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Payments"}' \
  https://api.limeplate.com/api/public/v1/teams

Ekibi güncelle

Yalnızca ekip adı değiştirilebilir. Üyeleri içeri veya dışarı taşımak için üye uç noktalarını kullanın.

PATCH /api/public/v1/teams/{teamId}
Authorization: Bearer scs_live_…
Content-Type: application/json

İstek gövdesi

AlanTürZorunluAnlam
namestringevetYeni ekip adı.

Yanıt

{
  "message": "Team updated"
}

Örnek

curl -sS -X PATCH \
  -H "Authorization: Bearer $SCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Payments Core"}' \
  https://api.limeplate.com/api/public/v1/teams/4f8d3e2a-71cb-4d09-9ad7-5b8c7e1f0a32

Ekibi sil

Ekibi kaldırır. Ekibin üyeleri ekipten ayrılır (teamId değeri null olur) ama deaktive edilmez — hesapları, XP ve ilerlemeleri bozulmadan kalır. Silinen ekibe bağlı ekip kapsamlı atamalar deaktive edilir.

DELETE /api/public/v1/teams/{teamId}
Authorization: Bearer scs_live_…

Yanıt

{
  "message": "Team deleted"
}

Örnek

curl -sS -X DELETE \
  -H "Authorization: Bearer $SCH_API_KEY" \
  https://api.limeplate.com/api/public/v1/teams/4f8d3e2a-71cb-4d09-9ad7-5b8c7e1f0a32

Üye ekle

Bir kullanıcıyı ekibe taşır. Kullanıcı zaten farklı bir ekipteydiyse o önceki üyelik değiştirilir. Ayrı bir "transfer" çağrısı yoktur.

POST /api/public/v1/teams/{teamId}/members/{userId}
Authorization: Bearer scs_live_…

Yanıt

{
  "message": "Member added"
}

Örnek

curl -sS -X POST \
  -H "Authorization: Bearer $SCH_API_KEY" \
  https://api.limeplate.com/api/public/v1/teams/4f8d3e2a-71cb-4d09-9ad7-5b8c7e1f0a32/members/b1a4d7c2-9e58-4f3a-83cd-2c6f1a90e7b4

Üyeyi çıkar

Kullanıcıyı ekipten ayırır. Kullanıcıyı teamId: null ile PATCH etmeye eşdeğerdir ama ekip kimliği üzerinden temiz şekilde yönlendirilir. Kullanıcının hesabı ve ilerlemesi etkilenmez.

DELETE /api/public/v1/teams/{teamId}/members/{userId}
Authorization: Bearer scs_live_…

Yanıt

{
  "message": "Member removed"
}

Örnek

curl -sS -X DELETE \
  -H "Authorization: Bearer $SCH_API_KEY" \
  https://api.limeplate.com/api/public/v1/teams/4f8d3e2a-71cb-4d09-9ad7-5b8c7e1f0a32/members/b1a4d7c2-9e58-4f3a-83cd-2c6f1a90e7b4