Skip to Content
DevelopersAPI referenceTime

Summary (time reports)

GET
/v1/time/reports/summary

Authorization

apiKey
headerAuthorizationBearer <token>

An API key (blk_…) from Settings → API keys.

Query Parameters

from*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatdate
to*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatdate
memberId?|array<>
projectId?|array<>
clientId?|array<>
tagId?|array<>
withoutProject?"true"
Value in"true"
billable?string
Value in"true""false"
q?string
Lengthlength <= 200
rounded?string
Value in"true""false"
groupBy?string
Default"project"
Value in"project""client""member""tag""task""date"

Response Body

application/json
  1. response
from*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatdate
to*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatdate
days*array<>
totalSeconds*integer
Range-9007199254740991 <= value <= 9007199254740991
billableSeconds*integer
Range-9007199254740991 <= value <= 9007199254740991
amounts*array<>
costs*array<>
byDay*array<>
groups*array<>
rounding*|null
Example Request
curl -X GET 'https://your-billleaf-api/v1/time/reports/summary?from=2019-08-24&to=2019-08-24'
Example Response200
{  "from": "2019-08-24",  "to": "2019-08-24",  "days": [    "2019-08-24"  ],  "totalSeconds": -9007199254740991,  "billableSeconds": -9007199254740991,  "amounts": [    {      "currency": "string",      "amount": -9007199254740991    }  ],  "costs": [    {      "currency": "string",      "amount": -9007199254740991    }  ],  "byDay": [    {      "date": "2019-08-24",      "seconds": -9007199254740991,      "billableSeconds": -9007199254740991    }  ],  "groups": [    {      "key": "string",      "label": "string",      "detail": "string",      "seconds": -9007199254740991,      "billableSeconds": -9007199254740991,      "amounts": [        {          "currency": "string",          "amount": -9007199254740991        }      ],      "costs": [        {          "currency": "string",          "amount": -9007199254740991        }      ],      "byDay": [        -9007199254740991      ]    }  ],  "rounding": {    "mode": "off",    "minutes": -9007199254740991  }}