--- title: Get time-off records for one staff slug: api/get-time-off-records-for-one-staff description: API reference for GET endpoint: Get time-off-records for one staff. createdAt: 2023-11-30T03:00:33.129Z --- :::hint{type="info"} **GET** **/api/ee-time-off** ::: Gets time-off records for **one staff**, using the user ID in your system (external ID). The information will be displayed in your language of choice. **Request** *** **Query parameters** *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem **lang** string Required ::: :::VerticalSplitItem The language settings, formatted as an uppercase [ISO 639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). The leave item information will be displayed in the selected language. Valid values: EN, ZH ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem **customer\_id** integer Required ::: :::VerticalSplitItem The unique Marco identifier for your company. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem **customer\_system\_id** string Required ::: :::VerticalSplitItem The staff's unique identifier in your company's system. Example: 50 ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem **filter** string Optional ::: :::VerticalSplitItem Filter for deleted items. Marco retains deleted items in the system, and you can choose whether deleted items will be returned. Default: \{"is\_deleted"\:false} ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem **search\_start\_date** string Optional ::: :::VerticalSplitItem Start date for the date range filter, formatted as YYYY/MM/DD. Only time-off records after the selected start date will be returned. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem **search\_end\_date** string Optional ::: :::VerticalSplitItem End date for the date range filter, formatted as YYYY/MM/DD. Only time-off records before the selected end date will be returned. ::: :::: *** **Example Requests** *** ::::CodeDrawer{title="Example" isResponseExpanded="true"} :::CodeblockTabsExamples ```curl curl 'https://api.marcopayroll.com/api:benKoCK8/api/ee-time-off?customer_id=99&lang=EN&customer_system_id=123&filter={"is_deleted":false}&search_start_date=2023/01/01&search_end_date=2023/12/31' \ -H 'Authorization: $AUTH_TOKEN' ``` ```python import requests url = "https://api.marcopayroll.com/api:benKoCK8/api/ee-time-off?customer_id=99&lang=EN&customer_system_id=123&filter={"is_deleted":false}&search_start_date=2023/01/01&search_end_date=2023/12/31" headers = { 'accept': 'application/json', 'Authorization': 'YOUR_AUTH_TOKEN' } response = requests.get(url, headers=headers) print(response.text) ``` ::: :::CodeblockTabsResponses ```javascript [ { "id": 474, "customer_id": 99, "approver": 0, "total_days": 1, "start_date": "2023-03-03", "end_date": "2023-03-03", "notes": "", "reject_notes": "", "decision_time": null, "decision": "", "doc_list": [], "created_at": 1679661912563, "updated_at": 1679661912563, "deleted_at": null, "created_by": 0, "last_modified_by": 1348, "leave_type": { "id": 12, "country": 15, "display_order": 1, "day_type": "", "minimum_days": 0, "is_annual_leave": true, "created_at": 1667530650560, "updated_at": 1667530650560, "last_modified_by": 33, "deleted_at": null, "leave_type_name": "Annual Leave", "leave_type_notes": "Employees should be entitled 14 consecutive days during the subsequent 12 months." }, "user": { "id": 1348, "name": "Mary Jane", "email": "mary.jane@mail.com", "pic": null, "customer_system_id": "123", "deleted_at": null } }, { "id": 473, "customer_id": 99, "approver": 1307, "total_days": 2, "start_date": "2023-03-01", "end_date": "2023-03-02", "notes": "", "reject_notes": "", "decision_time": 1679690638000, "decision": "Approve", "doc_list": [], "created_at": 1679661838905, "updated_at": 1679661838906, "deleted_at": null, "created_by": 0, "last_modified_by": 1307, "leave_type": { "id": 12, "country": 15, "display_order": 1, "day_type": "", "minimum_days": 0, "is_annual_leave": true, "created_at": 1667530650560, "updated_at": 1667530650560, "last_modified_by": 33, "deleted_at": null, "leave_type_name": "Annual Leave", "leave_type_notes": "Employees should be entitled 14 consecutive days during the subsequent 12 months." }, "user": { "id": 1348, "name": "Mary Jane", "email": "mary.jane@mail.com", "pic": null, "customer_system_id": "123", "deleted_at": null } }, { "id": 452, "customer_id": 99, "approver": 0, "total_days": 2, "start_date": "2023-10-08", "end_date": "2023-10-09", "notes": "", "reject_notes": "", "decision_time": 1678779083230, "decision": "", "doc_list": [], "created_at": 1678779083232, "updated_at": 1678779083232, "deleted_at": null, "created_by": 0, "last_modified_by": 1307, "leave_type": { "id": 13, "country": 15, "display_order": 2, "day_type": "", "minimum_days": 10, "is_annual_leave": false, "created_at": 1667530650560, "updated_at": 1667530650560, "last_modified_by": 33, "deleted_at": null, "leave_type_name": "Sick Leave", "leave_type_notes": "Employees are entitled to sick leave after 3 months of working." }, "user": { "id": 1348, "name": "Mary Jane", "email": "mary.jane@mail.com", "pic": null, "customer_system_id": "123", "deleted_at": null } }, { "id": 457, "customer_id": 99, "approver": 654, "total_days": 2, "start_date": "2023-10-08", "end_date": "2023-10-09", "notes": "", "reject_notes": "Please include details for the leave application", "decision_time": 1678956394828, "decision": "Reject", "doc_list": [], "created_at": 1678956371624, "updated_at": 1678956371624, "deleted_at": null, "created_by": 0, "last_modified_by": 654, "leave_type": { "id": 12, "country": 15, "display_order": 1, "day_type": "", "minimum_days": 0, "is_annual_leave": true, "created_at": 1668493783625, "updated_at": 1668493783625, "last_modified_by": 4, "deleted_at": null, "leave_type_name": "Annual Leave", "leave_type_notes": "Employees should be entitled 14 consecutive days during the subsequent 12 months." }, "user": { "id": 1348, "name": "Mary Jane", "email": "mary.jane@mail.com", "pic": null, "customer_system_id": "123", "deleted_at": null } }, { "id": 544, "customer_id": 99, "approver": 0, "total_days": 2, "start_date": "2023-10-08", "end_date": "2023-10-09", "notes": "", "reject_notes": "", "decision_time": 1685516501705, "decision": "", "doc_list": [], "created_at": 1685516501707, "updated_at": 1685516501707, "deleted_at": null, "created_by": 0, "last_modified_by": 1307, "leave_type": { "id": 104, "country": 61, "display_order": 1, "day_type": "working", "minimum_days": 7, "is_annual_leave": true, "created_at": 1668493783625, "updated_at": 1668493783625, "last_modified_by": 4, "deleted_at": null, "leave_type_name": "Annual Leave", "leave_type_notes": "Employees are entitled to minimum 7 days, with 1 additional day for each year." }, "user": { "id": 1348, "name": "Mary Jane", "email": "mary.jane@mail.com", "pic": null, "customer_system_id": "123", "deleted_at": null } } ] ``` ::: :::: **Response (200)** *** A successful response will return an array of objects. Each object contains one time-off record for the staff. ::::VerticalSplit{layout="left"} :::VerticalSplitItem **id** integer ::: :::VerticalSplitItem The unique Marco identifier for the staff's time-off record. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem **customer\_id** integer ::: :::VerticalSplitItem The unique Marco identifier for the staff's company. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem **approver** integer ::: :::VerticalSplitItem The unique Marco identifier for the user who approved the time-off record. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem **total\_days** integer ::: :::VerticalSplitItem The number of leave days in the time-off record. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem **start\_date** string ::: :::VerticalSplitItem The start date for the time-off record, formatted as YYYY-MM-DD. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem **end\_date** string ::: :::VerticalSplitItem The end date for the time-off record, formatted as YYYY-MM-DD. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem **notes** string ::: :::VerticalSplitItem The notes for the time-off record. Typically contains the reason for the leave application. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem **reject\_notes** string**** ::: :::VerticalSplitItem The rejection notes for the time-off record, if rejected. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem **decision\_time** string**** ::: :::VerticalSplitItem Unix timestamp for the approval decision. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem **decision** string ::: :::VerticalSplitItem The approval decision. Valid values: Approve, Reject ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem **doc\_list** array\[string\] ::: :::VerticalSplitItem The supporting documents for the leave application. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem **created\_at** integer ::: :::VerticalSplitItem Unix timestamp for the time-off record's creation date. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem **updated\_at** integer ::: :::VerticalSplitItem Unix timestamp for the time-off record's update date. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem **deleted\_at** integer ::: :::VerticalSplitItem Unix timestamp for the time-off record's deletion date. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem **created\_by** integer ::: :::VerticalSplitItem The unique Marco identifier for the user who created the time-off record. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem **last\_modified\_by** integer ::: :::VerticalSplitItem The unique Marco identifier for the user who last modified the time-off record. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem **{leave\_type}** object ::: :::VerticalSplitItem The leave type metadata. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem {leave\_type}.**id** integer ::: :::VerticalSplitItem The unique Marco identifier for the leave type. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem {leave\_type}.**country** integer ::: :::VerticalSplitItem The unique Marco identifier for the leave type's associated country. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem {leave\_type}.**display\_order** integer ::: :::VerticalSplitItem The display order for the leave type, when displayed in a list. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem {leave\_type}.**day\_type** string ::: :::VerticalSplitItem The day type for the leave type. Valid values: Calendar, Working ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem {leave\_type}.**minimum\_days** integer ::: :::VerticalSplitItem Minimum amount of days that should be granted to the staff. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem {leave\_type}.**is\_annual\_leave** boolean ::: :::VerticalSplitItem Whether the leave type is an annual leave. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem {leave\_type}.**created\_at** integer ::: :::VerticalSplitItem Unix timestamp for the leave type's creation date. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem {leave\_type}.**updated\_at** integer ::: :::VerticalSplitItem Unix timestamp for the leave type's update date. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem {leave\_type}.**last\_modified\_by** integer ::: :::VerticalSplitItem The unique Marco identifier for the user who last modified the leave type. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem {leave\_type}.**deleted\_at** integer ::: :::VerticalSplitItem Unix timestamp for the leave type's deletion date. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem {leave\_type}.**leave\_type\_name** integer ::: :::VerticalSplitItem The leave type name. Example: Sick Leave ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem {leave\_type}.**leave\_type\_notes** string ::: :::VerticalSplitItem The notes for the leave type. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem **{user}** object ::: :::VerticalSplitItem The staff's details. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem {user}.**id** integer ::: :::VerticalSplitItem The unique Marco identifier for the staff. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem {user}.**name** integer ::: :::VerticalSplitItem The staff's full name. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem {user}.**email** integer ::: :::VerticalSplitItem The staff's email, used to log into Marco. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem {user}.**pic** ::: :::VerticalSplitItem The staff's profile picture. Returned as a null value. ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem {user}.**customer\_system\_id** string ::: :::VerticalSplitItem The staff's unique identifier in your company's system. Example: 50 ::: :::: *** ::::VerticalSplit{layout="left"} :::VerticalSplitItem {user}.**deleted\_at** integer ::: :::VerticalSplitItem Unix timestamp for the time-off record's deletion date. ::: :::: ***