API Documentation

API Endpoint

Timesheet Reports

Timesheet Reports

Supported filter params

  • person_id (array)

  • tags

  • after

  • before

GET /api/v2/timesheet_reports
Requestsreturns timesheet reports

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

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": "timesheet-report-2020/W33-1889-7e77387e7c265c92c0be05295e4fc4fb",
      "type": "timesheet_reports",
      "attributes": {
        "week": "2020/W33",
        "monday_time": 0,
        "monday_capacity": null,
        "monday_available": null,
        "tuesday_time": 480,
        "tuesday_capacity": null,
        "tuesday_available": null,
        "wednesday_time": 0,
        "wednesday_capacity": null,
        "wednesday_available": null,
        "thursday_time": 0,
        "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": "695"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "1889"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "1889",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1842@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-08-11T01:06:21.000+02:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-08-11T01:06:21.186+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 695
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2606"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2606",
      "type": "companies",
      "attributes": {
        "name": "Client1912",
        "default_currency": null,
        "created_at": "2020-08-11T01:06:21.181+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 695
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/timesheet_reports?filter%5Bperson_id%5D=1889&page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/timesheet_reports?filter%5Bperson_id%5D=1889&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,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 30,
        "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
      }
    }
  }
}

Get timesheet reports
GET/api/v2/timesheet_reports


Generated by aglio on 10 Aug 2020