Qodex.ai

List Agent Time Entries

GET {{baseUrl}}/api/v1/agents/:agent_id/timeEntry

This API lists the time entries associated with an agent.

OAuth Scope

  • Desk.settings.READ

Request Params

KeyDatatypeRequiredDescription
modulestringModule from which the time entries must be fetched. Values allowed are tickets and tasks.
departmentIdstringID of the department
fromstringIndex number, starting from which the time entries must be fetched
limitstringNumber of time entries to fetch
orderBystringKey that sorts the time entries in ascending or descending order, based on the executedTime attribute. Values allowed are ASC (default) and DESC.
includestringSecondary information related to the time entry. Value supported is owner.
billStatusstringKey that filters time entries, based on their billing status: nonBillable , billable or billed
createdTimeRangestringKey that filters time entries created in a particular period of time. Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ; for example, createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z.
modifiedTimeRangestringKey that filters time entries whose details were modified in a particular period of time. Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ; for example, modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"data":[{"owner":{"firstName":"Eswer","lastName":"KM","photoURL":"https://contacts.zoho.com/file?t=user\u0026ID=4851669","name":"Eswer KM","id":"4000000008688129"},"secondsSpent":"21","parent":{"ticketNumber":"1001","associatedTicketId":"4000000031007","subject":"Task subject","id":"4000000031010","type":"TASKS"},"executedTime":"2016-06-22T20:30:00.000Z","fixedCost":null,"departmentId":"4000000008694","minutesSpent":"23","creatorId":"4000000008692","agentCostPerHour":"3.0","description":"Time Entry description","hoursSpent":"3","ownerId":"4000000008692","isBillable":true,"mode":"MANUAL","isTrashed":"false","billingType":"FIXED_COST_FOR_TICKETS","createdTime":"2016-06-16T07:24:44.000Z","invoiceId":"40000000086881212","id":"4000000033001","requestChargeType":"Customer Service","additionalCost":"10.0","totalCost":"20.17"},{"owner":{"firstName":"Eswer","lastName":"KM","photoURL":"https://contacts.zoho.com/file?t=user\u0026ID=4851669","name":"Eswer KM","id":"4000000008688129"},"secondsSpent":"21","parent":{"ticketNumber":"1001","associatedTicketId":"4000000031007","subject":"Task subject","id":"4000000031010","type":"TASKS"},"executedTime":"2016-06-24T19:30:00.000Z","fixedCost":null,"departmentId":"4000000008694","minutesSpent":"34","creatorId":"4000000008692","agentCostPerHour":"10.0","description":"Time Entry description","hoursSpent":"3","ownerId":"4000000012090","isBillable":true,"mode":"MANUAL","isTrashed":"false","billingType":"FIXED_COST_FOR_TICKETS","createdTime":"2016-06-16T07:46:39.000Z","invoiceId":"40000000086881212","id":"4000000033006","requestChargeType":"Product Consultation","additionalCost":"10.0","totalCost":"45.72"},{"owner":{"firstName":"Eswer","lastName":"KM","photoURL":"https://contacts.zoho.com/file?t=user\u0026ID=4851669","name":"Eswer KM","id":"4000000008688129"},"secondsSpent":"22","parent":{"ticketNumber":"1001","associatedTicketId":"4000000031007","subject":"Task subject","id":"4000000031010","type":"TASKS"},"executedTime":"2016-06-13T19:30:00.000Z","fixedCost":null,"departmentId":"4000000008694","minutesSpent":"22","creatorId":"4000000008692","agentCostPerHour":"20.0","description":"Time Entry description","hoursSpent":"32","ownerId":"4000000008692","isBillable":true,"mode":"MANUAL","isTrashed":"false","billingType":"FIXED_COST_FOR_TICKETS","createdTime":"2016-06-16T07:49:52.000Z","invoiceId":"40000000086881212","id":"4000000033011","requestChargeType":"Customer Service","additionalCost":"10.0","totalCost":"657.46"}]}