TimedDoctor API

https://timedoctor.redoc.ly/
Admin
TimedDoctor is a comprehensive time tracking and employee monitoring API that provides endpoints for...
Tokens:236,395
Snippets:780
Trust Score:9.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### Get Company Payroll Settings Request (Node.js)

Source: https://timedoctor.redoc.ly/

Example using Node.js and the fetch API to retrieve company-wide payroll settings. Requires an API key for authorization.

```javascript
const fetch = require('node-fetch');

const query = new URLSearchParams({company: 'string'}).toString();

const resp = await fetch(
  `https://api2.timedoctor.com/api/1.0/companies/payroll?${query}`,
  {
    method: 'GET',
    headers: {
      Authorization: 'YOUR_API_KEY_HERE'
    }
  }
);

const data = await resp.text();
console.log(data);
```

--------------------------------

### Node.js Example for PUT /api/v1/pending-approvals/bulk

Source: https://timedoctor.redoc.ly/

Example of how to make a PUT request to bulk update pending approvals using Node.js.

```javascript
const url = 'https://api2.timedoctor.com/api/v1/pending-approvals/bulk';
const options = {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': '{{apiKey}}'
  },
  body: JSON.stringify([
    {
      userId: '{{userId}}',
      approved: true,
      blocked: true
    }
  ])
};

fetch(url, options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));
```

--------------------------------

### Python Example for PUT /api/v1/pending-approvals/bulk

Source: https://timedoctor.redoc.ly/

Example of how to make a PUT request to bulk update pending approvals using Python.

```python
import requests
import json

url = 'https://api2.timedoctor.com/api/v1/pending-approvals/bulk'
headers = {
    'Content-Type': 'application/json',
    'x-api-key': '{{apiKey}}'
}
payload = [
    {
        "userId": "{{userId}}",
        "approved": True,
        "blocked": True
    }
]

response = requests.put(url, headers=headers, data=json.dumps(payload))
print(response.json())
```

--------------------------------

### Invite User Response Example

Source: https://timedoctor.redoc.ly/

This is an example of a successful response when inviting a user. It typically contains the userId of the newly created invitation.

```json
{
  "data": {
    "userId": "string"
}

}
```

--------------------------------

### Python Example for DELETE /api/v1/pending-approvals/bulk

Source: https://timedoctor.redoc.ly/

Example of how to make a DELETE request to bulk remove pending approvals using Python.

```python
import requests
import json

url = 'https://api2.timedoctor.com/api/v1/pending-approvals/bulk'
headers = {
    'Content-Type': 'application/json',
    'x-api-key': '{{apiKey}}'
}
payload = [
    '{{userId}}'
]

response = requests.delete(url, headers=headers, data=json.dumps(payload))
print(response.json())
```

--------------------------------

### Python Example for PUT /api/v1/pending-approvals/{userId}

Source: https://timedoctor.redoc.ly/

Example of how to make a PUT request to update a single pending approval using Python.

```python
import requests
import json

url = 'https://api2.timedoctor.com/api/v1/pending-approvals/{{userId}}'
headers = {
    'Content-Type': 'application/json',
    'x-api-key': '{{apiKey}}'
}
payload = {
    "userId": "{{userId}}",
    "approved": True,
    "blocked": True
}

response = requests.put(url, headers=headers, data=json.dumps(payload))
print(response.json())
```

--------------------------------

### Node.js Example for DELETE /api/v1/pending-approvals/bulk

Source: https://timedoctor.redoc.ly/

Example of how to make a DELETE request to bulk remove pending approvals using Node.js.

```javascript
const url = 'https://api2.timedoctor.com/api/v1/pending-approvals/bulk';
const options = {
  method: 'DELETE',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': '{{apiKey}}'
  },
  body: JSON.stringify([
    '{{userId}}'
  ])
};

fetch(url, options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));
```

--------------------------------

### Curl Example for PUT /api/v1/pending-approvals/bulk

Source: https://timedoctor.redoc.ly/

Example of how to make a PUT request to bulk update pending approvals using curl.

```bash
curl -X PUT \
  https://api2.timedoctor.com/api/v1/pending-approvals/bulk \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {{apiKey}}' \
  -d '[
	{
		"userId": "{{userId}}",
		"approved": true,
		"blocked": true
	}
]'
```

--------------------------------

### Get Activity Worklog Request

Source: https://timedoctor.redoc.ly/

Demonstrates how to construct a GET request to the activity worklog endpoint using Node.js. Includes setting query parameters and authorization headers.

```javascript
const fetch = require('node-fetch');

const query = new URLSearchParams({
  company: 'string',
  user: 'string',
  from: '2019-08-24T14:15:22Z',
  to: '2019-08-24T14:15:22Z',
  detail: 'true',
  'exclude-fields': 'string',
  'include-modes': 'string',
  'task-project-names': 'true',
  'include-meeting': 'true'
}).toString();

const resp = await fetch(
  `https://api2.timedoctor.com/api/1.0/activity/worklog?${query}`,
  {
    method: 'GET',
    headers: {
      Authorization: 'YOUR_API_KEY_HERE'
    }
  }
);

const data = await resp.text();
console.log(data);
```

--------------------------------

### Check Invitation Response Example

Source: https://timedoctor.redoc.ly/

This is an example of a successful response when checking for an existing invitation. It indicates if an invitation is pending and provides the invitation ID.

```json
{
  "data": {
    "name": "string",
    "invitePending": true,
    "id": "string"
}

}
```

--------------------------------

### Node.js Example for PUT /api/v1/pending-approvals/{userId}

Source: https://timedoctor.redoc.ly/

Example of how to make a PUT request to update a single pending approval using Node.js.

```javascript
const url = 'https://api2.timedoctor.com/api/v1/pending-approvals/{{userId}}';
const options = {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': '{{apiKey}}'
  },
  body: JSON.stringify({
    userId: '{{userId}}',
    approved: true,
    blocked: true
  })
};

fetch(url, options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));
```

--------------------------------

### User and Tracking Configuration Sample

Source: https://timedoctor.redoc.ly/

This snippet illustrates user-specific and general tracking configurations, including autostart, first day of the week, and web/app tracking settings.

```json
{
  "forceAutostart": true,
  "firstDayOfWeek": true,
  "custom": {
    "browserExtensionEnabled": true,
    "completedStep": {
      "manageUsers": true,
      "setupGroups": true,
      "companySettings": true
    }
  },
  "webAndAppTracking": "off",
  "mobileAppTracking": "on",
  "allowMobileAppTracking": true
}
```

--------------------------------

### Get Company Timezones Response

Source: https://timedoctor.redoc.ly/

Example JSON response containing a list of timezones for users within a company.

```json
{
  "data": {
    "timezones": [
      "string"
]
}

}
```

--------------------------------

### Example Subscription and Tag IDs

Source: https://timedoctor.redoc.ly/

This JSON fragment details subscription plan information and lists associated tag IDs and project IDs.

```json
{
  "subscription": {
    "plan": "string",
    "status": "string",
    "expires": "string"
  },
  "tagIds": [
    "string"
  ],
  "onlyProjectIds": [
    "string"
  ],
  "splitTest": [
    "string"
  ],
  "allUsersTagId": "string",
  "pricingPlan": "string"
}
```

--------------------------------

### Get User Categories Request Sample

Source: https://timedoctor.redoc.ly/

Node.js example for fetching user-specific productivity categories. Includes query parameters for filtering and sorting.

```javascript
const fetch = require('node-fetch');

const query = new URLSearchParams({
  company: 'string',
  page: 'string',
  limit: 'string',
  sort: 'time',
  'filter[time]': 'string',
  'filter[name]': 'string',
  'filter[entity]': 'string',
  'filter[score]': 'string'
}).toString();

const userId = 'YOUR_userId_PARAMETER';
const resp = await fetch(
  `https://api2.timedoctor.com/api/1.0/categories/user/${userId}?${query}`,
  {
    method: 'GET',
    headers: {
      Authorization: 'YOUR_API_KEY_HERE'
    }
  }
);

const data = await resp.text();
console.log(data);
```

--------------------------------

### Success Response for Disconnection Periods

Source: https://timedoctor.redoc.ly/

This is an example of a successful response when retrieving disconnection periods. It includes start and end times, duration, and user ID.

```json
{
  "data": [
    {
      "start": "2019-08-24T14:15:22Z",
      "end": "2019-08-24T14:15:22Z",
      "time": 0,
      "userId": "string"
}
]

}
```

--------------------------------

### User Creation Response Sample

Source: https://timedoctor.redoc.ly/

Illustrates the response structure after attempting to create users. It includes the status of each user operation, along with a reason and error details if applicable.

```json
{
  "data": [
    {
      "status": "sent",
      "userId": "string",
      "reason": "string",
      "error": {
        "message": "string"
}
}
]

}
```

--------------------------------

### Subscription Details Sample

Source: https://timedoctor.redoc.ly/

This sample shows the structure for subscription information, including the plan, status, and expiration date.

```json
{
  "subscription": {
    "plan": "string",
    "status": "string",
    "expires": "string"
  }
}
```

--------------------------------

### Get Notification Response

Source: https://timedoctor.redoc.ly/

Example JSON response for retrieving notification details. Includes the notification's ID, name, type, conditions, scope, and status.

```json
{
  "data": {
    "_id": "string",
    "name": "string",
    "notifyType": "daily",
    "condType": "string",
    "condValue": "string",
    "scope": "company",
    "dataIds": [
      "string"
    ],
    "daysApplicable": [
      0
    ],
    "active": true,
    "recipientIds": [
      "string"
    ]
}

}
```

--------------------------------

### Example Company Settings Details

Source: https://timedoctor.redoc.ly/

This JSON structure outlines detailed company settings, such as name, employee ID, tracking intervals, and various feature permissions.

```json
{
  "name": "string",
  "employeeId": "string",
  "exists": true,
  "active": true,
  "screenshots": 0,
  "videos": "string",
  "workCheckInterval": 0,
  "canEditTime": "string",
  "poorTimeusePopup": true,
  "allowDeleteScreenshots": true,
  "tasksMode": "string",
  "trackingMode": "string",
  "interactiveTrackingMode": "string",
  "emailSubCount": 0,
  "showOnReports": true,
  "emailReports": "string",
  "weeklyEmailReports": true,
  "jobTitle": "string",
  "blurScreenshots": true,
  "allowNoBreak": true,
  "trackInternetConnectivity": true,
  "signupStep": 0,
  "stripUrlQuery": true,
  "allowAdminSID": true,
  "hideScreencasts": true,
  "payrollAccess": true,
  "payrollFeature": true,
  "workScheduleFeature": true,
  "trackConnectivity": true,
  "allowManagerTagCategories": true,
  "allowManagerProjectsTasks": true,
  "allowManagerInviteUsers": true,
  "allowManagerWorkSchedules": true,
  "allowUsersActivitySummaryReport": true,
  "allowLeavesForRegularUsers": true,
  "forceAutostart": true,
  "firstDayOfWeek": true,
  "custom": {
    "browserExtensionEnabled": true,
    "completedStep": {
      "manageUsers": true,
      "setupGroups": true,
      "companySettings": true
    }
  },
  "webAndAppTracking": "off",
  "mobileAppTracking": "on",
  "allowMobileAppTracking": true
}
```

--------------------------------

### Get Company Timezones Request (Node.js)

Source: https://timedoctor.redoc.ly/

Node.js example to fetch company timezones, sorting them by company timezone first. Replace placeholders with actual values.

```javascript
const fetch = require('node-fetch');

const query = new URLSearchParams({'sort-tz': 'true'}).toString();

const companyId = 'YOUR_companyId_PARAMETER';
const resp = await fetch(
  `https://api2.timedoctor.com/api/1.0/companies/${companyId}/timezones?${query}`,
  {
    method: 'GET',
    headers: {
      Authorization: 'YOUR_API_KEY_HERE'
    }
  }
);

const data = await resp.text();
console.log(data);
```

--------------------------------

### Bulk Invite Users Request Body Example

Source: https://timedoctor.redoc.ly/

This example shows the structure for the request body when inviting multiple users in bulk. It includes an array of user objects, each with their own details, and optional parameters like noSendEmail and onlyProjectIds that apply to all invitations.

```json
{
  "users": [
    {
      "name": "string",
      "email": "string",
      "role": "user",
      "employeeId": "string",
      "noSendEmail": "false",
      "onlyProjectIds": [
        "string"
      ]
    }
  ],
  "noSendEmail": "false",
  "onlyProjectIds": [
    "string"
  ],
  "tagIds": [
    "string"
  ]
}
```

--------------------------------

### Company Settings Sample

Source: https://timedoctor.redoc.ly/

This snippet shows a sample response for company settings, including tracking preferences, user management options, and custom configurations.

```json
{
  "companySettings": {
    "name": "string",
    "employeeId": "string",
    "exists": true,
    "active": true,
    "screenshots": 0,
    "videos": "string",
    "workCheckInterval": 0,
    "canEditTime": "string",
    "poorTimeusePopup": true,
    "allowDeleteScreenshots": true,
    "tasksMode": "string",
    "trackingMode": "string",
    "interactiveTrackingMode": "string",
    "emailSubCount": 0,
    "showOnReports": true,
    "emailReports": "string",
    "weeklyEmailReports": true,
    "jobTitle": "string",
    "blurScreenshots": true,
    "allowNoBreak": true,
    "trackInternetConnectivity": true,
    "signupStep": 0,
    "stripUrlQuery": true,
    "allowAdminSID": true,
    "hideScreencasts": true,
    "payrollAccess": true,
    "payrollFeature": true,
    "workScheduleFeature": true,
    "trackConnectivity": true,
    "allowManagerTagCategories": true,
    "allowManagerProjectsTasks": true,
    "allowManagerInviteUsers": true,
    "allowManagerWorkSchedules": true,
    "allowUsersActivitySummaryReport": true,
    "allowLeavesForRegularUsers": true,
    "forceAutostart": true,
    "firstDayOfWeek": true,
    "custom": {
      "browserExtensionEnabled": true,
      "completedStep": {
        "manageUsers": true,
        "setupGroups": true,
        "companySettings": true
      }
    },
    "webAndAppTracking": "off",
    "mobileAppTracking": "on",
    "allowMobileAppTracking": true
  }
}
```

--------------------------------

### Get Task Node.js Example

Source: https://timedoctor.redoc.ly/

This Node.js snippet demonstrates how to retrieve detailed information about a specific task using the fetch API. Ensure you replace placeholders with your actual taskId and API key.

```javascript
const fetch = require('node-fetch');

const query = new URLSearchParams({company: 'string'}).toString();

const taskId = 'YOUR_taskId_PARAMETER';
const resp = await fetch(
  `https://api2.timedoctor.com/api/1.0/tasks/${taskId}?${query}`,
  {
    method: 'GET',
    headers: {
      Authorization: 'YOUR_API_KEY_HERE'
    }
  }
);

const data = await resp.text();
console.log(data);
```

--------------------------------

### POST /api/1.0/register/signup

Source: https://timedoctor.redoc.ly/

Creates a new user account and company simultaneously. This is intended for new company owners to start using TimeDoctor.

```APIDOC
## POST /api/1.0/register/signup

### Description
Creates a new user account and company simultaneously. This is intended for new company owners to start using TimeDoctor.

### Method
POST

### Endpoint
https://api2.timedoctor.com/api/1.0/register/signup

### Parameters
#### Request Body
- **name** (string) - Required - User full name
- **email** (string) - Required - Email address for new user account
- **timezone** (string) - Optional - Company timezone identifier. Default: "Etc/UTC"
- **password** (string) - Required - Desired password. Must be at least 6 characters long
- **referrer** (string) - Optional - If specified, a referrer, where the user was brought from
- **company** (string) - Optional - Name for newly created company. Default: "Someone's company"
- **trackingMode** (string) - Required - Time tracking mode for the company. Enum: "mixed", "interactive", "silent"
- **interactiveTrackingMode** (string) - Optional - Interactive time tracking mode for the company. Enum: "manual", "automated"
- **pricingPlan** (string) - Optional - Pricing plan of company. Default: "standard_new". Enum: "basic", "standard_new", "premium", "basic_annual", "standard_new_annual", "premium_annual"

### Request Example
```json
{
  "name": "string",
  "email": "string",
  "timezone": "string",
  "password": "string",
  "referrer": "string",
  "company": "string",
  "trackingMode": "mixed",
  "interactiveTrackingMode": "manual",
  "pricingPlan": "standard_new"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains token, expiration, creation timestamps, userId, and companyId.
  - **token** (string)
  - **expires** (string)
  - **createdAt** (string)
  - **userId** (string)
  - **companyId** (string)

#### Response Example
```json
{
  "data": {
    "token": "string",
    "expires": "string",
    "createdAt": "string",
    "userId": "string",
    "companyId": "string"
  }
}
```
```

--------------------------------

### GET /api/1.0/work-schedules/{id}

Source: https://timedoctor.redoc.ly/

Retrieves a specific work schedule entry by its ID. This endpoint is useful for fetching details of a particular schedule, such as start and end times, user assignments, and leave information.

```APIDOC
## GET /api/1.0/work-schedules/{id}

### Description
Retrieves a specific work schedule entry by its ID. This endpoint is useful for fetching details of a particular schedule, such as start and end times, user assignments, and leave information.

### Method
GET

### Endpoint
https://api2.timedoctor.com/api/1.0/work-schedules/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Unique identifier of the work schedule

#### Query Parameters
- **company** (string) - Required - ID of Company, user refers to.

### Response
#### Success Response (200)
- **data** (object) - Contains the work schedule details.
  - **id** (string)
  - **start** (string) - ISO 8601 format
  - **end** (string) - ISO 8601 format
  - **minimumHours** (number)
  - **userId** (string)
  - **leaveType** (string)
  - **approved** (string)
  - **reason** (string)
  - **reviewedAt** (string) - ISO 8601 format
  - **reviewerId** (string)
  - **createdBy** (string)
  - **reviewerName** (string)
  - **userName** (string)
  - **createdAt** (string) - ISO 8601 format
  - **time** (number)

#### Response Example
```json
{
  "data": {
    "id": "string",
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z",
    "minimumHours": 0,
    "userId": "string",
    "leaveType": "string",
    "approved": "string",
    "reason": "string",
    "reviewedAt": "2019-08-24T14:15:22Z",
    "reviewerId": "string",
    "createdBy": "string",
    "reviewerName": "string",
    "userName": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "time": 0
  }
}
```
```

--------------------------------

### Get Software Cost Insight by ID (Python)

Source: https://timedoctor.redoc.ly/

This Python example shows how to retrieve a software cost insight. You must provide the insight's ID and the company ID. Replace placeholders with your actual values and API key.

```python
import requests

api_key = 'YOUR_API_KEY_HERE'
id = 'YOUR_id_PARAMETER'
company = 'string'

headers = {
    'Authorization': api_key
}

response = requests.get(
    f'https://api2.timedoctor.com/api/1.1/software-cost-insights/{id}?company={company}',
    headers=headers
)

print(response.text)
```

--------------------------------

### 200 OK - User Data Sample

Source: https://timedoctor.redoc.ly/

This snippet shows a successful response (200 OK) containing detailed user information, including company associations and settings.

```json
{
  "data": {
    "id": "string",
    "name": "string",
    "email": "string",
    "emailConfirmed": true,
    "timezones": "string",
    "twoFactorAuth": true,
    "reportIn24HourFormat": true,
    "managerBannerDismissed": "string",
    "lastSeenGlobal": {
      "updatedAt": "string",
      "online": true,
      "ip": "string"
},
    "lastTrackGlobal": {
      "activeAt": "string",
      "online": true,
      "ip": "string",
      "clientVersion": "string",
      "osVersion": "string",
      "deviceId": "string"
},
    "active": true,
    "adminSettings": {
      "enabled": true,
      "manageAdmins": true,
      "convReport": true,
      "editCategories": true,
      "indirectLogin": true,
      "indirectFileAccess": true,
      "deleteAccounts": true,
      "billingSettings": true
},
    "companies": [
      {
        "id": "string",
        "companyCreatedAt": "string",
        "oldCompanyId": "string",
        "name": "string",
        "userCount": 0,
        "role": "string",
        "timezone": "string",
        "companyTimezone": "string",
        "time": "string",
        "lastSeen": {
          "updatedAt": "string",
          "online": true,
          "ip": "string"
},
        "lastTrack": {
          "updatedAt": "string",
          "activeAt": "string",
          "online": true,
          "status": "string",
          "taskId": "string",
          "taskName": "string",
          "projectId": "string",
          "projectName": "string",
          "ip": "string",
          "clientVersion": "string",
          "osVersion": "string",
          "deviceId": "string"
},
        "settings": {
          "name": "string",
          "employeeId": "string",
          "exists": true,
          "active": true,
          "screenshots": 0,
          "videos": "string",
          "workCheckInterval": 0,
          "canEditTime": "string",
          "poorTimeusePopup": true,
          "allowDeleteScreenshots": true,
          "tasksMode": "string",
          "trackingMode": "string",
          "interactiveTrackingMode": "string",
          "emailSubCount": 0,
          "showOnReports": true,
          "emailReports": "string",
          "weeklyEmailReports": true,
          "jobTitle": "string",
          "blurScreenshots": true,
          "allowNoBreak": true,
          "trackInternetConnectivity": true,
          "signupStep": 0,
          "stripUrlQuery": true,
          "allowAdminSID": true,
          "hideScreencasts": true,
          "payrollAccess": true,
          "payrollFeature": true,
          "workScheduleFeature": true,
          "trackConnectivity": true,
          "allowManagerTagCategories": true,
          "allowManagerProjectsTasks": true,
          "allowManagerInviteUsers": true,
          "allowManagerWorkSchedules": true,
          "allowUsersActivitySummaryReport": true,
          "allowLeavesForRegularUsers": true,
          "forceAutostart": true,
          "firstDayOfWeek": true,
          "custom": {
            "browserExtensionEnabled": true,
            "completedStep": {
              "manageUsers": true,
              "setupGroups": true,
              "companySettings": true
}
},
          "webAndAppTracking": "off",
          "mobileAppTracking": "on",
          "allowMobileAppTracking": true
},
        "userSettings": {
          "name": "string",
          "employeeId": "string",
          "exists": true,
          "active": true,
          "screenshots": 0,
          "videos": "string",
          "workCheckInterval": 0,
          "canEditTime": "string",
          "poorTimeusePopup": true,
          "allowDeleteScreenshots": true,
          "tasksMode": "string",
          "trackingMode": "string",
          "interactiveTrackingMode": "string",
          "emailSubCount": 0,
          "showOnReports": true,
          "emailReports": "string",
          "weeklyEmailReports": true,
          "jobTitle": "string",
          "blurScreenshots": true,
          "allowNoBreak": true,
          "trackInternetConnectivity": true,
          "signupStep": 0,
          "stripUrlQuery": true,
          "allowAdminSID": true,
          "hideScreencasts": true,
          "payrollAccess": true,
          "payrollFeature": true,
          "workScheduleFeature": true,
          "trackConnectivity": true,
          "allowManagerTagCategories": true,
          "allowManagerProjectsTasks": true,
          "allowManagerInviteUsers": true,
          "allowManagerWorkSchedules": true,
          "allowUsersActivitySummaryReport": true,
          "allowLeavesForRegularUsers": true
}
}
]
}
}
```

--------------------------------

### Get Users Payroll (Node.js)

Source: https://timedoctor.redoc.ly/

This Node.js example retrieves payroll information for multiple users. It requires a company ID and optionally accepts date ranges (`from`, `to`) and a tag for filtering. Ensure your API key is correctly set in the Authorization header.

```javascript
const fetch = require('node-fetch');

const query = new URLSearchParams({
  company: 'string',
  from: '2019-08-24',
  to: '2019-08-24',
  tag: 'string'
}).toString();

const resp = await fetch(
  `https://api2.timedoctor.com/api/1.0/users/payroll?${query}`,
  {
    method: 'GET',
    headers: {
      Authorization: 'YOUR_API_KEY_HERE'
    }
  }
);

const data = await resp.text();
console.log(data);
```

--------------------------------

### Python Request for Timesheet Shift Stats

Source: https://timedoctor.redoc.ly/

This Python example demonstrates how to make a GET request to the timesheet shift endpoint. Remember to replace 'YOUR_API_KEY_HERE' with your valid API key. The extensive query parameters allow for precise data retrieval.

```python
import requests

params = {
    'company': 'string',
    'from': '2019-08-24T14:15:22Z',
    'to': '2019-08-24T14:15:22Z',
    'user': 'string',
    'tag': 'string',
    'task': 'string',
    'unpaid': '0',
    'breaks': 'all',
    'fields': 'string',
    'group-by': 'string',
    'resolve': 'string',
    'ratio': 'string',
    'level': 'company',
    'timezone': 'string',
    'period': 'days',
    'interval': '1',
    'paging': '0',
    'page': 'string',
    'limit': 'string',
    'sort': 'userId',
    'prefilter[userId]': 'string',
    'prefilter[userObjPrePos]': 'string',
    'prefilter[userObjPos]': 'string',
    'prefilter[userName]': 'string',
    'prefilter[userNameNorm]': 'string',
    'prefilter[userArchived]': 'string',
    'prefilter[currentTagId]': 'string',
    'prefilter[currentTagObj]': 'string',
    'prefilter[currentTagName]': 'string',
    'prefilter[currentTagNameNorm]': 'string',
    'prefilter[projectId]': 'string',
    'prefilter[projectObj]': 'string',
    'prefilter[projectName]': 'string',
    'prefilter[projectNameNorm]': 'string',
    'prefilter[projectIntegrationProvider]': 'string',
    'prefilter[projectIntegrationName]': 'string',
    'prefilter[projectIntegrationNameNorm]': 'string',
    'prefilter[taskId]': 'string',
    'prefilter[taskObj]': 'string',
    'prefilter[taskName]': 'string',
    'prefilter[taskNameNorm]': 'string',
    'prefilter[taskIntegrationProvider]': 'string',
    'prefilter[taskIntegrationName]': 'string',
    'prefilter[taskIntegrationNameNorm]': 'string',
    'prefilter[taskIntegrationLink]': 'string',
    'prefilter[taskIntegrationLastTracked]': 'string',
    'prefilter[date]': 'string',
    'prefilter[timezone]': 'string',
    'prefilter[start]': 'string',
    'prefilter[end]': 'string',
    'prefilter[item]': 'string',
    'filter[ratio]': 'string',
    'filter[ratioTotal]': 'string',
    'filter[count]': 'string',
    'prefilter[quants]': 'string',
    'prefilter[offsets]': 'string',
    'filter[quant0]': 'string',
    'filter[quant1]': 'string',
    'filter[quant2]': 'string',
    'filter[total]': 'string',
    'prefilter[shiftId]': 'string',
    'filter[shiftObj]': 'string',
    'prefilter[shiftStart]': 'string',
    'prefilter[shiftEnd]': 'string',
    'filter[minHours]': 'string',
    'ratio-page': 'string',
    'ratio-limit': 'string',
    'ratio-sort': 'userId',
    'ratio-filter[total]': 'string',
    'ratio-field': 'string',
    'ratio-id': 'string',
    'date-page': 'string',
    'date-limit': 'string'
}

headers = {
    'Authorization': 'YOUR_API_KEY_HERE'
}

response = requests.get('https://api2.timedoctor.com/api/1.1/stats/timesheet/shift', params=params, headers=headers)

data = response.text
print(data)

```

--------------------------------

### Create Task Response (200 OK)

Source: https://timedoctor.redoc.ly/

This is a sample successful response when a task is created. It includes the newly created task's data, such as its ID, status, reporter, project details, name, and description.

```json
{
  "data": {
    "id": "string",
    "status": "string",
    "reporterId": "string",
    "deleted": true,
    "deletedAt": "string",
    "folders": { },
    "project": {
      "id": "string",
      "weight": 0
    },
    "name": "string",
    "description": "string",
    "integration": {
      "provider": "string",
      "data": { }
    }
  }
}
```

--------------------------------

### Node.js API Request Example

Source: https://timedoctor.redoc.ly/

This Node.js snippet demonstrates how to construct a URLSearchParams object for making API requests. It includes a comprehensive list of query parameters for filtering and grouping time tracking data. Ensure you have the 'node-fetch' package installed.

```javascript
const fetch = require('node-fetch');

const query = new URLSearchParams({
  company: 'string',
  from: '2019-08-24T14:15:22Z',
  to: '2019-08-24T14:15:22Z',
  user: 'string',
  tag: 'string',
  task: 'string',
  unpaid: '0',
  breaks: 'all',
  fields: 'string',
  'group-by': 'string',
  resolve: 'string',
  ratio: 'string',
  level: 'company',
  timezone: 'string',
  period: 'days',
  interval: '1',
  paging: '0',
  page: 'string',
  limit: 'string',
  sort: 'userId',
  'prefilter[userId]': 'string',
  'prefilter[userObjPrePos]': 'string',
  'prefilter[userObjPos]': 'string',
  'prefilter[userName]': 'string',
  'prefilter[userNameNorm]': 'string',
  'prefilter[userArchived]': 'string',
  'prefilter[currentTagId]': 'string',
  'prefilter[currentTagObj]': 'string',
  'prefilter[currentTagName]': 'string',
  'prefilter[currentTagNameNorm]': 'string',
  'prefilter[projectId]': 'string',
  'prefilter[projectObj]': 'string',
  'prefilter[projectName]': 'string',
  'prefilter[projectNameNorm]': 'string',
  'prefilter[projectIntegrationProvider]': 'string',
  'prefilter[projectIntegrationName]': 'string',
  'prefilter[projectIntegrationNameNorm]': 'string',
  'prefilter[taskId]': 'string',
  'prefilter[taskObj]': 'string',
  'prefilter[taskName]': 'string',
  'prefilter[taskNameNorm]': 'string',
  'prefilter[taskIntegrationProvider]': 'string',
  'prefilter[taskIntegrationName]': 'string',
  'prefilter[taskIntegrationNameNorm]': 'string',
  'prefilter[taskIntegrationLink]': 'string',
  'prefilter[taskIntegrationLastTracked]': 'string',
  'prefilter[date]': 'string',
  'prefilter[timezone]': 'string',
  'prefilter[start]': 'string',
  'prefilter[end]': 'string',
  'prefilter[item]': 'string',
  'filter[ratio]': 'string',
  'filter[ratioTotal]': 'string',
  'filter[count]': 'string',
  'prefilter[quants]': 'string',
  'prefilter[offsets]': 'string',
  'filter[quant0]': 'string',
  'filter[quant1]': 'string',
  'filter[quant2]': 'string',
  'filter[total]': 'string',
  'filter[meetingTotal]': 'string',
  'filter[comCat]': 'string',
  'filter[comCatObj]': 'string',
  'prefilter[entity]': 'string',
  'prefilter[name]': 'string',
  'prefilter[score]': 'string',
  'prefilter[tagId]': 'string',
  'prefilter[userCat]': 'string',
  'filter[clicks]': 'string',
  'filter[moves]': 'string',
  'filter[keys]': 'string',
  'filter[totalMins]': 'string',
  'filter[idleSec]': 'string',
  'filter[idleSecRatio]': 'string',
  'filter[idleMins]': 'string',
  'filter[idleMinsRatio]': 'string',
  'filter[totalSec]': 'string',
  'filter[activeSec]': 'string',
  'filter[activeSecRatio]': 'string',
  'filter[standardActiveSec]': 'string',
  'filter[activeBias]': 'string',
  'filter[activeBiasRatio]': 'string',
  'filter[standardActiveSecRatio]': 'string',
  'filter[offcomputer]': 'string',
  'filter[computer]': 'string',
  'filter[mobile]': 'string',
  'filter[manual]': 'string',
  'filter[mobMan]': 'string',
  'filter[paidBreak]': 'string',
  'filter[unpaidBreak]': 'string',
  'filter[meeting]': 'string',
  'filter[paidLeave]': 'string',
  'filter[unpaidLeave]': 'string',
  'filter[offcomputerRatio]': 'string',
  'filter[computerRatio]': 'string',
  'filter[mobileRatio]': 'string',
  'filter[manualRatio]': 'string',
  'filter[mobManRatio]': 'string',
  'filter[paidBreakRatio]': 'string',
  'filter[unpaidBreakRatio]': 'string',
  'filter[meetingRatio]': 'string',
  'filter[paidLeaveRatio]': 'string',
  'filter[unpaidLeaveRatio]': 'string',
  'filter[unratedHis]': 'string',
  'filter[unprodHis]': 'string',
  'filter[neutralHis]': 'string',
  'filter[prodHis]': 'string',
  'filter[unratedHisRatio]': 'string',
  'filter[unprodHisRatio]': 'string',
  'filter[neutralHisRatio]': 'string',
  'filter[prodHisRatio]': 'string',
  'filter[unrated]': 'string',
  'filter[unprod]': 'string',
  'filter[neutral]': 'string',
  'filter[prod]': 'string',
  'filter[unratedRatio]': 'string',
  'filter[unprodRatio]': 'string',
  'filter[neutralRatio]': 'string',
  'filter[prodRatio]': 'string',
  'filter[idleSecMeeting]': 'string',
  'filter[clicksRatio]': 'string',
  'filter[idleSecMeetingRatio]': 'string',
  'filter[keysRatio]': 'string',
  'filter[movesRatio]': 'string',
  'filter[totalSecRatio]': 'string',
  'filter[idleMinsMeeting]': 'string',
  'filter[idleOutsideMeetingSec]': 'string',
  'filter[idleOutsideMeetingMins]': 'string',
  'filter[idleSecDuringMeetingRatio]': 'string',
  'filter[idleSecOutsideMeetingRatio]': 'string',
  'filter[idleMinsDuringMeetingRatio]': 'string',
  'filter[idleMinsOutsideMeetingRatio]': 'string',
  'filter[outShift]': 'string',
  'filter[outShiftRatio]': 'string',
  'filter[project]': 'string',
  'filter[task]': 'string',
  'filter[shift]': 'string',
  'filter[projectRatio]': 'string',
  'filter[taskRatio]': 'string',
  'filter[shiftRatio]': 'string',
  'filter[comCatRatio]': 'string',
  'filter[scoreTotal]': 'string',
  'filter[scoreTotalRatio]': 'string',
});

// Example of how to use the query object with fetch (replace with your actual API endpoint)
// fetch('YOUR_API_ENDPOINT?' + query.toString())
//   .then(response => response.json())
//   .then(data => console.log(data))
//   .catch(error => console.error('Error:', error));
```
Tokens:
Raw