{"id":22728,"date":"2025-04-17T14:06:01","date_gmt":"2025-04-17T14:06:01","guid":{"rendered":"https:\/\/clockify.me\/help\/?p=22728"},"modified":"2026-04-22T12:32:13","modified_gmt":"2026-04-22T12:32:13","slug":"how-to-export-data-via-api","status":"publish","type":"post","link":"https:\/\/clockify.me\/help\/troubleshooting\/general-api-troubleshooting\/how-to-export-data-via-api","title":{"rendered":"How to export data via API"},"content":{"rendered":"\n

You can export data (e.g. reports) using the following API call. The key-value parameter for export type is exportType<\/code>. Available values include JSON<\/code>, CSV<\/code>, XLSX<\/code>, and PDF<\/code>.<\/p>\n\n\n\n

<\/rect><\/mask><\/path><\/g><\/svg>Note<\/span><\/div>
\n

If you are on a Free plan, you can only have 30 API requests per hour for the free workspace.<\/p>\n\n\n\n

Export to CSV\/Excel is a paid feature available in Basic plan or higher.<\/p>\n<\/div><\/div>\n\n\n\n

Example: Exporting Detailed Report as CSV<\/strong><\/h4>\n\n\n\n
POST \/v1\/workspaces\/{workspaceId}\/reports\/detailed<\/code><\/a><\/code><\/pre>\n\n\n\n
Headers:<\/p>\n\n\n\n
\"X-Api-Key\": \"yourApiKey\", \n \n\"Content-Type\":\"application\/json\"\n\n  <\/code><\/pre>\n\n\n\n
Body: <\/p>\n\n\n\n
{\n\n  \"dateRangeStart\": \"2024-01-01T00:00:00.000\",\n\n  \"dateRangeEnd\": \"2024-12-31T23:59:59.000\",\n\n  \"exportType\": \"CSV\",\n\n  \"detailedFilter\": {\n\n    \"page\": 1,\n\n    \"pageSize\": 1000\n\n  }\n\n}\n\n\n<\/code><\/pre>\n\n\n\n
Example: Exporting Summary Report as CSV<\/strong><\/h4>\n\n\n\n
POST \/v1\/workspaces\/{workspaceId}\/reports\/summary<\/a><\/code><\/code><\/pre>\n\n\n\n
Headers:<\/p>\n\n\n\n
\"X-Api-Key\": \"yourApiKey\", \n \n\"Content-Type\":\"application\/json\"<\/code><\/pre>\n\n\n\n
<\/p>\n\n\n\n
Body:<\/p>\n\n\n\n
{\n\n  \"dateRangeStart\": \"2018-11-01T00:00:00Z\",\n\n  \"dateRangeEnd\": \"2018-11-30T23:59:59.999Z\",\n\n  \"exportType\": \"JSON\",\n\n  \"summaryFilter\": {\n\n    \"groups\": 1,\n\n    \"sortColumn\": GROUP\n\n    \"summaryChartType\": \"PROJECT\"\n\n    \"page\": 1,\n\n    \"pageSize\": 1000\n\n  }\n\n}<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"You can export data (e.g. reports) using the following API call. The key-value p…","protected":false},"author":25,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"_helpful_status":1,"_searchwp_excluded":"","footnotes":""},"categories":[73],"tags":[],"class_list":["post-22728","post","type-post","status-publish","format-standard","hentry","category-general-api-troubleshooting"],"acf":[],"featured_image_src":null,"author_info":{"display_name":"tamara radijevac","author_link":"https:\/\/clockify.me\/help\/author\/tamara-radijevac"},"_links":{"self":[{"href":"https:\/\/clockify.me\/help\/wp-json\/wp\/v2\/posts\/22728","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/clockify.me\/help\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/clockify.me\/help\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/clockify.me\/help\/wp-json\/wp\/v2\/users\/25"}],"replies":[{"embeddable":true,"href":"https:\/\/clockify.me\/help\/wp-json\/wp\/v2\/comments?post=22728"}],"version-history":[{"count":7,"href":"https:\/\/clockify.me\/help\/wp-json\/wp\/v2\/posts\/22728\/revisions"}],"predecessor-version":[{"id":30971,"href":"https:\/\/clockify.me\/help\/wp-json\/wp\/v2\/posts\/22728\/revisions\/30971"}],"wp:attachment":[{"href":"https:\/\/clockify.me\/help\/wp-json\/wp\/v2\/media?parent=22728"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/clockify.me\/help\/wp-json\/wp\/v2\/categories?post=22728"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/clockify.me\/help\/wp-json\/wp\/v2\/tags?post=22728"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}