Your browser is not up to date. This may cause security, speed, and display
issues. Please update your browser.
Update Browser
X
Clockodo API:
Read entry texts
Endpoint api/v2/entriesTexts
With this resource you can read descriptions of time and lump sum entries. Editing and adding descriptions is currently not possible.
New API documentation
Feel free to use our updated API documentation.
Content
List entry descriptions
Request
GET /api/v2/entriesTexts
| Required parameters | text |
string
text to search for
|
|---|
| Optional parameters | mode |
string
"exact_match": descriptions that exactly match the submitted text (default) "starts_with": descriptions that start with the submitted text fragment "ends_with": descriptions that end with the submitted text fragment "contains": descriptions that contain the submitted text fragment |
|---|---|---|
| sort |
string
Sorting of the search results: "text_asc": alphabetically ascending (default) "text_desc": alphabetically descending "time_asc": chronologically ascending "time_desc": chronologically descending | |
| filter[time_since] |
string
in format ISO 8601 UTC, e.g. "2021-06-30T12:34:56Z"
| |
| filter[time_until] |
string
in format ISO 8601 UTC, e.g. "2021-06-30T12:34:56Z"
| |
| filter[users_id] |
integer
| |
| filter[customers_id] |
integer
| |
| filter[projects_id] |
integer
| |
| filter[services_id] |
integer
| |
| filter[lumpsum_services_id] |
integer
| |
| filter[billable] |
integer
0, 1 or 2 With the request filter[billable]=2 you only receive entries which are billable and already billed |
Because the result can have many entry descriptions, the use of page-by-page output is enabled for this request.
Response
{
"paging": [paging information],
"filter": [list of respected filters],
"mode": [selected mode],
"sort": [selected sorting],
"texts":
{
[id]: [text],
[id]: [text],
...
}
}