API Documentation

API Endpoint

Timesheet Reports

Timesheet Reports

Supported filter params

  • person_id (array)

  • tags

  • after

  • before

GET /api/v2/reports/timesheet_reports
Requestsreturns timesheet reportsreturns timesheet reports

GET  /api/v2/reports/timesheet_reports?filter[person_id]=7110

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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "2024/W13-person-7110-53f2231439630d1bd404d546bd7e44b4",
      "type": "timesheet_reports",
      "attributes": {
        "week": "2024/W13",
        "monday_time": 0,
        "monday_capacity": null,
        "monday_available": null,
        "tuesday_time": 0,
        "tuesday_capacity": null,
        "tuesday_available": null,
        "wednesday_time": 0,
        "wednesday_capacity": null,
        "wednesday_available": null,
        "thursday_time": 480,
        "thursday_capacity": null,
        "thursday_available": null,
        "friday_time": 0,
        "friday_capacity": null,
        "friday_available": null,
        "saturday_time": 0,
        "saturday_capacity": null,
        "saturday_available": null,
        "sunday_time": 0,
        "sunday_capacity": null,
        "sunday_available": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1785"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "7110"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "7110",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "deactivated_at": null,
        "first_name": "name",
        "last_name": "surname",
        "nickname": null,
        "role_id": 3,
        "email": "user7030@email.com",
        "title": null,
        "contact": {},
        "status_emoji": null,
        "status_expires_at": null,
        "status_text": null,
        "joined_at": null,
        "last_seen_at": null,
        "archived_at": null,
        "invited_at": "2024-03-28T05:15:00.000+01:00",
        "is_user": true,
        "user_id": 7087,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2024-03-28T05:15:00.123+01:00",
        "placeholder": false,
        "color_id": null,
        "sample_data": false,
        "time_unlocked": false,
        "time_unlocked_on": null,
        "time_unlocked_start_date": null,
        "time_unlocked_end_date": null,
        "time_unlocked_period_id": null,
        "time_unlocked_interval": null,
        "last_activity_at": "2024-03-28T05:15:00.123+01:00",
        "two_factor_auth": false,
        "availabilities": "[]",
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1785"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5468"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "7475"
          }
        },
        "teams": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "5468",
      "type": "companies",
      "attributes": {
        "name": "Organization1785",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2024-03-28T05:15:00.109+01:00",
        "last_activity_at": "2024-03-28T05:15:00.109+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "ORGA",
        "domain": null,
        "projectless_budgets": false,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false,
        "settings": {},
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1785"
          }
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "7475",
      "type": "roles",
      "attributes": {
        "base_role_id": 3,
        "description": "test description",
        "name": "test_role",
        "people_count": 1,
        "permissions": {},
        "editable_by_user": false,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1785"
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/reports/timesheet_reports?filter%5Bperson_id%5D=7110&page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/reports/timesheet_reports?filter%5Bperson_id%5D=7110&page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 10
      },
      "workflows": {
        "type": "metered",
        "limit": 10
      },
      "rate_cards": {
        "type": "metered",
        "limit": 30
      },
      "teams": {
        "type": "metered",
        "limit": 20
      },
      "outgoing_emails": {
        "type": "metered",
        "limit": 100
      },
      "recycle_bin": {
        "type": "metered",
        "limit": 730
      },
      "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
      },
      "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
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      },
      "time_locking": {
        "type": "switch",
        "available": true
      },
      "docs": {
        "type": "switch",
        "available": true
      },
      "scheduling_resource_utilization": {
        "type": "switch",
        "available": true
      },
      "enforce_two_factor_auth": {
        "type": "switch",
        "available": true
      },
      "personio_integration": {
        "type": "switch",
        "available": true
      },
      "task_dependencies": {
        "type": "switch",
        "available": true
      },
      "hris_integration": {
        "type": "switch",
        "available": true
      },
      "numbering_scheme": {
        "type": "switch",
        "available": true
      },
      "automations": {
        "type": "metered",
        "limit": 5000
      },
      "dashboards_sharing": {
        "type": "switch",
        "available": true
      },
      "currency_picker": {
        "type": "switch",
        "available": true
      },
      "required_custom_fields": {
        "type": "switch",
        "available": true
      },
      "restricted_tracking": {
        "type": "switch",
        "available": true
      },
      "enforce_sso": {
        "type": "switch",
        "available": true
      },
      "jira_integration": {
        "type": "switch",
        "available": true
      },
      "docs_versions": {
        "type": "switch",
        "available": true
      },
      "zapier_integration": {
        "type": "switch",
        "available": true
      },
      "recurring_budgets": {
        "type": "switch",
        "available": true
      },
      "restricted_user_roles": {
        "type": "switch",
        "available": true
      },
      "service_tracking_toggle": {
        "type": "switch",
        "available": true
      },
      "repeating_tasks": {
        "type": "switch",
        "available": true
      },
      "save_public_and_private_view": {
        "type": "switch",
        "available": true
      },
      "overhead_cost": {
        "type": "switch",
        "available": true
      },
      "show_only_filtered_data": {
        "type": "switch",
        "available": true
      },
      "invoicing_integrations": {
        "type": "switch",
        "available": true
      },
      "audit_log": {
        "type": "switch",
        "available": true
      },
      "hubspot_integration": {
        "type": "switch",
        "available": true
      },
      "booking_activity_modal": {
        "type": "switch",
        "available": true
      },
      "person_custom_field": {
        "type": "switch",
        "available": true
      },
      "template_center": {
        "type": "switch",
        "available": true
      },
      "custom_roles": {
        "type": "switch",
        "available": true
      },
      "purchase_orders": {
        "type": "switch",
        "available": true
      },
      "payment_reminders": {
        "type": "switch",
        "available": true
      },
      "gantt": {
        "type": "switch",
        "available": true
      },
      "tentative_bookings": {
        "type": "switch",
        "available": true
      },
      "task_view_sharing": {
        "type": "switch",
        "available": true
      },
      "org_chart": {
        "type": "switch",
        "available": true
      },
      "person_status": {
        "type": "switch",
        "available": true
      },
      "deal_cost_rates": {
        "type": "switch",
        "available": true
      },
      "custom_man_days": {
        "type": "switch",
        "available": true
      },
      "workload_view": {
        "type": "switch",
        "available": true
      },
      "xero_expense_sync": {
        "type": "switch",
        "available": true
      },
      "rippling_integration": {
        "type": "switch",
        "available": true
      },
      "document_styler": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

GET  /api/v2/timesheet_reports?filter[person_id]=8699

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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "2024/W13-person-8699-22e571d91bef5b71cff9310e6aba3e01",
      "type": "timesheet_reports",
      "attributes": {
        "week": "2024/W13",
        "monday_time": 0,
        "monday_capacity": null,
        "monday_available": null,
        "tuesday_time": 0,
        "tuesday_capacity": null,
        "tuesday_available": null,
        "wednesday_time": 0,
        "wednesday_capacity": null,
        "wednesday_available": null,
        "thursday_time": 480,
        "thursday_capacity": null,
        "thursday_available": null,
        "friday_time": 0,
        "friday_capacity": null,
        "friday_available": null,
        "saturday_time": 0,
        "saturday_capacity": null,
        "saturday_available": null,
        "sunday_time": 0,
        "sunday_capacity": null,
        "sunday_available": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2102"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "8699"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "8699",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "deactivated_at": null,
        "first_name": "name",
        "last_name": "surname",
        "nickname": null,
        "role_id": 3,
        "email": "user8614@email.com",
        "title": null,
        "contact": {},
        "status_emoji": null,
        "status_expires_at": null,
        "status_text": null,
        "joined_at": null,
        "last_seen_at": null,
        "archived_at": null,
        "invited_at": "2024-03-28T05:18:17.000+01:00",
        "is_user": true,
        "user_id": 8678,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2024-03-28T05:18:17.327+01:00",
        "placeholder": false,
        "color_id": null,
        "sample_data": false,
        "time_unlocked": false,
        "time_unlocked_on": null,
        "time_unlocked_start_date": null,
        "time_unlocked_end_date": null,
        "time_unlocked_period_id": null,
        "time_unlocked_interval": null,
        "last_activity_at": "2024-03-28T05:18:17.327+01:00",
        "two_factor_auth": false,
        "availabilities": "[]",
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2102"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "6647"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "9059"
          }
        },
        "teams": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "6647",
      "type": "companies",
      "attributes": {
        "name": "Organization2102",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2024-03-28T05:18:17.314+01:00",
        "last_activity_at": "2024-03-28T05:18:17.314+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "ORGA",
        "domain": null,
        "projectless_budgets": false,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false,
        "settings": {},
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2102"
          }
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "9059",
      "type": "roles",
      "attributes": {
        "base_role_id": 3,
        "description": "test description",
        "name": "test_role",
        "people_count": 1,
        "permissions": {},
        "editable_by_user": false,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2102"
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/timesheet_reports?filter%5Bperson_id%5D=8699&page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/timesheet_reports?filter%5Bperson_id%5D=8699&page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 10
      },
      "workflows": {
        "type": "metered",
        "limit": 10
      },
      "rate_cards": {
        "type": "metered",
        "limit": 30
      },
      "teams": {
        "type": "metered",
        "limit": 20
      },
      "outgoing_emails": {
        "type": "metered",
        "limit": 100
      },
      "recycle_bin": {
        "type": "metered",
        "limit": 730
      },
      "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
      },
      "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
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      },
      "time_locking": {
        "type": "switch",
        "available": true
      },
      "docs": {
        "type": "switch",
        "available": true
      },
      "scheduling_resource_utilization": {
        "type": "switch",
        "available": true
      },
      "enforce_two_factor_auth": {
        "type": "switch",
        "available": true
      },
      "personio_integration": {
        "type": "switch",
        "available": true
      },
      "task_dependencies": {
        "type": "switch",
        "available": true
      },
      "hris_integration": {
        "type": "switch",
        "available": true
      },
      "numbering_scheme": {
        "type": "switch",
        "available": true
      },
      "automations": {
        "type": "metered",
        "limit": 5000
      },
      "dashboards_sharing": {
        "type": "switch",
        "available": true
      },
      "currency_picker": {
        "type": "switch",
        "available": true
      },
      "required_custom_fields": {
        "type": "switch",
        "available": true
      },
      "restricted_tracking": {
        "type": "switch",
        "available": true
      },
      "enforce_sso": {
        "type": "switch",
        "available": true
      },
      "jira_integration": {
        "type": "switch",
        "available": true
      },
      "docs_versions": {
        "type": "switch",
        "available": true
      },
      "zapier_integration": {
        "type": "switch",
        "available": true
      },
      "recurring_budgets": {
        "type": "switch",
        "available": true
      },
      "restricted_user_roles": {
        "type": "switch",
        "available": true
      },
      "service_tracking_toggle": {
        "type": "switch",
        "available": true
      },
      "repeating_tasks": {
        "type": "switch",
        "available": true
      },
      "save_public_and_private_view": {
        "type": "switch",
        "available": true
      },
      "overhead_cost": {
        "type": "switch",
        "available": true
      },
      "show_only_filtered_data": {
        "type": "switch",
        "available": true
      },
      "invoicing_integrations": {
        "type": "switch",
        "available": true
      },
      "audit_log": {
        "type": "switch",
        "available": true
      },
      "hubspot_integration": {
        "type": "switch",
        "available": true
      },
      "booking_activity_modal": {
        "type": "switch",
        "available": true
      },
      "person_custom_field": {
        "type": "switch",
        "available": true
      },
      "template_center": {
        "type": "switch",
        "available": true
      },
      "custom_roles": {
        "type": "switch",
        "available": true
      },
      "purchase_orders": {
        "type": "switch",
        "available": true
      },
      "payment_reminders": {
        "type": "switch",
        "available": true
      },
      "gantt": {
        "type": "switch",
        "available": true
      },
      "tentative_bookings": {
        "type": "switch",
        "available": true
      },
      "task_view_sharing": {
        "type": "switch",
        "available": true
      },
      "org_chart": {
        "type": "switch",
        "available": true
      },
      "person_status": {
        "type": "switch",
        "available": true
      },
      "deal_cost_rates": {
        "type": "switch",
        "available": true
      },
      "custom_man_days": {
        "type": "switch",
        "available": true
      },
      "workload_view": {
        "type": "switch",
        "available": true
      },
      "xero_expense_sync": {
        "type": "switch",
        "available": true
      },
      "rippling_integration": {
        "type": "switch",
        "available": true
      },
      "document_styler": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get timesheet reports
GET/api/v2/reports/timesheet_reports


Generated by aglio on 28 Mar 2024