Geliştiriciler

Worktivity API'si üzerinde geliştirin

Zaman takibi, aktivite verisi, projeler ve hak ediş için tek bir REST API.

Worktivity'deki her ekran, sizin de eriştiğiniz aynı herkese açık API üzerinde çalışır. Tek bir anahtarla kimlik doğrulayın, JSON gönderin ve tutarlı bir yanıt zarfı okuyun. Aşağıdaki endpoint'ler canlı servisten üretilir; cURL, JavaScript, Python ve PHP için istek ve yanıt örnekleri içerir.

Swagger UI'ı açın API anahtarınızı alın

Tüm paketlere dahildir. Ayrı bir API aboneliği yok.

Bir bakışta

İlk istekten önce bilmeniz gereken her şey.

Base URL: open-api.useworktivity.com
Kimlik doğrulama: x_api_key; Query parametresi
Hız limitleri: 5/sn · 100/dk · 1000/saat
Dokümante edilmiş endpoint: 34; JSON girer: JSON çıkar

Kimlik doğrulama

Her istek, organizasyonunuzun API anahtarını query string parametresi olarak taşır. OAuth akışı ve bearer header yoktur, isteği organizasyonunuzla sınırlayan tek şey anahtardır.

API anahtarınızı alma

Worktivity paneline giriş yapın.
Organization → Settings → API Access adımını açın.
Generate API Key düğmesine tıklayın.
Anahtarı kopyalayın ve sunucu tarafındaki sır yöneticinizde saklayın.

API anahtarınızı alın

Anahtarı sunucu tarafında tutun

Anahtar, organizasyonunuzun verilerine tam okuma ve yazma erişimi verir. Tarayıcı JavaScript'ine, bir mobil pakete veya herkese açık bir depoya asla koymayın. Sızarsa aynı ekrandan yenileyin.

İlk istek

Bu istek organizasyonunuzdaki çalışanları listeler. Diğer tüm endpoint'ler aynı yapıyı izler.

cURL

curl -X POST "https://open-api.useworktivity.com/Employee/List?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "SearchTerm": "",
  "Page": 1,
  "PageSize": 15,
  "IncludeUsers": true
}'

Yanıt biçimi

Her endpoint aynı zarfı döndürür. Data'yı okumadan önce HasError'a bakın, ele alınan doğrulama hatalarında da HTTP durumu 200'dür.

Başarılı yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {}
}

Doğrulama hatası

JSON

{
  "HasError": true,
  "Message": "Validation failed",
  "ValidationErrors": [
    {
      "Key": "Email",
      "Value": "Email is required"
    },
    {
      "Key": "FirstName",
      "Value": "First name is required"
    }
  ],
  "Data": null
}

ValidationErrors, alan ve mesaj çiftlerinden oluşan düz bir listedir. Başarı durumunda boştur, hiçbir zaman null olmaz.

HTTP durum kodları

200İstek işlendi. Başarıyı doğrulama hatasından ayırmak için HasError'ı okuyun.
400Hatalı biçimlendirilmiş istek, genellikle geçersiz JSON ya da yanlış parametre türü.
401Eksik, süresi dolmuş veya iptal edilmiş API anahtarı.
403Anahtar geçerli, ancak organizasyonun o kaynağa erişimi yok.
404Endpoint yolu mevcut değil.
429Hız limiti aşıldı. Bildirilen süre kadar bekleyip yeniden deneyin.
500Beklenmeyen sunucu hatası. Üstel bekleme ile yeniden denemek güvenlidir.

Hız limitleri

Limitler API anahtarı başına ve üç pencerede aynı anda uygulanır. Herhangi birini aşmak, üçünün de kalan bütçesiyle birlikte 429 döndürür.

Her yanıttaki header'lar

İstekleri kendiniz saymak yerine bunları okuyun, yeniden denemeleri ve paralel çalışan işleri de hesaba katarlar.

HTTP

X-RateLimit-Limit-Second: 5
X-RateLimit-Limit-Minute: 100
X-RateLimit-Limit-Hour: 1000

X-RateLimit-Remaining-Second: 4
X-RateLimit-Remaining-Minute: 87
X-RateLimit-Remaining-Hour: 943

X-RateLimit-Reset-Second: 1767182101
X-RateLimit-Reset-Minute: 1767182160
X-RateLimit-Reset-Hour: 1767184800

Limite takıldığınızda

Hız limiti aşıldı. Bildirilen süre kadar bekleyip yeniden deneyin.

JSON

{
  "HasError": true,
  "Message": "Rate limit exceeded. Maximum 5 requests per second, 100 per minute, 1000 per hour.",
  "Data": {
    "RateLimits": {
      "PerSecond": {
        "Limit": 5,
        "Remaining": 0,
        "ResetAt": "2026-01-31T12:34:57+00:00"
      },
      "PerMinute": {
        "Limit": 100,
        "Remaining": 23,
        "ResetAt": "2026-01-31T12:35:00+00:00"
      },
      "PerHour": {
        "Limit": 1000,
        "Remaining": 456,
        "ResetAt": "2026-01-31T13:00:00+00:00"
      }
    },
    "RetryAfter": 1
  }
}

Limitin altında kalmak

429 aldığınızda RetryAfter değerine göre yeniden deneyin, sonrasında üstel bekleme uygulayın.
Kayıtları teker teker çekmek yerine PageSize ile listeler arasında sayfalayın.
Definition/ListEnums ve Definition/ListTimezones sonuçlarını önbelleğe alın, nadiren değişirler.
Tüm tarih aralıklarını yeniden okumak yerine CreatedAfter ile programlı sorgulama yapın.

Endpoint referansı

Kaynağa göre gruplanmıştır. Yollar base URL'e görelidir ve her istekte API anahtarının query string'de bulunması gerekir.

Tanımlar

Başka bir şey göndermeden önce enum değerlerine ve saat dilimlerine bakın. İki endpoint de önbelleğe alınabilir.

GET/Definition/ListEnums

Enum'ları listele

API'nin kullandığı her enum'ı sayısal değeri ve görünen adıyla döndürür, tarih filtreleri, roller, görev durumları, fatura durumları ve daha fazlası. Sonucu önbelleğe alın; yalnızca yeni bir sürümle değişir.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.

İstek

cURL

curl -X GET "https://open-api.useworktivity.com/Definition/ListEnums?x_api_key=YOUR_API_KEY"

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {
    "DateFilterTypes": [
      {
        "Value": 1,
        "DisplayName": "Today"
      },
      {
        "Value": 10,
        "DisplayName": "Custom date"
      }
    ],
    "EmployeeRoles": [
      {
        "Value": 2,
        "DisplayName": "Owner"
      },
      {
        "Value": 5,
        "DisplayName": "Employee"
      }
    ],
    "ProjectTaskStatuses": [
      {
        "Value": 0,
        "DisplayName": "Todo"
      },
      {
        "Value": 6,
        "DisplayName": "In progress"
      }
    ]
  }
}

GET/Definition/ListTimezones

Saat dilimlerini listele

Desteklenen saat dilimlerini UTC farkları ve yaz saati bilgisiyle döndürür. Tüm API zaman damgaları UTC'dir; yerel saatleri göstermek için bunu kullanın.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.

İstek

cURL

curl -X GET "https://open-api.useworktivity.com/Definition/ListTimezones?x_api_key=YOUR_API_KEY"

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {
    "Items": [
      {
        "Id": "Europe/Istanbul",
        "DisplayName": "Istanbul (GMT+03:00)",
        "BaseUtcOffset": "+03:00:00",
        "SupportsDaylightSavingTime": false
      }
    ]
  }
}

Çalışanlar

Organizasyonunuzdaki kişileri oluşturun, güncelleyin, engelleyin ve silin; bekleyen davetleri yeniden gönderin.

POST/Employee/List

Çalışanları listele

Sayfalanmış bir çalışan listesi döndürür. Ad ve e-posta adreslerini almak için IncludeUsers değerini kullanın; bu alanlar çalışan kaydında değil, bağlı kullanıcı kaydında bulunur.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`SearchTerm`isteğe bağlı	string	Body	Serbest metin filtresi. Boş dize her şeyi döndürür.
`Page`isteğe bağlı	integer	Body	1'den başlayan sayfa numarası. Varsayılan 1.
`PageSize`isteğe bağlı	integer	Body	Sayfa başına kayıt sayısı. Varsayılan 15.
`TeamId`isteğe bağlı	string	Body	Tek bir ekiple sınırlar. Boş dize tüm ekipler anlamına gelir.
`EmployeeIds`isteğe bağlı	string[]	Body	Belirli bir çalışan kimliği kümesiyle sınırlar.
`IsBlocked`isteğe bağlı	boolean	Body	Engellenme durumuna göre filtreler. İkisini de dahil etmek için göndermeyin.
`Registered`isteğe bağlı	boolean	Body	Yalnızca davetini kabul etmiş çalışanlar.
`IncludeUsers`isteğe bağlı	boolean	Body	Ad ve e-posta bilgisini içeren bağlı kullanıcı kaydını ekler.
`IncludeTeams`isteğe bağlı	boolean	Body	Her çalışana ekip kaydının tamamını ekler.
`IncludeTodayClockIns`isteğe bağlı	boolean	Body	Her çalışan için bugünkü mesai girişi aktivite kaydını ekler.
`CreatedAfter`isteğe bağlı	datetime	Body	Yalnızca bu UTC zaman damgasından sonra oluşturulan kayıtlar. Artımlı senkronizasyon için kullanın.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/Employee/List?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "SearchTerm": "john",
  "Page": 1,
  "PageSize": 15,
  "TeamId": "",
  "IsBlocked": false,
  "IncludeUsers": true,
  "IncludeTeams": true
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {
    "Items": [
      {
        "ID": "65f1c0a3b8d4e21f9c0a1b2c",
        "UserId": "65f1c0a3b8d4e21f9c0a1b30",
        "TeamId": "65f1c0a3b8d4e21f9c0a1b40",
        "OrganizationId": "65f1c0a3b8d4e21f9c0a1b50",
        "Role": 5,
        "IsActive": true,
        "Blocked": false,
        "EmployeeCode": "EMP-014",
        "PayRate": 25,
        "BillRate": 45,
        "EnableScreenshots": true,
        "ScreenCaptureIntervalMins": 5,
        "CreateDate": "2026-01-15T10:30:00Z",
        "User": {
          "ID": "65f1c0a3b8d4e21f9c0a1b30",
          "FirstName": "John",
          "LastName": "Doe",
          "Email": "john.doe@example.com"
        }
      }
    ],
    "TotalCount": 1,
    "PageCount": 1
  }
}

POST/Employee/Create

Çalışan oluştur

Bir çalışan oluşturur ve kendisine davet e-postası gönderir. Kullanıcı hakkı, davet kabul edildiğinde değil, kayıt oluşturulduğunda sayılmaya başlar.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`FirstName`zorunlu	string	Body	Ad.
`LastName`zorunlu	string	Body	Soyadı.
`Email`zorunlu	string	Body	İş e-postası. Davet buraya gönderilir ve benzersiz olmalıdır.
`TeamId`zorunlu	string	Body	Tek bir ekiple sınırlar. Boş dize tüm ekipler anlamına gelir.
`Role`zorunlu	enumTypeOfAuthority	Body	Organizasyon içindeki erişim düzeyi.
`EmployeeCode`isteğe bağlı	string	Body	Bu kişi için kendi İK veya muhasebe referansınız.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/Employee/Create?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "FirstName": "Jane",
  "LastName": "Smith",
  "Email": "jane.smith@example.com",
  "TeamId": "65f1c0a3b8d4e21f9c0a1b40",
  "Role": 5,
  "EmployeeCode": "EMP-015"
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {}
}

POST/Employee/Update

Çalışanı güncelle

Kimlik, ekip ve rol bilgilerini günceller. Ücret ve faturalama oranları bu isteğin parçası değildir; maliyet ayarları endpoint'i üzerinden yönetilir.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`EmployeeId`zorunlu	string	Body	İşlem yapılacak çalışanın kimliği.
`FirstName`zorunlu	string	Body	Ad.
`LastName`zorunlu	string	Body	Soyadı.
`Email`zorunlu	string	Body	İş e-postası. Davet buraya gönderilir ve benzersiz olmalıdır.
`TeamId`zorunlu	string	Body	Tek bir ekiple sınırlar. Boş dize tüm ekipler anlamına gelir.
`Role`zorunlu	enumTypeOfAuthority	Body	Organizasyon içindeki erişim düzeyi.
`EmployeeCode`isteğe bağlı	string	Body	Bu kişi için kendi İK veya muhasebe referansınız.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/Employee/Update?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "EmployeeId": "65f1c0a3b8d4e21f9c0a1b2c",
  "FirstName": "John",
  "LastName": "Doe",
  "Email": "john.doe@example.com",
  "TeamId": "65f1c0a3b8d4e21f9c0a1b40",
  "Role": 4,
  "EmployeeCode": "EMP-014"
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {}
}

POST/Employee/Block

Çalışanı engelle

Bir çalışanı engeller. Masaüstü uygulaması kayıt almayı durdurur ve çalışan panel erişimini kaybeder, ancak geçmiş veriler ve raporlar korunur.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`Id`zorunlu	string	Body	Engellenecek çalışanın kimliği.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/Employee/Block?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "Id": "65f1c0a3b8d4e21f9c0a1b2c"
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {}
}

POST/Employee/ResendInvitation

Daveti yeniden gönder

Henüz kaydolmamış bir çalışana davet e-postasını yeniden gönderir.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`EmployeeId`zorunlu	string	Body	İşlem yapılacak çalışanın kimliği.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/Employee/ResendInvitation?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "EmployeeId": "65f1c0a3b8d4e21f9c0a1b2c"
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {}
}

POST/Employee/Delete

Çalışanı sil

Bir çalışanı kalıcı olarak siler. Panelde olduğu gibi, onay adımı için hesap sahibinin parolası gerekir.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`EmployeeId`zorunlu	string	Body	İşlem yapılacak çalışanın kimliği.
`Password`zorunlu	string	Body	Yıkıcı bir işlemi onaylamak için gereken hesap sahibi parolası.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/Employee/Delete?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "EmployeeId": "65f1c0a3b8d4e21f9c0a1b2c",
  "Password": "account-owner-password"
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {}
}

Ekipler

Ekipler çalışanları gruplar ve neredeyse her raporda filtre boyutu olarak kullanılır.

POST/Team/List

Ekipleri listele

Ekipleri renkleriyle ve isteğe bağlı olarak her ekipteki çalışan sayısıyla döndürür.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`SearchTerm`isteğe bağlı	string	Body	Serbest metin filtresi. Boş dize her şeyi döndürür.
`Page`isteğe bağlı	integer	Body	1'den başlayan sayfa numarası. Varsayılan 1.
`PageSize`isteğe bağlı	integer	Body	Sayfa başına kayıt sayısı. Varsayılan 15.
`TeamIds`isteğe bağlı	string[]	Body	Projeye atanan ekipler.
`IncludeEmployeeCount`isteğe bağlı	boolean	Body	Her ekipteki çalışan sayısını ekler.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/Team/List?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "SearchTerm": "",
  "Page": 1,
  "PageSize": 15,
  "IncludeEmployeeCount": true
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {
    "Items": [
      {
        "ID": "65f1c0a3b8d4e21f9c0a1b40",
        "Title": "Engineering",
        "Color": "#8b4dff",
        "OrganizationId": "65f1c0a3b8d4e21f9c0a1b50",
        "EmployeeCount": 12,
        "CreateDate": "2026-01-02T09:00:00Z"
      }
    ],
    "TotalCount": 1,
    "PageCount": 1
  }
}

POST/Team/AddOrUpdate

Ekip oluştur veya güncelle

Ekip oluşturmak için boş bir Id gönderin; adını ya da rengini değiştirmek için mevcut bir Id gönderin.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`Id`isteğe bağlı	string	Body	Ekip oluşturmak için boş bırakın, güncellemek için mevcut bir kimlik gönderin.
`Title`zorunlu	string	Body	Ekip adı.
`Color`isteğe bağlı	string	Body	Baştaki diyez dahil yedi karakterlik hex renk değeri, örneğin #8b4dff.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/Team/AddOrUpdate?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "Id": "",
  "Title": "Design",
  "Color": "#54a8c7"
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {
    "Item": {
      "ID": "65f1c0a3b8d4e21f9c0a1b41",
      "Title": "Design",
      "Color": "#54a8c7"
    }
  }
}

POST/Team/Delete

Ekibi sil

Bir ekibi siler. Çalışanlar silinmez, önce başka ekiplere atayın, yoksa ekipsiz kalırlar.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`Id`zorunlu	string	Body	Silinecek ekibin kimliği.
`Password`zorunlu	string	Body	Yıkıcı bir işlemi onaylamak için gereken hesap sahibi parolası.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/Team/Delete?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "Id": "65f1c0a3b8d4e21f9c0a1b41",
  "Password": "account-owner-password"
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {}
}

Zaman takibi

Puantaj, manuel zaman girişleri ve masaüstü uygulamasının kaydettiği ham aktivite akışı.

POST/Timesheet/List

Puantajı getir

Seçilen kapsam için çalışma, mola ve boşta geçen dakikaların gün gün dökümünü döndürür. Diğer liste endpoint'lerinin aksine bu sayfalanmaz; bunun yerine tarih aralığıyla daraltın.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`TeamId`isteğe bağlı	string	Body	Tek bir ekiple sınırlar. Boş dize tüm ekipler anlamına gelir.
`EmployeeId`isteğe bağlı	string	Body	Tek bir çalışanla sınırlar. Boş dize tüm çalışanlar anlamına gelir.
`DateFilter`isteğe bağlı	enumDateFilterType	Body	Hazır aralık. StartDate ve EndDate kullanmak için 10 (Custom) gönderin.
`StartDate`isteğe bağlı	datetime	Body	UTC ve ISO 8601 biçiminde aralık başlangıcı. DateFilter Custom olduğunda kullanılır.
`EndDate`isteğe bağlı	datetime	Body	UTC ve ISO 8601 biçiminde aralık bitişi. DateFilter Custom olduğunda kullanılır.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/Timesheet/List?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "TeamId": "",
  "EmployeeId": "65f1c0a3b8d4e21f9c0a1b2c",
  "DateFilter": 5,
  "StartDate": null,
  "EndDate": null
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {
    "Timesheet": [
      {
        "StartDate": "2026-01-15T00:00:00Z",
        "GetWorkTimesInsightsQueryResult": {
          "Items": [
            {
              "ID": "65f1c0a3b8d4e21f9c0a1b2c",
              "TotalMins": 510,
              "Working": 468,
              "OnBreak": 30,
              "Idle": 12,
              "Productive": 402,
              "Natural": 44,
              "Unproductive": 22,
              "ActivityLevel": 71,
              "ClockIn": "2026-01-15T08:58:00Z",
              "ClockOut": "2026-01-15T17:32:00Z"
            }
          ]
        }
      }
    ]
  }
}

POST/Timesheet/Export

Puantajı dışa aktar

Aynı veriyi e-tablo olarak üretir ve Data içinde bir indirme URL'i döndürür. Bağlantı geçicidir.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`TeamId`isteğe bağlı	string	Body	Tek bir ekiple sınırlar. Boş dize tüm ekipler anlamına gelir.
`EmployeeId`isteğe bağlı	string	Body	Tek bir çalışanla sınırlar. Boş dize tüm çalışanlar anlamına gelir.
`DateFilter`isteğe bağlı	enumDateFilterType	Body	Hazır aralık. StartDate ve EndDate kullanmak için 10 (Custom) gönderin.
`StartDate`isteğe bağlı	datetime	Body	UTC ve ISO 8601 biçiminde aralık başlangıcı. DateFilter Custom olduğunda kullanılır.
`EndDate`isteğe bağlı	datetime	Body	UTC ve ISO 8601 biçiminde aralık bitişi. DateFilter Custom olduğunda kullanılır.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/Timesheet/Export?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "TeamId": "",
  "EmployeeId": "",
  "DateFilter": 5
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": "https://worktivity.b-cdn.net/exports/timesheet-2026-01.xlsx"
}

POST/TimeEntry/List

Zaman girişlerini listele

Manuel olarak girilen zaman kayıtlarını onay durumu, belirtilen gerekçe ve varsa ret notuyla birlikte döndürür.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`SearchTerm`isteğe bağlı	string	Body	Serbest metin filtresi. Boş dize her şeyi döndürür.
`Page`isteğe bağlı	integer	Body	1'den başlayan sayfa numarası. Varsayılan 1.
`PageSize`isteğe bağlı	integer	Body	Sayfa başına kayıt sayısı. Varsayılan 15.
`EmployeeId`isteğe bağlı	string	Body	Tek bir çalışanla sınırlar. Boş dize tüm çalışanlar anlamına gelir.
`TeamId`isteğe bağlı	string	Body	Tek bir ekiple sınırlar. Boş dize tüm ekipler anlamına gelir.
`DateFilter`isteğe bağlı	enumDateFilterType	Body	Hazır aralık. StartDate ve EndDate kullanmak için 10 (Custom) gönderin.
`StartDate`isteğe bağlı	datetime	Body	UTC ve ISO 8601 biçiminde aralık başlangıcı. DateFilter Custom olduğunda kullanılır.
`EndDate`isteğe bağlı	datetime	Body	UTC ve ISO 8601 biçiminde aralık bitişi. DateFilter Custom olduğunda kullanılır.
`Status`isteğe bağlı	enumTimeEntryStatus	Body	Onay durumuna göre filtreler. Tüm durumları döndürmek için göndermeyin.
`IncludeEmployees`isteğe bağlı	boolean	Body	Dönen her satıra çalışan kaydını ekler.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/TimeEntry/List?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "Page": 1,
  "PageSize": 15,
  "EmployeeId": "",
  "TeamId": "",
  "DateFilter": 4,
  "Status": 0,
  "IncludeEmployees": true
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {
    "Items": [
      {
        "ID": "65f1c0a3b8d4e21f9c0a1c10",
        "EmployeeId": "65f1c0a3b8d4e21f9c0a1b2c",
        "Status": 0,
        "StartDate": "2026-01-15T09:00:00Z",
        "EndDate": "2026-01-15T17:00:00Z",
        "TotalMinutes": 480,
        "LogStatus": 1,
        "ProductivityStatus": 1,
        "Reason": "Forgot to clock in",
        "ProjectId": "65f1c0a3b8d4e21f9c0a1d00",
        "ProjectTaskId": "65f1c0a3b8d4e21f9c0a1d10"
      }
    ],
    "TotalCount": 1,
    "PageCount": 1
  }
}

POST/TimeEntry/Create

Zaman girişi oluştur

Bir çalışan adına manuel giriş ekler, çevrimdışı çalışma ya da unutulan bir mesai girişi için kullanışlıdır. Otomatik onay açık değilse giriş Pending olarak başlar.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`EmployeeId`zorunlu	string	Body	İşlem yapılacak çalışanın kimliği.
`StartDate`zorunlu	datetime	Body	İşin başladığı an, UTC olarak.
`EndDate`zorunlu	datetime	Body	İşin bittiği an, UTC olarak.
`ProjectId`isteğe bağlı	string	Body	Tek bir projeyle sınırlar. Boş dize tüm projeler anlamına gelir.
`ProjectTaskId`isteğe bağlı	string	Body	Tek bir görevle sınırlar. Boş dize tüm görevler anlamına gelir.
`Reason`zorunlu	string	Body	Girişin neden eklendiği. Onaylayan kişiye gösterilir.
`LogStatus`zorunlu	enumEmployeeActivityLogStatus	Body	Sürenin nasıl sınıflandırılacağı, çalışma, mola veya boşta.
`ProductivityStatus`zorunlu	enumProductivityStatus	Body	Giriş için verimlilik sınıflandırması.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/TimeEntry/Create?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "EmployeeId": "65f1c0a3b8d4e21f9c0a1b2c",
  "StartDate": "2026-01-15T09:00:00Z",
  "EndDate": "2026-01-15T17:00:00Z",
  "ProjectId": "65f1c0a3b8d4e21f9c0a1d00",
  "ProjectTaskId": "",
  "Reason": "Offline work on the migration script",
  "LogStatus": 1,
  "ProductivityStatus": 1
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {}
}

POST/TimeEntry/Approve

Zaman girişini onayla

Bekleyen bir girişi onaylar; dakikaları puantaja ve hak edişe işlenir.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`Id`zorunlu	string	Body	İşlem yapılacak zaman girişinin kimliği.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/TimeEntry/Approve?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "Id": "65f1c0a3b8d4e21f9c0a1c10"
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {}
}

POST/TimeEntry/Reject

Zaman girişini reddet

Bekleyen bir girişi reddeder. Gerekçe, çalışana kendi panelinde gösterilir.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`Id`zorunlu	string	Body	İşlem yapılacak zaman girişinin kimliği.
`RejectionReason`zorunlu	string	Body	Talep reddedildiğinde çalışana gösterilen açıklama.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/TimeEntry/Reject?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "Id": "65f1c0a3b8d4e21f9c0a1c10",
  "RejectionReason": "Overlaps an approved entry"
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {}
}

POST/ActivityLogs/List

Aktivite kayıtlarını listele

Masaüstü uygulamasının kaydettiği aralık bazlı ham akış: etkin uygulama, verimlilik sınıflandırması, aktivite düzeyi ve ekran görüntüsü referansı. Bu, en yüksek hacimli endpoint'tir. CreatedAfter ile sayfalayarak ilerleyin.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`SearchTerm`isteğe bağlı	string	Body	Serbest metin filtresi. Boş dize her şeyi döndürür.
`Page`isteğe bağlı	integer	Body	1'den başlayan sayfa numarası. Varsayılan 1.
`PageSize`isteğe bağlı	integer	Body	Sayfa başına kayıt sayısı. Varsayılan 15.
`EmployeeId`isteğe bağlı	string	Body	Tek bir çalışanla sınırlar. Boş dize tüm çalışanlar anlamına gelir.
`TeamId`isteğe bağlı	string	Body	Tek bir ekiple sınırlar. Boş dize tüm ekipler anlamına gelir.
`ProjectId`isteğe bağlı	string	Body	Tek bir projeyle sınırlar. Boş dize tüm projeler anlamına gelir.
`ProjectTaskId`isteğe bağlı	string	Body	Tek bir görevle sınırlar. Boş dize tüm görevler anlamına gelir.
`DateFilter`isteğe bağlı	enumDateFilterType	Body	Hazır aralık. StartDate ve EndDate kullanmak için 10 (Custom) gönderin.
`StartDate`isteğe bağlı	datetime	Body	UTC ve ISO 8601 biçiminde aralık başlangıcı. DateFilter Custom olduğunda kullanılır.
`EndDate`isteğe bağlı	datetime	Body	UTC ve ISO 8601 biçiminde aralık bitişi. DateFilter Custom olduğunda kullanılır.
`ActivityLogStatus`isteğe bağlı	enumEmployeeActivityLogStatus	Body	Akışı tek bir aktivite durumuna göre filtreler.
`HasScreenshot`isteğe bağlı	boolean	Body	Yalnızca ekran görüntüsü olan ya da olmayan aralıklar.
`ShowOnlyIdle`isteğe bağlı	boolean	Body	Yalnızca boşta geçen aralıkları döndürür.
`IncludeEmployees`isteğe bağlı	boolean	Body	Dönen her satıra çalışan kaydını ekler.
`IncludeOrganizationApps`isteğe bağlı	boolean	Body	Ad ve simge dahil uygulama ayrıntılarını ekler.
`CreatedAfter`isteğe bağlı	datetime	Body	Yalnızca bu UTC zaman damgasından sonra oluşturulan kayıtlar. Artımlı senkronizasyon için kullanın.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/ActivityLogs/List?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "Page": 1,
  "PageSize": 50,
  "EmployeeId": "65f1c0a3b8d4e21f9c0a1b2c",
  "DateFilter": 1,
  "HasScreenshot": true,
  "IncludeOrganizationApps": true
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {
    "Items": [
      {
        "ID": "65f1c0a3b8d4e21f9c0a1e00",
        "EmployeeId": "65f1c0a3b8d4e21f9c0a1b2c",
        "Title": "Visual Studio Code",
        "Status": 1,
        "Productivity": 1,
        "ActivityLevel": 78,
        "CreateDate": "2026-01-15T14:30:00Z",
        "Screenshot": "https://worktivity.b-cdn.net/...?X-Amz-Expires=172800",
        "LinkExpireDate": "2026-01-17T14:30:00Z",
        "OrganizationApp": {
          "ID": "65f1c0a3b8d4e21f9c0a1e10",
          "ActivityApp": {
            "Title": "Visual Studio Code"
          }
        }
      }
    ],
    "TotalCount": 1,
    "PageCount": 1
  }
}

Projeler ve görevler

Projeler, görevleri ve faturalandırıldıkları müşteriler.

POST/Project/List

Projeleri listele

Projeleri atanmış ekipleri ve çalışanları, bütçesi ve notlarıyla döndürür.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`SearchTerm`isteğe bağlı	string	Body	Serbest metin filtresi. Boş dize her şeyi döndürür.
`Page`isteğe bağlı	integer	Body	1'den başlayan sayfa numarası. Varsayılan 1.
`PageSize`isteğe bağlı	integer	Body	Sayfa başına kayıt sayısı. Varsayılan 15.
`TeamId`isteğe bağlı	string	Body	Tek bir ekiple sınırlar. Boş dize tüm ekipler anlamına gelir.
`CustomerId`isteğe bağlı	string	Body	Tek bir müşteriyle sınırlar. Boş dize tüm müşteriler anlamına gelir.
`CreatedAfter`isteğe bağlı	datetime	Body	Yalnızca bu UTC zaman damgasından sonra oluşturulan kayıtlar. Artımlı senkronizasyon için kullanın.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/Project/List?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "SearchTerm": "",
  "Page": 1,
  "PageSize": 15,
  "TeamId": "",
  "CustomerId": ""
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {
    "Items": [
      {
        "ID": "65f1c0a3b8d4e21f9c0a1d00",
        "Title": "Website Redesign",
        "Color": "#8b4dff",
        "CustomerId": "65f1c0a3b8d4e21f9c0a1f00",
        "TeamIds": [
          "65f1c0a3b8d4e21f9c0a1b40"
        ],
        "EmployeeIds": [
          "65f1c0a3b8d4e21f9c0a1b2c"
        ],
        "TotalBudget": 25000,
        "Notes": "Phase two",
        "CreateDate": "2026-01-04T08:00:00Z"
      }
    ],
    "TotalCount": 1,
    "PageCount": 1
  }
}

POST/Project/AddUpdateProject

Proje oluştur veya güncelle

Oluşturmak için boş bir Id gönderin. Renk, baştaki diyez dahil yedi karakterlik bir hex değeridir; TeamIds ve EmployeeIds alanlarının ikisi de gönderilmelidir.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`Id`isteğe bağlı	string	Body	Proje oluşturmak için boş bırakın, güncellemek için mevcut bir kimlik gönderin.
`Title`zorunlu	string	Body	Proje adı, en fazla 100 karakter.
`Color`zorunlu	string	Body	Baştaki diyez dahil yedi karakterlik hex renk değeri, örneğin #8b4dff.
`CustomerId`isteğe bağlı	string	Body	Tek bir müşteriyle sınırlar. Boş dize tüm müşteriler anlamına gelir.
`TeamIds`zorunlu	string[]	Body	Projeye atanan ekipler.
`EmployeeIds`zorunlu	string[]	Body	Projeye atanan çalışanlar.
`Notes`isteğe bağlı	string	Body	Proje üzerindeki dahili not, en fazla 500 karakter.
`TotalBudget`isteğe bağlı	decimal	Body	Organizasyonunuzun para biriminde proje bütçesi.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/Project/AddUpdateProject?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "Id": "",
  "Title": "Mobile App v2",
  "Color": "#45c4a0",
  "CustomerId": "65f1c0a3b8d4e21f9c0a1f00",
  "TeamIds": [
    "65f1c0a3b8d4e21f9c0a1b40"
  ],
  "EmployeeIds": [
    "65f1c0a3b8d4e21f9c0a1b2c"
  ],
  "Notes": "Kickoff in February",
  "TotalBudget": 40000
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {
    "Item": {
      "ID": "65f1c0a3b8d4e21f9c0a1d01",
      "Title": "Mobile App v2"
    }
  }
}

POST/Project/ListTasks

Görevleri listele

Bir projedeki görevleri durum, öncelik, atanan kişiler ve son tarihle birlikte döndürür.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`SearchTerm`isteğe bağlı	string	Body	Serbest metin filtresi. Boş dize her şeyi döndürür.
`Page`isteğe bağlı	integer	Body	1'den başlayan sayfa numarası. Varsayılan 1.
`PageSize`isteğe bağlı	integer	Body	Sayfa başına kayıt sayısı. Varsayılan 15.
`ProjectId`isteğe bağlı	string	Body	Tek bir projeyle sınırlar. Boş dize tüm projeler anlamına gelir.
`ExcludeTimeTracked`isteğe bağlı	boolean	Body	Üzerinde zaten kaydedilmiş süre bulunan görevleri hariç tutar.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/Project/ListTasks?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "ProjectId": "65f1c0a3b8d4e21f9c0a1d00",
  "Page": 1,
  "PageSize": 50
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {
    "Items": [
      {
        "ID": "65f1c0a3b8d4e21f9c0a1d10",
        "ProjectId": "65f1c0a3b8d4e21f9c0a1d00",
        "Title": "Design the homepage",
        "Details": "Initial mockups for desktop and mobile",
        "Status": 6,
        "Priority": 2,
        "OrderNo": 1,
        "AssigneeIds": [
          "65f1c0a3b8d4e21f9c0a1b2c"
        ],
        "DueDate": "2026-01-25T00:00:00Z",
        "NonBillable": false
      }
    ],
    "TotalCount": 1,
    "PageCount": 1
  }
}

POST/Project/AddUpdateTask

Görev oluştur veya güncelle

Oluşturmak için boş bir Id gönderin. Source, görevin nereden geldiğini kaydeder, kendi takip sisteminizdeki bir kayda bağlı kalması için ExternalTaskId kullanın.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`Id`isteğe bağlı	string	Body	Görev oluşturmak için boş bırakın, güncellemek için mevcut bir kimlik gönderin.
`ProjectId`zorunlu	string	Body	Tek bir projeyle sınırlar. Boş dize tüm projeler anlamına gelir.
`Title`zorunlu	string	Body	Görev başlığı, en fazla 500 karakter.
`Details`isteğe bağlı	string	Body	Görev açıklaması, en fazla 5000 karakter.
`Source`zorunlu	enumProjectTaskSource	Body	Görevin nereden geldiği, manuel giriş ya da bir entegrasyon.
`OrderNo`zorunlu	integer	Body	Proje panosundaki konum.
`AssigneeIds`zorunlu	string[]	Body	Göreve atanan çalışanlar.
`Status`zorunlu	enumProjectTaskStatus	Body	Görevin bulunduğu pano sütunu.
`Priority`isteğe bağlı	enumProjectTaskPriority	Body	Görev önceliği.
`DueDate`isteğe bağlı	datetime	Body	UTC ve ISO 8601 biçiminde son tarih.
`NonBillable`isteğe bağlı	boolean	Body	Bu görevde kaydedilen süreyi faturalamanın dışında tutar.
`ExternalTaskId`isteğe bağlı	string	Body	Görevi harici bir takip sistemine bağlı tutmak için kendi tanımlayıcınız.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/Project/AddUpdateTask?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "Id": "",
  "ProjectId": "65f1c0a3b8d4e21f9c0a1d00",
  "Title": "Wire up the pricing page",
  "Details": "Use the new plan matrix",
  "Source": 0,
  "OrderNo": 4,
  "AssigneeIds": [
    "65f1c0a3b8d4e21f9c0a1b2c"
  ],
  "Status": 0,
  "Priority": 2,
  "DueDate": "2026-02-10T00:00:00Z",
  "NonBillable": false
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {
    "Item": {
      "ID": "65f1c0a3b8d4e21f9c0a1d11",
      "Title": "Wire up the pricing page"
    }
  }
}

POST/Project/ListCustomers

Müşterileri listele

Projelerin faturalandırıldığı müşterileri döndürür. CustomerId ile proje oluştururken gereklidir.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`SearchTerm`isteğe bağlı	string	Body	Serbest metin filtresi. Boş dize her şeyi döndürür.
`Page`isteğe bağlı	integer	Body	1'den başlayan sayfa numarası. Varsayılan 1.
`PageSize`isteğe bağlı	integer	Body	Sayfa başına kayıt sayısı. Varsayılan 15.
`IncludeTrackStatistics`isteğe bağlı	boolean	Body	Müşteri başına kaydedilen süre toplamlarını ekler.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/Project/ListCustomers?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "SearchTerm": "",
  "Page": 1,
  "PageSize": 15
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {
    "Items": [
      {
        "ID": "65f1c0a3b8d4e21f9c0a1f00",
        "Title": "ABC Company",
        "CreateDate": "2025-11-20T12:00:00Z"
      }
    ],
    "TotalCount": 1,
    "PageCount": 1
  }
}

İçgörüler

Bir ekip, çalışan veya proje için toplulaştırılmış verimlilik, çalışma süresi ve uygulama kullanımı rakamları.

POST/Insights/Productivity

Verimlilik içgörüleri

Çalışan başına çalışma, mola ve boşta geçen dakika toplamları; verimlilik sınıflandırmasına göre ayrılmış ve beklenen çalışma saatleriyle arasındaki farkla birlikte. Saniye değil, dakika cinsindendir.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`TeamId`isteğe bağlı	string	Body	Tek bir ekiple sınırlar. Boş dize tüm ekipler anlamına gelir.
`EmployeeId`isteğe bağlı	string	Body	Tek bir çalışanla sınırlar. Boş dize tüm çalışanlar anlamına gelir.
`ProjectId`isteğe bağlı	string	Body	Tek bir projeyle sınırlar. Boş dize tüm projeler anlamına gelir.
`ProjectTaskId`isteğe bağlı	string	Body	Tek bir görevle sınırlar. Boş dize tüm görevler anlamına gelir.
`DateFilter`isteğe bağlı	enumDateFilterType	Body	Hazır aralık. StartDate ve EndDate kullanmak için 10 (Custom) gönderin.
`StartDate`isteğe bağlı	datetime	Body	UTC ve ISO 8601 biçiminde aralık başlangıcı. DateFilter Custom olduğunda kullanılır.
`EndDate`isteğe bağlı	datetime	Body	UTC ve ISO 8601 biçiminde aralık bitişi. DateFilter Custom olduğunda kullanılır.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/Insights/Productivity?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "TeamId": "",
  "EmployeeId": "",
  "DateFilter": 5
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {
    "Items": [
      {
        "ID": "65f1c0a3b8d4e21f9c0a1b2c",
        "TotalMins": 9600,
        "Working": 8820,
        "OnBreak": 540,
        "Idle": 240,
        "Productive": 7420,
        "Natural": 940,
        "Unproductive": 460,
        "ActivityLevel": 74,
        "ExpectedWorkHoursDiff": -180,
        "Status": 1,
        "Productivity": 1,
        "Employee": {
          "Id": "65f1c0a3b8d4e21f9c0a1b2c",
          "FirstName": "John"
        }
      }
    ]
  }
}

POST/Insights/WorkTimes

Çalışma süresi içgörüleri

Seçilen aralıkta mesai giriş ve çıkış davranışı, geç mesai girişleri dahil. Daraltmak için aktivite durumuna veya verimlilik sınıfına göre filtreleyin.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`TeamId`isteğe bağlı	string	Body	Tek bir ekiple sınırlar. Boş dize tüm ekipler anlamına gelir.
`EmployeeId`isteğe bağlı	string	Body	Tek bir çalışanla sınırlar. Boş dize tüm çalışanlar anlamına gelir.
`ProjectId`isteğe bağlı	string	Body	Tek bir projeyle sınırlar. Boş dize tüm projeler anlamına gelir.
`ProjectTaskId`isteğe bağlı	string	Body	Tek bir görevle sınırlar. Boş dize tüm görevler anlamına gelir.
`WorkNote`isteğe bağlı	string	Body	Çalışanın işine iliştirdiği nota göre filtreler.
`Statuses`isteğe bağlı	enum[]EmployeeActivityLogStatus	Body	Dahil edilecek aktivite durumları. Boş liste tümü anlamına gelir.
`ProductivityStatuses`isteğe bağlı	enum[]ProductivityStatus	Body	Dahil edilecek verimlilik sınıflandırmaları. Boş liste tümü anlamına gelir.
`DateFilter`isteğe bağlı	enumDateFilterType	Body	Hazır aralık. StartDate ve EndDate kullanmak için 10 (Custom) gönderin.
`StartDate`isteğe bağlı	datetime	Body	UTC ve ISO 8601 biçiminde aralık başlangıcı. DateFilter Custom olduğunda kullanılır.
`EndDate`isteğe bağlı	datetime	Body	UTC ve ISO 8601 biçiminde aralık bitişi. DateFilter Custom olduğunda kullanılır.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/Insights/WorkTimes?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "TeamId": "",
  "EmployeeId": "",
  "Statuses": [
    1,
    3
  ],
  "ProductivityStatuses": [],
  "DateFilter": 4
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {
    "Items": [
      {
        "ID": "65f1c0a3b8d4e21f9c0a1b2c",
        "TotalMins": 2400,
        "Working": 2180,
        "Idle": 120,
        "OnBreak": 100,
        "ClockIn": "2026-01-15T08:58:00Z",
        "ClockOut": "2026-01-15T17:32:00Z",
        "LateClockInCount": 1
      }
    ]
  }
}

POST/Insights/AppsSummary

Uygulama kullanım özeti

Seçilen kapsamda uygulama başına harcanan süre; her uygulamanın verimlilik sınıflandırması ve simgesiyle birlikte.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`TeamId`isteğe bağlı	string	Body	Tek bir ekiple sınırlar. Boş dize tüm ekipler anlamına gelir.
`EmployeeId`isteğe bağlı	string	Body	Tek bir çalışanla sınırlar. Boş dize tüm çalışanlar anlamına gelir.
`ProjectId`isteğe bağlı	string	Body	Tek bir projeyle sınırlar. Boş dize tüm projeler anlamına gelir.
`ProjectTaskId`isteğe bağlı	string	Body	Tek bir görevle sınırlar. Boş dize tüm görevler anlamına gelir.
`DateFilter`isteğe bağlı	enumDateFilterType	Body	Hazır aralık. StartDate ve EndDate kullanmak için 10 (Custom) gönderin.
`StartDate`isteğe bağlı	datetime	Body	UTC ve ISO 8601 biçiminde aralık başlangıcı. DateFilter Custom olduğunda kullanılır.
`EndDate`isteğe bağlı	datetime	Body	UTC ve ISO 8601 biçiminde aralık bitişi. DateFilter Custom olduğunda kullanılır.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/Insights/AppsSummary?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "TeamId": "",
  "EmployeeId": "",
  "DateFilter": 5
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {
    "Items": [
      {
        "ID": "65f1c0a3b8d4e21f9c0a1e10",
        "TotalMins": 1200,
        "Productive": 980,
        "Natural": 160,
        "Unproductive": 60,
        "ActivityApp": {
          "Title": "Visual Studio Code",
          "Icon": "https://worktivity.b-cdn.net/worktivity-public/apps/vscode.png"
        }
      }
    ]
  }
}

Ekran görüntüleri ve Timelapse

Alınan ekran görüntüleri ve üretilen Timelapse videoları. Medya URL'leri imzalıdır ve süresi dolar.

POST/Screenshots/List

Ekran görüntülerini listele

Alınan ekran görüntülerini döndürür. Screenshot alanı, süresi dolan imzalı bir URL'dir. URL'i saklamak yerine LinkExpireDate değerini kontrol edip yeniden isteyin.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`SearchTerm`isteğe bağlı	string	Body	Serbest metin filtresi. Boş dize her şeyi döndürür.
`Page`isteğe bağlı	integer	Body	1'den başlayan sayfa numarası. Varsayılan 1.
`PageSize`isteğe bağlı	integer	Body	Sayfa başına kayıt sayısı. Varsayılan 15.
`EmployeeId`isteğe bağlı	string	Body	Tek bir çalışanla sınırlar. Boş dize tüm çalışanlar anlamına gelir.
`TeamId`isteğe bağlı	string	Body	Tek bir ekiple sınırlar. Boş dize tüm ekipler anlamına gelir.
`DateFilter`isteğe bağlı	enumDateFilterType	Body	Hazır aralık. StartDate ve EndDate kullanmak için 10 (Custom) gönderin.
`StartDate`isteğe bağlı	datetime	Body	UTC ve ISO 8601 biçiminde aralık başlangıcı. DateFilter Custom olduğunda kullanılır.
`EndDate`isteğe bağlı	datetime	Body	UTC ve ISO 8601 biçiminde aralık bitişi. DateFilter Custom olduğunda kullanılır.
`HasScreenshot`isteğe bağlı	boolean	Body	Yalnızca ekran görüntüsü olan ya da olmayan aralıklar.
`IncludeEmployees`isteğe bağlı	boolean	Body	Dönen her satıra çalışan kaydını ekler.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/Screenshots/List?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "Page": 1,
  "PageSize": 50,
  "EmployeeId": "65f1c0a3b8d4e21f9c0a1b2c",
  "DateFilter": 1,
  "HasScreenshot": true
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {
    "Items": [
      {
        "ID": "65f1c0a3b8d4e21f9c0a1e00",
        "EmployeeId": "65f1c0a3b8d4e21f9c0a1b2c",
        "Screenshot": "https://worktivity.b-cdn.net/...?X-Amz-Expires=172800",
        "LinkExpireDate": "2026-01-17T14:30:00Z",
        "ObjectKey": "screenshots/2026/01/15/abc.jpg",
        "Status": 1,
        "CreateDate": "2026-01-15T14:30:00Z"
      }
    ],
    "TotalCount": 1,
    "PageCount": 1
  }
}

POST/Screenshots/Delete

Ekran görüntüsünü sil

Tek bir ekran görüntüsünü ve saklanan dosyasını kalıcı olarak siler. İlgili aktivite kaydı korunur.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`Id`zorunlu	string	Body	Silinecek ekran görüntüsünün kimliği.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/Screenshots/Delete?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "Id": "65f1c0a3b8d4e21f9c0a1e00"
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": true
}

POST/TimelapseVideos/List

Timelapse videolarını listele

Üretilen Timelapse videolarını küçük görsel, video URL'i ve dosya boyutuyla döndürür. İki URL de imzalıdır ve süresi dolar.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`SearchTerm`isteğe bağlı	string	Body	Serbest metin filtresi. Boş dize her şeyi döndürür.
`Page`isteğe bağlı	integer	Body	1'den başlayan sayfa numarası. Varsayılan 1.
`PageSize`isteğe bağlı	integer	Body	Sayfa başına kayıt sayısı. Varsayılan 15.
`EmployeeId`isteğe bağlı	string	Body	Tek bir çalışanla sınırlar. Boş dize tüm çalışanlar anlamına gelir.
`TeamId`isteğe bağlı	string	Body	Tek bir ekiple sınırlar. Boş dize tüm ekipler anlamına gelir.
`DateFilter`isteğe bağlı	enumDateFilterType	Body	Hazır aralık. StartDate ve EndDate kullanmak için 10 (Custom) gönderin.
`StartDate`isteğe bağlı	datetime	Body	UTC ve ISO 8601 biçiminde aralık başlangıcı. DateFilter Custom olduğunda kullanılır.
`EndDate`isteğe bağlı	datetime	Body	UTC ve ISO 8601 biçiminde aralık bitişi. DateFilter Custom olduğunda kullanılır.
`TimelapseVideoIds`isteğe bağlı	string[]	Body	Belirli bir video kimliği kümesiyle sınırlar.
`IncludeEmployees`isteğe bağlı	boolean	Body	Dönen her satıra çalışan kaydını ekler.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/TimelapseVideos/List?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "Page": 1,
  "PageSize": 20,
  "EmployeeId": "65f1c0a3b8d4e21f9c0a1b2c",
  "DateFilter": 4,
  "IncludeEmployees": true
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {
    "Items": [
      {
        "ID": "65f1c0a3b8d4e21f9c0a1e50",
        "EmployeeId": "65f1c0a3b8d4e21f9c0a1b2c",
        "Url": "https://worktivity.b-cdn.net/...thumb.jpg",
        "VideoUrl": "https://worktivity.b-cdn.net/...timelapse.mp4",
        "Filename": "2026-01-15-john-doe.mp4",
        "FileSizeMb": 18.4,
        "LinkExpireDate": "2026-01-17T14:30:00Z",
        "CreateDate": "2026-01-15T18:00:00Z"
      }
    ],
    "TotalCount": 1,
    "PageCount": 1
  }
}

Maliyet yönetimi

Kaydedilen süre ve ücret oranlarından türetilen hak ediş toplamları, ayrıca müşteri faturaları.

POST/CostManagement/Payroll

Hak ediş hesapla

Belirtilen tarih aralığı için çalışan başına kaydedilen dakikaları, ortalama ücret oranını ve ödenecek tutarı döndürür. Boşta veya mola süresini dışarıda bırakmak için aktivite durumuna göre filtreleyin.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`TeamId`isteğe bağlı	string	Body	Tek bir ekiple sınırlar. Boş dize tüm ekipler anlamına gelir.
`EmployeeId`isteğe bağlı	string	Body	Tek bir çalışanla sınırlar. Boş dize tüm çalışanlar anlamına gelir.
`ProjectId`isteğe bağlı	string	Body	Tek bir projeyle sınırlar. Boş dize tüm projeler anlamına gelir.
`ProjectTaskId`isteğe bağlı	string	Body	Tek bir görevle sınırlar. Boş dize tüm görevler anlamına gelir.
`Statuses`isteğe bağlı	enum[]EmployeeActivityLogStatus	Body	Dahil edilecek aktivite durumları. Boş liste tümü anlamına gelir.
`ProductivityStatuses`isteğe bağlı	enum[]ProductivityStatus	Body	Dahil edilecek verimlilik sınıflandırmaları. Boş liste tümü anlamına gelir.
`StartDate`isteğe bağlı	datetime	Body	UTC ve ISO 8601 biçiminde aralık başlangıcı. DateFilter Custom olduğunda kullanılır.
`EndDate`isteğe bağlı	datetime	Body	UTC ve ISO 8601 biçiminde aralık bitişi. DateFilter Custom olduğunda kullanılır.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/CostManagement/Payroll?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "TeamId": "",
  "EmployeeId": "",
  "Statuses": [
    1
  ],
  "StartDate": "2026-01-01T00:00:00Z",
  "EndDate": "2026-01-31T23:59:59Z"
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {
    "Items": [
      {
        "ID": "65f1c0a3b8d4e21f9c0a1b2c",
        "TotalMins": 9600,
        "TotalSpent": 4000,
        "AvgPayRate": 25,
        "TotalPayable": 4000,
        "Employee": {
          "Id": "65f1c0a3b8d4e21f9c0a1b2c",
          "FirstName": "John",
          "LastName": "Doe"
        }
      }
    ]
  }
}

POST/CostManagement/ListInvoices

Faturaları listele

Müşteri faturalarını durumu, toplamı ve vade tarihiyle döndürür.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`SearchTerm`isteğe bağlı	string	Body	Serbest metin filtresi. Boş dize her şeyi döndürür.
`Page`isteğe bağlı	integer	Body	1'den başlayan sayfa numarası. Varsayılan 1.
`PageSize`isteğe bağlı	integer	Body	Sayfa başına kayıt sayısı. Varsayılan 15.
`CustomerId`isteğe bağlı	string	Body	Tek bir müşteriyle sınırlar. Boş dize tüm müşteriler anlamına gelir.
`Status`isteğe bağlı	enumOrganizationCustomerInvoiceStatus	Body	Fatura durumuna göre filtreler. Tüm durumları döndürmek için göndermeyin.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/CostManagement/ListInvoices?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "Page": 1,
  "PageSize": 15,
  "CustomerId": "",
  "Status": 2
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {
    "Items": [
      {
        "ID": "65f1c0a3b8d4e21f9c0a1f50",
        "Title": "INV-2026-001",
        "CustomerId": "65f1c0a3b8d4e21f9c0a1f00",
        "Status": 2,
        "Total": 5000,
        "DueDate": "2026-02-15T00:00:00Z",
        "CreateDate": "2026-01-15T00:00:00Z"
      }
    ],
    "TotalCount": 1,
    "PageCount": 1
  }
}

İzin yönetimi

İzin hakları, izin talepleri ve onay işlemleri.

POST/LeaveManagement/ListLeaveRights

İzin haklarını listele

Her çalışanın izin hakkını türe göre, kullanılan ve kalan gün sayısıyla birlikte döndürür.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`SearchTerm`isteğe bağlı	string	Body	Serbest metin filtresi. Boş dize her şeyi döndürür.
`Page`isteğe bağlı	integer	Body	1'den başlayan sayfa numarası. Varsayılan 1.
`PageSize`isteğe bağlı	integer	Body	Sayfa başına kayıt sayısı. Varsayılan 15.
`TeamId`isteğe bağlı	string	Body	Tek bir ekiple sınırlar. Boş dize tüm ekipler anlamına gelir.
`EmployeeId`isteğe bağlı	string	Body	Tek bir çalışanla sınırlar. Boş dize tüm çalışanlar anlamına gelir.
`Type`isteğe bağlı	enumLeaveRightType	Body	İzin türü, örneğin yıllık izin veya hastalık izni.
`StartDate`isteğe bağlı	datetime	Body	UTC ve ISO 8601 biçiminde aralık başlangıcı. DateFilter Custom olduğunda kullanılır.
`EndDate`isteğe bağlı	datetime	Body	UTC ve ISO 8601 biçiminde aralık bitişi. DateFilter Custom olduğunda kullanılır.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/LeaveManagement/ListLeaveRights?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "Page": 1,
  "PageSize": 15,
  "TeamId": "",
  "EmployeeId": ""
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {
    "Items": [
      {
        "ID": "65f1c0a3b8d4e21f9c0a2a00",
        "EmployeeId": "65f1c0a3b8d4e21f9c0a1b2c",
        "Type": 1,
        "TotalDays": 20,
        "UsedDays": 6,
        "RemainingDays": 14
      }
    ],
    "TotalCount": 1,
    "PageCount": 1
  }
}

POST/LeaveManagement/ListLeaveRequests

İzin taleplerini listele

İzin taleplerini türü, tarih aralığı ve onay durumuyla döndürür.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`SearchTerm`isteğe bağlı	string	Body	Serbest metin filtresi. Boş dize her şeyi döndürür.
`Page`isteğe bağlı	integer	Body	1'den başlayan sayfa numarası. Varsayılan 1.
`PageSize`isteğe bağlı	integer	Body	Sayfa başına kayıt sayısı. Varsayılan 15.
`TeamId`isteğe bağlı	string	Body	Tek bir ekiple sınırlar. Boş dize tüm ekipler anlamına gelir.
`EmployeeId`isteğe bağlı	string	Body	Tek bir çalışanla sınırlar. Boş dize tüm çalışanlar anlamına gelir.
`Type`isteğe bağlı	enumLeaveRightType	Body	İzin türü, örneğin yıllık izin veya hastalık izni.
`Status`isteğe bağlı	enumLeaveRequestStatus	Body	Onay durumuna göre filtreler. Tüm durumları döndürmek için göndermeyin.
`StartDate`isteğe bağlı	datetime	Body	UTC ve ISO 8601 biçiminde aralık başlangıcı. DateFilter Custom olduğunda kullanılır.
`EndDate`isteğe bağlı	datetime	Body	UTC ve ISO 8601 biçiminde aralık bitişi. DateFilter Custom olduğunda kullanılır.
`CreatedAfter`isteğe bağlı	datetime	Body	Yalnızca bu UTC zaman damgasından sonra oluşturulan kayıtlar. Artımlı senkronizasyon için kullanın.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/LeaveManagement/ListLeaveRequests?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "Page": 1,
  "PageSize": 15,
  "EmployeeId": "",
  "Status": 0
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {
    "Items": [
      {
        "ID": "65f1c0a3b8d4e21f9c0a2b00",
        "EmployeeId": "65f1c0a3b8d4e21f9c0a1b2c",
        "Type": 1,
        "Status": 0,
        "StartDate": "2026-02-10T00:00:00Z",
        "EndDate": "2026-02-14T00:00:00Z",
        "TotalDays": 5
      }
    ],
    "TotalCount": 1,
    "PageCount": 1
  }
}

POST/LeaveManagement/ApproveLeaveRequest

İzin talebini onayla

Bekleyen bir izin talebini onaylar ve günleri ilgili izin hakkından düşer.

Parametreler

Ad	Tür	Konum	Açıklama
`x_api_key`zorunlu	string	Query	Organizasyonunuzun API anahtarı. Her istekte zorunludur.
`Id`zorunlu	string	Body	Onaylanacak izin talebinin kimliği.

İstek

cURL

curl -X POST "https://open-api.useworktivity.com/LeaveManagement/ApproveLeaveRequest?x_api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "Id": "65f1c0a3b8d4e21f9c0a2b00"
}'

Yanıt

JSON

{
  "HasError": false,
  "Message": null,
  "ValidationErrors": [],
  "Data": {}
}

Enum referansı

Enum alanları tam sayı olarak gönderilir ve döner. Aşağıdaki değerler kararlıdır, ancak yetkili kaynak Definition/ListEnums'tır; burada listelenmeyen enum'ların görünen adlarını da içerir.

DateFilterType

Değer	Ad
1	Today
2	Yesterday
3	Last3Days
4	Last7Days
5	Last30Days
10	Custom

TypeOfAuthority

Değer	Ad
0	User
1	Admin
2	Owner
3	Coowner
4	Manager
5	Employee

EmployeeActivityLogStatus

Değer	Ad
0	ClockIn
1	Working
2	OnBreak
3	Idle
4	ClockOut
5	YetToStart

ProductivityStatus

Değer	Ad
1	Productive
2	Natural
3	Unproductive

TimeEntryStatus

Değer	Ad
0	Pending
1	Approved
2	Rejected

ProjectTaskStatus

Değer	Ad
0	Todo
1	Completed
2	Cancelled
3	OnHold
4	Postponed
5	UnderReview
6	InProgress

OrganizationCustomerInvoiceStatus

Değer	Ad
1	Draft
2	Sent
3	PartiallyPaid
4	Paid

Etkileşimli deneyin

Swagger UI bu dokümantasyonu birebir yansıtır ve bu sayfada yer almayan endpoint'ler dahil, doğrudan tarayıcıdan kimlik doğrulanmış istek göndermenizi sağlar.

Swagger UI'ı açın

Worktivity'yi kendi sisteminize bağlamaya hazır mısınız?

Ücretsiz denemeyi başlatın, panelden bir anahtar üretin ve ilk çağrınızı dakikalar içinde yapın. Her pakette tam API erişimi vardır.

Ücretsiz denemeyi başlatın Bize yazın

14 günlük ücretsiz deneme. Kredi kartı gerekmez.