API Documentation
Time Reports ¶
Time Reports ¶
Supported filter params
-
group (person, service, service_type, budget, project, company, year, quarter, month, week, day)
-
person_id (array)
-
service_id (array)
-
service_type_id (array)
-
budget_id (array)
-
project_id (array)
-
company_id (array)
-
person_tags
-
budget_tags
-
after
-
before
-
role_id (array)
Supported sort params
-
year
-
quarter
-
month
-
week
-
day
-
capacity
-
available_time
-
scheduled_time
-
scheduled_internal_time
-
scheduled_client_time
-
internal_time
-
client_time
-
billable_time
-
unapproved_time
-
worked_time
-
worked_available_diff
-
client_worked_ratio
-
worked_available_ratio
-
worked_scheduled_ratio
-
available_capacity_ratio
-
billable_available_ratio
-
billable_client_ratio
-
billable_worked_ratio
-
client_available_ratio
-
scheduled_available_ratio
GET /api/v2/time_reports
Requests
GET /api/v2/time_reports?filter[person_id]=4739
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": [],
"links": {
"first": "http://www.example.com/api/v2/time_reports?filter%5Bperson_id%5D=4739&page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/time_reports?filter%5Bperson_id%5D=4739&page%5Bnumber%5D=0&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 0,
"total_count": 0,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Get time reportsGET/api/v2/time_reports
Generated by aglio on 23 Jan 2021